Visão Geral
Os endpoints de envio em massa permitem disparar mensagens para grandes listas de contatos em uma única chamada de API. Você pode enviar o mesmo texto para todos os destinatários, personalizar mensagens usando variáveis por linha a partir de uma entrada CSV, ou disparar envios individuais que são rastreados como parte de uma campanha de disparo. URL BaseEndpoints
BulkSendMessage — Enviar para um Array de Números
Envie a mesma mensagem de texto para todos os números da lista fornecida.Request
integer
obrigatório
O ID do canal (conexão do WhatsApp) do qual enviar.
array
obrigatório
Array de números de telefone para enviar. Inclua código do país e DDD — por exemplo,
"5511999990001".string
obrigatório
O conteúdo de texto a ser enviado para todos os destinatários da lista.
integer
obrigatório
Atraso mínimo em segundos entre cada envio. Mínimo recomendado:
5.integer
obrigatório
Atraso máximo em segundos entre cada envio. Um valor aleatório entre
min e max é escolhido para cada destinatário. Mínimo recomendado: 15.BulkSendMessageWithVariable — Mensagens Personalizadas via CSV
Envie uma mensagem personalizada para cada destinatário substituindo variáveis a partir de uma string formatada em CSV.Request
integer
obrigatório
O ID do canal do qual enviar.
string
obrigatório
Modelo de mensagem usando
{{var1}}, {{var2}}, etc. como marcadores. Cada marcador é substituído pelo valor da coluna correspondente em dataInput para aquele destinatário.string
obrigatório
String formatada em CSV onde cada linha representa um destinatário. Formato por linha:
number,var1,var2,.... Use \n para separar as linhas. Envolva valores de campo que contenham vírgulas em aspas duplas.integer
obrigatório
Atraso mínimo em segundos entre os envios.
integer
obrigatório
Atraso máximo em segundos entre os envios.
dataInput mapeia para {{var1}} e {{var2}}:
BulkFastMessage — Envio em Massa com Atraso Fixo
Uma variante de envio em massa de maior throughput que usa um atraso fixo em vez de um intervalo aleatório. Adequada para cenários em que um ritmo constante é preferível a um espaçamento aleatorizado.Request
integer
obrigatório
O ID do canal do qual enviar.
string
obrigatório
O tipo da conexão do WhatsApp — por exemplo,
"baileys".array
obrigatório
Array de números de telefone para enviar.
string
obrigatório
O conteúdo de texto a ser enviado para todos os destinatários.
integer
obrigatório
Defina com o mesmo valor de
max para usar um atraso fixo. Valor mínimo recomendado: 5.integer
obrigatório
Defina com o mesmo valor de
min para um atraso fixo.BulkIndividual — Envio Único com Rastreamento de Disparo
Envie uma mensagem para um contato com umexternalKey para rastreamento via webhook. Útil quando você precisa disparar envios a partir de automações externas e correlacionar eventos de entrega de volta ao seu sistema.
Request
integer
obrigatório
O ID do canal do qual enviar.
string
obrigatório
Número de telefone do destinatário, com código do país e DDD.
string
obrigatório
O conteúdo de texto da mensagem.
string
obrigatório
Chave única gerada pelo seu sistema. Usada para correlacionar o envio com seu callback de webhook e evitar entrega duplicada em caso de nova tentativa.
Verificação de Ticket Ativo
Quando a configuração do tenant “Verificar conversa em outros canais” está ativada, qualquer contato que já tenha um ticket aberto ou pendente em qualquer canal é automaticamente ignorado durante o disparo em massa. A resposta inclui um resumo dos contatos ignorados:Para ignorar a verificação de ticket ativo em uma chamada específica de envio em massa, inclua
"skipActiveTicketCheck": true no corpo da sua requisição. Isso envia para todos os contatos da lista, independentemente de terem ou não uma conversa em aberto.Gerenciando Disparos em Massa
Listar Todos os Disparos
Obtenha uma lista paginada de todos os jobs de disparo em massa da sua API.Obter Detalhes do Disparo
Obtenha o status completo e as estatísticas de um disparo específico.Cancelar um Disparo
Interrompa um disparo em execução ou na fila antes que ele seja concluído.Request
string
obrigatório
Defina como
"cancelled" para interromper o disparo.string
Motivo opcional e legível para o cancelamento. Armazenado no registro do disparo para fins de auditoria.