v1

latestOpenAPI 3.1.02026-07-2292631.9 KB

Notificacoes

Enviar Notificacao

Envia mensagens template do WhatsApp Business via Meta Cloud API para contatos especificos.

O endpoint suporta dois formatos de payload: o formato moderno (baseado na estrutura de componentes da Meta API) e o formato legado (com substituicoes simples de texto).

post/send-notification

Request body

namestring required

Nome do contato

phoneNumberstring required

Numero de telefone do contato

emailstring email

Email do contato (opcional)

instanceIdinteger required

ID da instancia do bot WhatsApp

sourcestring required

Origem da notificacao

ignoreTransferToTalkIfUnansweredboolean

Se true, nao transfere para o Talk caso o lead nao responda

specialInstructionsstring

Instrucoes especiais para a MIA ao responder o lead

messageTemplatestring

Nome do template de mensagem (formato legado)

replacementsstring[]

Substituicoes para os placeholders do template (formato legado)

Example request

{
  "template": {
    "language": {
      "code": "pt_BR"
    }
  }
}

Response

Notificacao enviada com sucesso

successboolean

Indica se a notificacao foi enviada com sucesso

conversationIdstring uuid

ID da conversa criada ou localizada