Pular para o conteúdo principal
Os endpoints de envio em lote permitem disparar mensagens para listas de contatos pela API externa do PanÐá Zap. Você pode enviar o mesmo texto para vários números em uma única chamada, enviar mensagens já personalizadas pelo seu sistema (uma chamada por destinatário, agrupadas no mesmo relatório de disparo), fazer envios individuais registrados como disparo e acompanhar ou atualizar os disparos resultantes.

Visão Geral

Essas quatro rotas recebem o corpo em multipart/form-data (form-data) e exigem o campo whatsappType, com o tipo do canal. URL Base
Autenticação
Sempre defina um atraso entre os envios. O mínimo recomendado é min: 5 / max: 15 segundos. Enviar mensagens muito rapidamente em sequência viola as políticas do WhatsApp e aumenta significativamente o risco de seu número ser sinalizado ou banido. Nunca defina min e max como 0 ao mesmo tempo.

Endpoints

BulkSendMessage: Enviar para uma Lista de Números

Envia a mesma mensagem para todos os números da lista e cria um atendimento (ticket) para cada contato. O disparo roda em segundo plano: a resposta chega na hora, com o ID do registro do disparo.
Request
integer
obrigatório
O ID do canal (conexão do WhatsApp) do qual enviar.
string
obrigatório
Tipo do canal: whatsapp, baileys, zapo, meow, evo, evogo, zapi ou uazapi.
string
obrigatório
Números separados por vírgula, com código do país e DDD. Por exemplo: 5511999990001,5511999990002.
string
Use false para números de contatos.
string
obrigatório
O texto enviado a todos os destinatários da lista.
integer
obrigatório
Intervalo mínimo, em segundos, entre cada envio. Mínimo recomendado: 5.
integer
obrigatório
Intervalo máximo, em segundos, entre cada envio. Um valor aleatório entre min e max é usado entre os envios. Mínimo recomendado: 15.
file
Arquivo a enviar (opcional). Para enviar por URL, use media=true junto com mediaUrl.
string
URL do arquivo, usada junto com media=true.
string
true. Obrigatório quando você envia um arquivo em media.
Resposta:

BulkSendMessageWithVariable: Mensagem Personalizada pelo Seu Sistema

Envia uma mensagem já personalizada pelo seu sistema para um destinatário por chamada, registrando todas as chamadas no mesmo relatório de disparo.
Esta rota não substitui variáveis. O texto enviado em message sai exatamente como está. Monte a mensagem de cada destinatário no seu sistema (por exemplo, trocando o nome e o número do pedido) e faça uma chamada por destinatário. As variáveis {{var1}}, {{var2}} existem apenas na tela Comunicados, aba Texto Variável, do painel, que troca os valores no navegador antes de enviar.
Request
integer
obrigatório
O ID do canal do qual enviar.
string
obrigatório
Tipo do canal: whatsapp, baileys, zapo, meow, evo, evogo, zapi ou uazapi.
string
obrigatório
Número do destinatário desta chamada, com código do país e DDD.
string
obrigatório
Texto final, já com os dados do destinatário (por exemplo, Olá Maria, seu pedido 1234 saiu para entrega.). É enviado exatamente como está.
integer
obrigatório
Intervalo mínimo, em segundos, entre os envios.
integer
obrigatório
Intervalo máximo, em segundos, entre os envios.
string
Opcional. Linhas do lote: serve só para dimensionar o relatório do disparo. Não é usado para montar a mensagem.
integer
Opcional. ID devolvido na primeira chamada. Envie nas chamadas seguintes para agrupar todos os envios no mesmo relatório.
Fluxo recomendado:
1

Primeira chamada

Envie a mensagem do primeiro destinatário sem bulkDispatchId e guarde o bulkDispatchId devolvido na resposta.
2

Demais chamadas

Para cada destinatário seguinte, faça uma nova chamada com o número e a mensagem dele, informando o mesmo bulkDispatchId.
3

Acompanhamento

Consulte o andamento do lote em Obter Detalhes do Disparo.
Resposta:

BulkFastMessage: Disparo Rápido sem Criar Tickets

