Criar template de mensagem no WhatsApp, por uma API

Cria 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.

Identificador
whatsapp_create_message_template

A chamada

POST https://connect.reportei.com/api/tools/whatsapp_create_message_template/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "waba_id": "<waba_id>",
    "name": "<name>",
    "language": "<language>",
    "category": "MARKETING",
    "components": []
  }
}

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.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
waba_idstringSimId of the WhatsApp Business account, from List business accounts.
namestringSimName of the template: lowercase letters, numbers and underscores only, unique per language in the account.
languagestringSimLanguage code of the template, for example pt_BR or en_US.
categorystringSimMARKETING for promotions, UTILITY for updates about an order or account, AUTHENTICATION for one-time codes. Meta can change the category in review.Valores: MARKETING, UTILITY, AUTHENTICATION
parameter_formatstringNãoHow the variables are written. The default is POSITIONAL.Valores: POSITIONAL, NAMED
componentsarraySimParts of the template. BODY is required; HEADER, FOOTER and BUTTONS are optional.

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}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/whatsapp_create_message_template. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do WhatsApp

Ver as 10 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.