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
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
Números separados por vírgula, com código do país e DDD. Por exemplo:
5511999990001,5511999990002.Intervalo máximo, em segundos, entre cada envio. Um valor aleatório entre
min e max é usado entre os envios. Mínimo recomendado: 15.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.Request
Texto final, já com os dados do destinatário (por exemplo,
Olá Maria, seu pedido 1234 saiu para entrega.). É enviado exatamente como está.Opcional. Linhas do lote: serve só para dimensionar o relatório do disparo. Não é usado para montar a mensagem.
Opcional. ID devolvido na primeira chamada. Envie nas chamadas seguintes para agrupar todos os envios no mesmo relatório.
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.
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 tiposwhatsapp, 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
Números separados por vírgula, com código do país e DDD. Por exemplo:
5511999990001,5511999990002.Intervalo mínimo, em segundos. Para um intervalo fixo, use o mesmo valor de
max. Mínimo recomendado: 5.BulkIndividual: Envio Individual Registrado como Disparo
Envia uma mensagem a um único número, registrada como disparo.Request
Tipo do canal:
whatsapp, baileys, zapo, meow, evo, evogo, zapi, uazapi, waba, gupshup ou dialog360.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 deBulkSendMessage, 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
true se o envio deu certo, false se falhou. Usado para atualizar os contadores de enviados e de falhas do disparo.Cancelar um Disparo
Atualiza o status de um disparo em lote, por exemplo para cancelá-lo.Request

