Comunicação
WhatsApp no seu produto e nos seus agentes de IA, por uma API
O toolkit da WhatsApp Cloud API cobre contas comerciais, números de telefone, envio de mensagens, templates de mensagem e o perfil comercial de um número. Pelo Connect, seu produto ou agente de IA chama tudo por um só endpoint, enquanto o Connect guarda as credenciais e registra cada execução.
15 dias para testar. Sem cartão de crédito.
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
}
}
}Como funciona
Do cliente conectado à primeira chamada no WhatsApp.
- 1
O cliente conecta a conta
Seu sistema abre uma sessão do Connect para o toolkit e o cliente conecta a conta do WhatsApp. Você recebe o id da conexão.
- 2
Seu produto chama a tool
Um POST em /api/tools/{tool}/execute com o id da conexão e os argumentos. Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app.
- 3
O Connect cuida do resto
Guarda a credencial criptografada, renova tokens quando a conexão usa OAuth com suporte a renovação e registra as execuções numa trilha de auditoria consultável pela API.
Para que usar
O que o seu produto faz com o WhatsApp.
Envie notificações por template
Um SaaS inicia uma conversa enviando uma mensagem do tipo template com um template aprovado, por exemplo para confirmar um pedido.
Gerencie templates pelo seu app
Um produto cria um template de mensagem, o envia para revisão da Meta e depois o edita ou exclui conforme o conteúdo muda.
Responda clientes com um agente
Um agente de IA responde com uma mensagem de texto livre a quem escreveu para o número nas últimas 24 horas.
Tools
10 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.
- Enviar mensagemPOSTEnvia 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.
- 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.
- Atualizar perfil comercialPOSTAtualiza o perfil comercial de um número de telefone. Os campos omitidos mantêm seu valor, e websites substitui os sites do perfil.
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.
Perguntas sobre o toolkit do WhatsApp
Preciso implementar a API do WhatsApp?
Não. O Connect já traz 10 tools do WhatsApp descritas e prontas. Seu cliente conecta a conta e o seu sistema chama cada tool pelo mesmo endpoint, com o mesmo formato de requisição.
Como o cliente conecta a conta do WhatsApp?
Pelo modo que o toolkit aceita: Chave de API. O Connect guarda a credencial criptografada e nunca a devolve ao seu sistema.
Funciona com agentes de IA?
Sim. O input de cada tool é descrito em JSON Schema, que o seu agente usa direto como definição de tool. O agente escolhe a tool e os argumentos, e o seu sistema faz a chamada ao Connect.
Meu cliente precisa ter conta no Reportei?
Não. O cliente conecta a conta numa tela do Connect, ou o seu sistema envia a credencial pela API, e ele continua usando só o seu produto.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
