Skip to main content
POST

Descrição

Este endpoint permite enviar um template do WhatsApp para múltiplos destinatários em uma única requisição. Implementa um padrão assíncrono: ao criar o envio, retorna um bulk_send_id que você pode usar para verificar o progresso do envio. A API gerencia automaticamente os limites de taxa da Meta com base no nível do número, distribui os envios e rastreia o status de cada mensagem individual.

Header de autenticação

string
obrigatório
Sua API Key da Mindo. Formato: mindo_xxxxxxxxxxxxxxxxxxxxxxxx

Parâmetros do body

string
obrigatório
ID do número de telefone do WhatsApp na Meta a partir do qual as mensagens serão enviadas. Você pode obtê-lo no endpoint Obter contas de negócio.
string
obrigatório
Nome do template aprovado a ser enviado. Deve ter status APPROVED na Meta.
string
Idioma do template. Padrão: "es". Exemplos: "es", "en", "pt_BR".
array
obrigatório
Lista de destinatários com suas variáveis personalizadas.

Resposta (202 Accepted)

string (UUID)
ID único do envio em massa. Use para verificar o progresso com Status do envio.
string
ID da tarefa de processamento em segundo plano.
string
Status inicial do envio. Sempre "queued" quando criado.
string
Nome do template a ser enviado.
integer
Total de destinatários na lista enviada.
integer
Número de destinatários únicos após deduplicação automática.
float
Tempo estimado de processamento em minutos, baseado no nível do número.
string (ISO 8601)
Data e hora de criação do envio.
object
Informações sobre o número do WhatsApp que enviará as mensagens.
object
Informações de cota e limites de envio.

Status do envio

O campo status do envio em massa pode ter os seguintes valores:
Use o endpoint Status do envio com o bulk_send_id para verificar o progresso em tempo real, incluindo contadores de mensagens enviadas, entregues, lidas e com falha.

Deduplicação automática

A API remove automaticamente números de telefone duplicados da lista de recipients. O campo unique_recipients na resposta indica o número real de destinatários únicos que receberão a mensagem, enquanto total_recipients reflete a contagem original enviada.

Casos de uso

Envie uma mensagem de boas-vindas personalizada para uma lista de clientes recém-cadastrados.
Envie códigos de verificação únicos para cada destinatário.
Notifique múltiplos clientes sobre atualizações dos seus pedidos.
Envie lembretes personalizados com data e hora do evento.