Como enviar mensagens de texto

Use o messages para enviar mensagens de texto aos clientes.

Antes de começar

É preciso atender a todos os pré-requisitos listados na seção Antes de começar da documentação sobre mensagens.

Limitações:

  • As mensagens de texto podem ter no máximo 4.096 caracteres.

Etapa 1: fazer uma solicitação POST para /messages

Para enviar uma mensagem de texto, obtenha e use o ID do WhatsApp do usuário em questão. Especifique text no campo type.

POST /v1/messages
{
    "preview_url": false | true,
    "recipient_type": "individual",
    "to": "whatsapp-id",
    "type": "text",
    "text": {
        "body": "your-text-message-content"
    }
}

Para obter mais informações sobre parâmetros, consulte os seguintes documentos:

Se quiser formatar a mensagem, consulte Como formatar em mensagens de texto.

Como enviar URLs em mensagens de texto

Por padrão, o aplicativo para celular WhatsApp reconhece URLs e os torna clicáveis. Para incluir uma prévia de URL, coloque "preview_url": true no corpo da mensagem e verifique se a URL começa com http:// ou https://. O nome do host também é obrigatório, pois os endereços IP não passam por correspondência.

O uso de preview_url aqui é diferente do uso na API de Nuvem. Consulte o guia Messages na documentação da API de Nuvem.

Exemplo

{
    "preview_url": true,
    "to": "whatsapp-id",
    "text": {
        "body": "You have to check out this amazing messaging service https://www.whatsapp.com/"
     }

Na maioria das vezes, quando você envia uma URL, seja com uma prévia ou não, o destinatário da mensagem vê uma URL na qual ele pode clicar.

As prévias de URL somente podem ser renderizadas depois de uma das seguintes situações:

  1. A empresa enviou um modelo de mensagem ao usuário.
  2. O usuário iniciou uma conversa por meio do link "clique para conversar".
  3. O usuário adicionou o número de telefone da empresa à agenda de contatos e iniciou uma conversa.

Etapa 2: verifique a sua resposta

Uma resposta bem-sucedida inclui um objeto messages com o ID da mensagem recém-criada.

{
  "messages": [{
    "id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
  }]
}  

Respostas com falha conterão uma mensagem de erro. Consulte Mensagens de erro e status para mais informações.