WhatsApp API Docs | Wonotify Whatsapp Api #1 Whatsapp Business Api & Woo commerce & Whmc & Shopify Platform

Começando

A API Web do WhatsApp oferece uma maneira simples e poderosa de integrar o WhatsApp aos seus aplicativos.

Para começar, você precisará de duas credenciais::

Token de acesso: Uma chave segura usada para autenticar solicitações de API.
ID da instância do WhatsApp: Um identificador exclusivo vinculado à sessão da sua conta do WhatsApp.

Ainda não tem credenciais? Inscreva-se aqui para obter seu token de acesso e ID de instância.

Caminhos básicos:

https://wonotify.com/api/...

https://wonotify.com/whatsapp_api/...

Ambos os caminhos base são suportados e retornam a mesma resposta.

Instâncias

Criar Instância

POST

Crie um novo ID de instância para conectar o WhatsApp Web.

Ponto de extremidade da API:

https://wonotify.com/api/create_instance?access_token=6881c11f741a1

Parâmetros:

Parameter	Type	Required	Description
`access_token`	string	Yes	Your API access token

Exemplo:

curl -X POST 'https://wonotify.com/api/create_instance?access_token=6881c11f741a1'

Reinicializar instância

POST

Saia do WhatsApp web e faça uma nova verificação.

Ponto de extremidade da API:

https://wonotify.com/api/reboot?instance_id=609ACF283XXXX&access_token=6881c11f741a1

Parâmetros:

Parameter	Type	Required	Description
`instance_id`	string	Yes	WhatsApp instance ID
`access_token`	string	Yes	Your API access token

Redefinir instância

POST

Isso desconectará o WhatsApp web, alterará o ID da instância e excluirá todos os dados antigos da instância.

Ponto de extremidade da API:

https://wonotify.com/api/reset_instance?instance_id=609ACF283XXXX&access_token=6881c11f741a1

Reconectar

POST

Reinicie a conexão do aplicativo com o WhatsApp web quando a conexão for perdida.

Ponto de extremidade da API:

https://wonotify.com/api/reconnect?instance_id=609ACF283XXXX&access_token=6881c11f741a1

Instância de logout

POST

Saia de uma instância do WhatsApp Web.

Ponto de extremidade da API:

https://wonotify.com/api/logout?instance_id=609ACF283XXXX&access_token=EMCUH3NQQK8YXXXX

Login do WhatsApp

Obter código QR

POST

Exiba o código QR para fazer login no WhatsApp web. Você pode obter os resultados retornados via Webhook.

Ponto de extremidade da API:

https://wonotify.com/api/get_qrcode?instance_id=609ACF283XXXX&access_token=6881c11f741a1

Parâmetros:

Parameter	Type	Required	Description
`instance_id`	string	Yes	WhatsApp instance ID
`access_token`	string	Yes	Your API access token

Mensagens

Enviar mensagem de texto

POST

Envie uma mensagem de texto para um número de telefone por meio do aplicativo.

Método 1: solicitação GET:

https://wonotify.com/api/send?number=84933313xxx&type=text&message=test+message&instance_id=609ACF283XXXX&access_token=6881c11f741a1

Método 2: solicitação POST:

https://wonotify.com/api/send

Estrutura corporal POST:

Content-Type: application/json
{
  "number": "84933313xxx",
  "type": "text",
  "message": "test message",
  "instance_id": "609ACF283XXXX",
  "access_token": "6881c11f741a1"
}

Parâmetros:

Parameter	Type	Required	Description
`number`	string	Yes	Phone number (without +)
`type`	string	Yes	Message type: "text"
`message`	string	Yes	Text message content
`instance_id`	string	Yes	WhatsApp instance ID
`access_token`	string	Yes	Your API access token

Enviar mídia e arquivos

POST

Envie uma mídia ou arquivo com mensagem para um número de telefone através do aplicativo.

Método 1: solicitação GET:

https://wonotify.com/api/send?number=84933313xxx&type=media&message=test+message&media_url=https%3A%2F%2Fi.pravatar.cc&filename=file_test.jpg&instance_id=609ACF283XXXX&access_token=6881c11f741a1

Método 2: solicitação POST:

https://wonotify.com/api/send

Estrutura corporal POST:

Content-Type: application/json
{
  "number": "84933313xxx",
  "type": "media",
  "message": "test message",
  "media_url": "https://i.pravatar.cc",
  "instance_id": "609ACF283XXXX",
  "access_token": "6881c11f741a1"
}

Parâmetros:

Parameter	Type	Required	Description
`number`	string	Yes	Phone number (without +)
`type`	string	Yes	Message type: "media"
`message`	string	Yes	Caption for the media
`media_url`	string	Yes	URL of the media file
`filename`	string	No	Filename (for documents: file_test.pdf)
`instance_id`	string	Yes	WhatsApp instance ID
`access_token`	string	Yes	Your API access token

Enviar botão/lista de modelo

POST

Envie uma mensagem modelo para um número de telefone por meio do aplicativo.

Ponto de extremidade da API:

https://wonotify.com/api/send_template?instance_id=609ACF283XXXX&access_token=6881c11f741a1

Estrutura de mensagem interativa (recomendado):

Content-Type: application/json
{
  "number": "84933313xxx",
  "type": "interactive",
  "message": {
    "text": "This is an Interactive message!",
    "title": "Test Title",
    "subtitle": "subtitle",
    "footer": "test footer",
    "interactiveButtons": [
      {
        "name": "quick_reply",
        "buttonParamsJson": "{\"display_text\":\"Test\",\"id\":\"685250bce39ca\"}"
      },
      {
        "name": "cta_url",
        "buttonParamsJson": "{\"display_text\":\"Click me!\",\"url\":\"https://baceoin.com\"}"
      },
      {
        "name": "cta_call",
        "buttonParamsJson": "{\"display_text\":\"Call Us\",\"phone_number\":\"+1234567890\"}"
      },
      {
        "name": "cta_copy",
        "buttonParamsJson": "{\"display_text\":\"Copy Code\",\"copy_code\":\"PROMO2024\"}"
      }
    ]
  }
}

