Skip to main content
POST

Authorizations

Authorization
string
header
required

Token JWT da sua conta. Use o formato: Bearer {seu-jwt-token}

Body

application/json

Dados para enviar um template de mensagem aprovado na Meta

channelId
string
required

ID do canal para envio.

Example:

"clh1234567890"

phone
string
required

Número do destinatário (formato internacional).

Example:

"+5511999999999"

templateName
string
required

Nome do template aprovado na Meta.

Example:

"confirmacao_pedido"

language
string
default:pt_BR
required

Código do idioma do template (ex: pt_BR, en_US, es_AR). Normalmente use pt_BR.

Example:

"pt_BR"

params
object

Parâmetros de variáveis do template. Chave = nome da variável (ex: contact_first_name), valor = texto. Para templates posicionais use "1", "2", etc. Para botões de URL dinâmico use "button_url_0", "button_url_1", etc.

Example:
header
object

Mídia do header do template. Informe apenas um dos campos: imageUrl, videoUrl ou documentUrl.

Response

Template enviado com sucesso

success
boolean
required

Indica se o envio foi bem-sucedido.

Example:

true

chatId
string
required

ID interno do chat.

Example:

"clh0987654321"

externalChatId
string
required

ID externo do chat (número do WhatsApp).

Example:

"5511999999999@s.whatsapp.net"

message
string
required

Mensagem de confirmação.

Example:

"Template enviado com sucesso"

wamid
string

WhatsApp Message ID retornado pela Meta.

Example:

"wamid.HBgNNTUxMTk5OTk5OTk5FQIAERgSQjYxNzc2..."