Como enviar mensagens

Este documento descreve como usar a API para enviar mensagens aos usuários do WhatsApp.

Tipos de mensagens

Você pode usar a API para enviar os tipos de mensagens a seguir.

As mensagens de áudio mostram um ícone e um link para um arquivo de áudio. Quando o usuário do WhatsApp toca no ícone, o cliente do WhatsApp carrega e reproduz o arquivo.

As mensagens de contato permitem que você envie informações avançadas de contato diretamente aos usuários do WhatsApp, como nomes, números de telefone, endereços físicos e endereços de email.

As mensagens de documento exibem um ícone de documento para o usuário do WhatsApp clicar e baixar.

As mensagens de imagem exibem uma única imagem e uma legenda opcional.

As mensagens interativas de botão de URL de CTA permitem que você associe qualquer URL a um botão para não precisar incluir URLs brutas longas e obscuras no corpo da mensagem.

As mensagens de lista interativas permitem apresentar uma lista de opções para escolha dos usuários do WhatsApp.

As mensagens de solicitação de localização interativas exibem um corpo de texto e o botão de enviar localização. Quando o usuário do WhatsApp toca no botão, uma tela para compartilhar a localização é exibida, permitindo que ele faça o compartilhamento.

As mensagens de botões de resposta interativas permitem que você envie até três respostas predefinidas para o usuário escolher.

As mensagens de localização permitem que você envie as coordenadas de latitude e longitude de uma localização para um usuário do WhatsApp.

As mensagens de figurinhas exibem imagens animadas ou estáticas de figurinhas em uma mensagem do WhatsApp.

As mensagens de texto contêm apenas um corpo de texto e uma prévia de link opcional.

As Modelos de mensagens permitem que você envie modelos de marketing, utilidade e autenticação para usuários do WhatsApp. Ao contrário de todos os demais tipos de mensagens, as mensagens de modelo não exigem que haja uma janela de atendimento ao cliente 24 horas aberta entre você e o destinatário da mensagem antes de serem enviadas.

As mensagens de vídeo exibem uma prévia em miniatura de uma imagem de vídeo com uma legenda opcional. Quando o usuário do WhatsApp toca na prévia, o vídeo é carregado e exibido.

As mensagens de reação são reações com emoji que você pode aplicar a uma mensagem anterior recebida de um usuário do WhatsApp.

Janelas de atendimento ao cliente

Quando você recebe uma mensagem de um usuário do WhatsApp, uma janela de atendimento de 24 horas é aberta (ou atualizada, caso já tenha sido iniciada antes).

Quando uma janela de atendimento ao cliente estiver aberta, você pode enviar qualquer tipo de mensagem ao usuário. Caso contrário, será possível enviar somente mensagens de modelo ao usuário, pois esse é o único tipo de mensagem que pode ser enviado fora da janela de atendimento ao cliente.

Só é possível enviar mensagens a usuários que aceitaram receber suas mensagens.

Solicitações

Todas as solicitações de envio de mensagem usam o ponto de extremidade:

POST /messages

O corpo da solicitação varia conforme o tipo de mensagem, mas a carga usa a seguinte sintaxe comum:

{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "<WHATSAPP_USER_PHONE_NUMBER>",
  "type": "<MESSAGE_TYPE>",
  "<MESSAGE_TYPE>": {<MESSAGE_CONTENTS>}
}

O valor da propriedade type na carga do corpo indica o tipo de mensagem. É necessário incluir uma propriedade correspondente a esse tipo que descreva o conteúdo da mensagem.

Abaixo, há uma solicitação para enviar uma mensagem de texto a um usuário do WhatsApp. O type é definido como text, e o objeto text descreve o conteúdo da mensagem:

Se fosse entregue ao usuário, a mensagem teria esta aparência no cliente do WhatsApp:

Respostas

A API retornará a seguinte resposta JSON ao aceitar a solicitação de envio de mensagem se não houver erros. Essa resposta indica somente que a API aceitou a solicitação, ou seja, não indica a entrega da mensagem. O status de entrega de mensagem é comunicado pelos webhooks de mensagem.

Sintaxe da resposta

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "<WHATSAPP_USER_PHONE_NUMBER>",
      "wa_id": "<WHATSAPP_USER_ID>"
    }
  ],
  "messages": [
    {
      "id": "<WHATSAPP_MESSAGE_ID>",
      "message_status": "<PACING_STATUS>"
    }
  ]
}

Conteúdo da resposta

Marcador	Descrição	Exemplo
<WHATSAPP_USER_PHONE_NUMBER> String	Número de telefone do WhatsApp do usuário do WhatsApp. Pode não corresponder ao valor wa_id.	+16505551234
<WHATSAPP_USER_ID> String	ID do WhatsApp do usuário do WhatsApp. Pode não corresponder ao valor inserido.	16505551234
<WHATSAPP_MESSAGE_ID> String	ID da mensagem do WhatsApp. Esse ID aparece em webhooks de mensagens associadas, como webhooks enviados, lidos e entregues.	wamid.HBgLMT Y0NjcwNDM1O TUVAgARGBI4M jZGRDA0OUE2O TQ3RkEyMzcA
<PACING_STATUS> String	Indica o status do ritmo do modelo. A propriedade message_status é incluída somente em respostas ao enviar uma mensagem de modelo que usa um modelo que está sendo ritmo.	wamid.HBgLMT Y0NjcwNDM1O TUVAgARGBI4M jZGRDA0OUE2O TQ3RkEyMzcA

Como enviar mensagens

Tipos de mensagens#

Janelas de atendimento ao cliente#

Solicitações#

Respostas#