Disparo rápido para uma lista de números sem criar tickets no PanÐá Zap. Funciona apenas em canais dos tipos whatsapp, baileys e zapo, e o campo whatsappType é obrigatório. O intervalo entre os envios segue min e max, como nas demais rotas (para um intervalo fixo, use o mesmo valor nos dois).
Request
integer
obrigatório
O ID do canal do qual enviar.
string
obrigatório
Tipo do canal: whatsapp, baileys ou zapo.
string
obrigatório
Números separados por vírgula, com código do país e DDD. Por exemplo: 5511999990001,5511999990002.
string
Use false para números de contatos.
string
obrigatório
O texto enviado a todos os destinatários.
integer
obrigatório
Intervalo mínimo, em segundos. Para um intervalo fixo, use o mesmo valor de max. Mínimo recomendado: 5.
integer
obrigatório
Intervalo máximo, em segundos. Para um intervalo fixo, use o mesmo valor de min.
file
Arquivo a enviar (opcional).
string
true. Obrigatório quando você envia um arquivo em media.
Em teste com canal Baileys e sem arquivo, esta rota respondeu 500 com { "success": false, "error": "ERR_BULK_FAST_MESSAGE" }, enquanto BulkSendMessage funcionou com os mesmos campos. Se receber esse erro, use BulkSendMessage (que cria um ticket para cada contato).

BulkIndividual: Envio Individual Registrado como Disparo

Envia uma mensagem a um único número, registrada como disparo.
Request
integer
obrigatório
O ID do canal do qual enviar.
string
obrigatório
Tipo do canal: whatsapp, baileys, zapo, meow, evo, evogo, zapi, uazapi, waba, gupshup ou dialog360.
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.
file
Arquivo a enviar (opcional).
string
true. Obrigatório ao enviar arquivo nos canais whatsapp, baileys e zapo.
string
Opcional. Chave do seu sistema; nesta rota ela não impede o envio repetido.
Resposta:
A resposta traz ticketId, status, userId e userName do atendimento usado. Se o número já tiver um atendimento aberto, a rota usa esse atendimento em vez de abrir outro.

Verificação de Ticket Ativo

Quando a opção Verificar conversa em outros canais está ativada, contatos que já têm atendimento aberto ou pendente em qualquer canal WhatsApp da sua conta não recebem o disparo de BulkSendMessage, BulkFastMessage e BulkSendMessageWithVariable. A resposta informa quantos números foram pulados e quais:
Para ignorar a verificação de ticket ativo em uma chamada específica de envio em lote, inclua o campo skipActiveTicketCheck com o valor false na requisição (atenção: o valor é false). Assim o disparo vai para todos os contatos da lista, mesmo os que já têm conversa em aberto. A opção Verificar conversa em outros canais fica em Configurações → Gerais → Geral.

Gerenciando Disparos em Massa

Listar Todos os Disparos

Obtenha uma lista paginada dos registros de disparos em lote da sua conta.
A lista também traz os disparos de SMS em lote (aba SMS da tela Comunicados), identificados por dispatchType igual a "sms". Esses registros não têm canal (whatsapp vem null) e vêm sem a lista de números (metadata.contacts). Para ver os números, consulte o disparo em Obter Detalhes do Disparo.

Obter Detalhes do Disparo

Obtenha o status completo e as estatísticas de um disparo específico.
Principais campos da resposta (em data):

Registrar Progresso de um Disparo

Registra o resultado de um envio no progresso de um disparo em lote. Cada chamada soma ao progresso do disparo: chame uma única vez por envio.
Request
boolean
obrigatório
true se o envio deu certo, false se falhou. Usado para atualizar os contadores de enviados e de falhas do disparo.
string
Motivo da falha, quando success for false (ou null).
Disparos de SMS em lote (dispatchType igual a "sms") são controlados pelo servidor: para eles, esta rota responde 400 com ERR_SMS_BULK_READONLY.

Cancelar um Disparo

Atualiza o status de um disparo em lote, por exemplo para cancelá-lo.
Request
string
obrigatório
Novo status do disparo. Use "cancelled" para cancelá-lo.
string
Motivo do cancelamento, gravado no registro do disparo (campo cancellationReason).
Disparos de SMS em lote (dispatchType igual a "sms") são controlados pelo servidor e não podem ser alterados por esta rota: ela responde 400 com ERR_SMS_BULK_READONLY.