Iniciar conversa no WhatsApp oficial enviando um modelo

Envia um modelo aprovado para um número que nunca escreveu para a empresa e abre a conversa no CRM. Consome saldo. Envie o cabeçalho Idempotency-Key para que um reenvio da requisição não cobre nem envie duas vezes. Recusas antes de qualquer cobrança: 403 lead_blocked (contato bloqueado); 409 lead_opted_out (o contato pediu para não receber mensagens); 409 within_spam_window (o contato recebeu mensagem deste número dentro da proteção contra spam do workspace, ou outro envio para ele a partir deste número está em andamento); 409 window_already_open (com details.entryId e details.entryType da conversa aberta). A conversa fica com quem a iniciou antes do envio, para que o agente ou fluxo do número não responda ao contato: se isso não for possível, nada é enviado nem cobrado e a resposta é 503 starter_not_assigned (tente de novo). Depois do envio: 409 send_outcome_unknown quando a resposta do WhatsApp se perdeu e o modelo pode ter sido entregue e cobrado (confira a conversa antes de enviar de novo; não repita automaticamente). Envie handOff ({kind: agent ou workflow, id, values}) para que a conversa já comece com um agente de IA ou um fluxo: exige a permissão conversations:delegate, o agente precisa estar ativo e o fluxo publicado e ativo, e values traz as variáveis que a automação exige (veja GET /automation-needs). A passagem é conferida antes de qualquer envio ou cobrança: 403 hand_off_forbidden, 400 automation_invalid, 422 automation_unusable, 409 automation_variables_missing (details.variables com as que faltam), 422 conversation_variable_type_invalid e 400 conversation_variable_not_needed. A conversa começa com quem a iniciou e passa ao escolhido logo depois; handOff na resposta diz se passou (delegated, owner ai: ou workflow:) ou, se algo mudou nesse meio tempo, por que ficou com quem iniciou (code).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Destinatário e modelo

string
handOff
object
headerParameters
array of strings
headerParameters
string
parameters
array of strings
parameters
string
boolean
string
Headers
string
required

Chave que torna o envio idempotente

string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json