API de Mensagens
Envie mensagens através da WhatsApp Cloud API. Todas as mensagens são processadas de forma assíncrona com retentativas automáticas para entrega confiável.Autenticação
Mensagens podem ser enviadas usando:- API key da conta — a conta é identificada pela chave
- Master API key — deve incluir
accountIdno corpo da requisição
Resposta
Todos os endpoints de envio retornam a mesma resposta:Enviar Texto
Número do destinatário (com código do país, sem
+)Texto da mensagem (máx. 4096 caracteres)
Habilitar pré-visualização de links na mensagem
UUID da conta (obrigatório ao usar master key)
Enviar Template
Número do destinatário
Nome do template aprovado
Código do idioma do template (ex:
pt_BR, en_US)Componentes do template com parâmetros dinâmicos
UUID da conta (obrigatório ao usar master key)
Componentes do Template
Campos do Componente
| Campo | Tipo | Descrição |
|---|---|---|
type | string | header, body ou button |
sub_type | string | Sub-tipo do botão (opcional) |
index | number | Índice do botão (opcional) |
parameters | array | Valores dos parâmetros |
Tipos de Parâmetro
| Tipo | Descrição |
|---|---|
text | Substituição de texto |
currency | Valor monetário |
date_time | Data/hora |
image | Mídia de imagem |
document | Mídia de documento |
video | Mídia de vídeo |
Enviar Imagem
Número do destinatário
ID de mídia do WhatsApp (do upload). Forneça
mediaId ou mediaUrlURL pública do arquivo de imagem
Legenda da imagem (máx. 1024 caracteres)
Enviar Documento
Número do destinatário
ID de mídia do WhatsApp
URL pública do documento
Legenda do documento (máx. 1024 caracteres)
Nome do arquivo para exibição
Enviar Áudio
Número do destinatário
ID de mídia do WhatsApp
URL pública do arquivo de áudio
Enviar Vídeo
Número do destinatário
ID de mídia do WhatsApp
URL pública do arquivo de vídeo
Legenda do vídeo (máx. 1024 caracteres)
Enviar Localização
Número do destinatário
Latitude (-90 a 90)
Longitude (-180 a 180)
Nome do local
Endereço
Enviar Contatos
Número do destinatário
Array de objetos de contato (mínimo 1)
Objeto de Contato
Enviar Botões Interativos
Número do destinatário
Corpo da mensagem (máx. 1024 caracteres)
1 a 3 botões de resposta
Cabeçalho opcional (
{ "type": "text", "text": "..." })Texto do rodapé (máx. 60 caracteres)
Objeto de Botão
| Campo | Tipo | Descrição |
|---|---|---|
type | string | Deve ser "reply" |
reply.id | string | Identificador único do botão |
reply.title | string | Rótulo do botão (máx. 20 caracteres) |
Enviar Lista Interativa
Número do destinatário
Corpo da mensagem
Rótulo do botão da lista (máx. 20 caracteres)
1 a 10 seções
Texto do cabeçalho
Texto do rodapé
Objeto de Seção
| Campo | Tipo | Descrição |
|---|---|---|
title | string | Título da seção (máx. 24 caracteres) |
rows | array | 1 a 10 itens |
Objeto de Item
| Campo | Tipo | Descrição |
|---|---|---|
id | string | Identificador único do item |
title | string | Título do item (máx. 24 caracteres) |
description | string | Descrição do item (máx. 72 caracteres, opcional) |
Enviar Reação
Número do destinatário
ID da mensagem WhatsApp para reagir
Caractere emoji
Marcar como Lida
ID da mensagem WhatsApp para marcar como lida