Enviar mensagem no WhatsApp, por uma API
Envia uma mensagem de um número de telefone comercial e retorna seu id em messages[0].id. Os tipos livres (text, image, video, document, audio) só chegam a quem escreveu para o número nas últimas 24 horas; para iniciar uma conversa, envie o tipo template com um template aprovado de Listar templates de mensagem. A Meta cobra as mensagens da conta conforme seus preços do WhatsApp.
- Identificador
- whatsapp_send_message
A chamada
POST https://connect.reportei.com/api/tools/whatsapp_send_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"phone_number_id": "<phone_number_id>",
"messaging_product": "whatsapp",
"recipient_type": "individual",
"to": "<recipient_number_with_country_code>",
"type": "text",
"text": {
"body": "Hello! This is an example message.",
"preview_url": false
}
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Exemplo ilustrativo. Substitua os tokens, o UUID da conexão e os dados de destino pelos seus. Esta página não executa a chamada.
Antes de executar
- Para type=text, envie text.body. O número de destino deve conter código do país e apenas dígitos. Use o phone_number_id da conta comercial conectada.
- Texto livre atende conversas dentro da janela de 24 horas após a mensagem do usuário. Para iniciar uma conversa fora dela, use type=template e um template aprovado, com language e os parâmetros exigidos pelo template.
- O ID retornado identifica a mensagem aceita pela API; não confirma entrega. Confira o corpo de eventuais erros do provedor em api_error.body.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| phone_number_id | string | Sim | Id of the business phone number that sends, from List phone numbers. |
| messaging_product | string | Sim | Always whatsapp.Valores: whatsapp |
| recipient_type | string | Sim | individual for a person, group for a WhatsApp group of the number.Valores: individual, group |
| to | string | Sim | Phone number of the person with country code, digits only, for example 5511987654321, or the id of the group. |
| type | string | Sim | Kind of message. Send the object with the same name, such as text or template.Valores: text, template, image, video, document, audio |
| text | object | Sim, se type=text | For type text. |
| template | object | Sim, se type=template | For type template. |
| image | object | Sim, se type=image | For type image: a JPEG or PNG at a public URL. |
| video | object | Sim, se type=video | For type video: an MP4 or 3GP at a public URL. |
| document | object | Sim, se type=document | For type document: a file at a public URL, such as a PDF. |
| audio | object | Sim, se type=audio | For type audio: an audio file at a public URL. |
Conexões possíveis
O seu cliente conecta a conta do WhatsApp uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Formato ilustrativo de sucesso
{
"messaging_product": "whatsapp",
"messages": [
{
"id": "wamid.EXAMPLE"
}
]
}O conteúdo abaixo é um exemplo, não o resultado de uma execução. Guarde o X-Toolkit-Execution-Id quando retornado para consultar a execução. O Connect não aplica retry nem idempotência: repetir um POST pode repetir o envio.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/whatsapp_send_message. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do WhatsApp
- Listar contas comerciaisGETLista as contas comerciais do WhatsApp que o usuário do sistema alcança, com id e nome. Esse id é o waba_id das outras ferramentas, que a Meta agora também chama de Messaging account id. A resposta traz data e paging.cursors.after: passe-o como after para ler a próxima página.
- Obter conta comercialGETRetorna uma conta comercial do WhatsApp com os campos pedidos, que podem ser dados da conta ou análises. Sem fields, só id e name voltam.
- Listar números de telefoneGETLista os números de telefone comerciais de uma conta comercial do WhatsApp com id, display_phone_number, verified_name e quality_rating. Esse id é o phone_number_id das ferramentas de mensagem e perfil. A resposta traz data e paging.cursors.after: passe-o como after para ler a próxima página.
- Listar templates de mensagemGETLista os templates de mensagem de uma conta comercial do WhatsApp com id, name, language, status, category e components. A resposta traz data e paging.cursors.after: passe-o como after para ler a próxima página.
- Criar template de mensagemPOSTCria um template de mensagem e o envia para revisão da Meta, retornando id, status e category. Ele pode ser enviado quando o status for APPROVED, o que pode levar até 24 horas. As variáveis são {{1}}, {{2}} no formato POSITIONAL ou {{first_name}} no formato NAMED, e cada uma precisa de um exemplo. Um cabeçalho de imagem, vídeo ou documento precisa de um file handle de um upload, que esta conexão não faz.
- Atualizar template de mensagemPOSTEdita um template e o envia para revisão de novo. Só templates nos status APPROVED, REJECTED ou PAUSED podem ser editados, e apenas sua categoria e components; components substitui todas as partes. Um template aprovado aceita até 10 edições em 30 dias e 1 em 24 horas, e sua categoria não pode mudar.
- Excluir template de mensagemDELETEExclui um template pelo nome, em todos os idiomas, ou apenas a versão de idioma cujo id é hsm_id. O nome de um template aprovado excluído não pode ser reutilizado por 30 dias.
- Obter perfil comercialGETRetorna o perfil comercial que as pessoas veem em um número de telefone: about, address, description, email, websites, vertical e profile_picture_url.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