Formato de modelo legado (obsoleto):

Content-Type: application/json
{
  "number": "84933313xxx",
  "type": "template",
  "message": {
    "text": "This is a template message!",
    "footer": "test footer",
    "templateButtons": [
      {
        "index": 1,
        "quickReplyButton": {
          "displayText": "Test",
          "id": "685250bce39ca"
        }
      }
    ]
  }
}

Listar estrutura de mensagens:

Content-Type: application/json
{
  "number": "84933313xxx",
  "type": "list",
  "message": {
    "text": "hello",
    "footer": "test footer",
    "title": "test title",
    "buttonText": "bay",
    "sections": [
      {
        "title": "hello",
        "rows": [
          {
            "title": "hello",
            "rowId": "685410595972e",
            "description": "hello"
          }
        ]
      }
    ]
  }
}

Grupos

Enviar texto de grupo

POST

Envie uma mensagem de texto para um grupo do WhatsApp.

Método 1: solicitação GET:

https://wonotify.com/api/send_group?group_id=120363023285171234@g.us&type=text&message=group+message&instance_id=609ACF283XXXX&access_token=6881c11f741a1

Método 2: solicitação POST:

https://wonotify.com/api/send_group

Estrutura corporal POST:

Content-Type: application/json
{
  "group_id": "120363023285171234@g.us",
  "type": "text",
  "message": "group message",
  "instance_id": "609ACF283XXXX",
  "access_token": "6881c11f741a1"
}

Parâmetros:

Parameter	Type	Required	Description
`group_id`	string	Yes	WhatsApp group ID (ends with @g.us)
`type`	string	Yes	Message type: "text"
`message`	string	Yes	Text message content
`instance_id`	string	Yes	WhatsApp instance ID
`access_token`	string	Yes	Your API access token

Enviar mídia de grupo

POST

Envie mídia ou arquivos com legenda para um grupo do WhatsApp.

Método 1: solicitação GET:

https://wonotify.com/api/send_group?group_id=120363023285171234@g.us&type=media&message=group+message&media_url=https%3A%2F%2Fi.pravatar.cc&filename=file_test.jpg&instance_id=609ACF283XXXX&access_token=6881c11f741a1

Método 2: solicitação POST:

https://wonotify.com/api/send_group

Estrutura corporal POST:

Content-Type: application/json
{
  "group_id": "120363023285171234@g.us",
  "type": "media",
  "message": "group message",
  "media_url": "https://i.pravatar.cc",
  "filename": "file_test.jpg",
  "instance_id": "609ACF283XXXX",
  "access_token": "6881c11f741a1"
}

Parâmetros:

Parameter	Type	Required	Description
`group_id`	string	Yes	WhatsApp group ID (ends with @g.us)
`type`	string	Yes	Message type: "media"
`message`	string	Yes	Caption for the media
`media_url`	string	Yes	URL of the media file
`filename`	string	No	Filename (for documents: file_test.pdf)
`instance_id`	string	Yes	WhatsApp instance ID
`access_token`	string	Yes	Your API access token

Webhooks

Definir Webhook de recebimento

POST

Obtenha todos os valores de retorno do WhatsApp. Como status da conexão, mensagem recebida, mensagem enviada, desconectado, troca de bateria,...

Ponto de extremidade da API:

https://wonotify.com/api/set_webhook?webhook_url=https%3A%2F%2Fwebhook.site%2F1b25464d6833784f96eef4xxxxxxxxxx&enable=true&instance_id=609ACF283XXXX&access_token=6881c11f741a1

Parâmetros:

Parameter	Type	Required	Description
`webhook_url`	string	Yes	Your webhook URL (URL encoded)
`enable`	boolean	Yes	Enable/disable webhook (true/false)
`instance_id`	string	Yes	WhatsApp instance ID
`access_token`	string	Yes	Your API access token

Eventos de webhook:

message: Nova mensagem recebida
message_status: Status de entrega de mensagens
presence: Status on-line/off-line do usuário

Documentação da API

Referência de API

Começando

Para começar, você precisará de duas credenciais::

Caminhos básicos:

Instâncias

Criar Instância

Ponto de extremidade da API:

Parâmetros:

Exemplo:

Reinicializar instância

Ponto de extremidade da API:

Parâmetros:

Redefinir instância

Ponto de extremidade da API:

Reconectar

Ponto de extremidade da API:

Instância de logout

Ponto de extremidade da API:

Login do WhatsApp

Obter código QR

Ponto de extremidade da API:

Parâmetros:

Mensagens

Enviar mensagem de texto

Método 1: solicitação GET:

Método 2: solicitação POST:

Estrutura corporal POST:

Parâmetros:

Enviar mídia e arquivos

Método 1: solicitação GET:

Método 2: solicitação POST:

Estrutura corporal POST:

Parâmetros:

Enviar botão/lista de modelo

Ponto de extremidade da API:

Estrutura de mensagem interativa (recomendado):

Formato de modelo legado (obsoleto):

Listar estrutura de mensagens:

Grupos

Enviar texto de grupo

Método 1: solicitação GET:

Método 2: solicitação POST:

Estrutura corporal POST:

Parâmetros:

Enviar mídia de grupo

Método 1: solicitação GET:

Método 2: solicitação POST:

Estrutura corporal POST:

Parâmetros:

Webhooks

Definir Webhook de recebimento

Ponto de extremidade da API:

Parâmetros:

Eventos de webhook: