Escolher entre campanha e lote

Use campanha quando precisar de cadastro, audiência e ciclo programado administrado pelo Atendeu Rápido. Use envio em lote quando o sistema consumidor controla a lista e a execução técnica compatível com as rotas publicadas.

Tela Envio em Massa com modalidades Template, Texto, WaVoIP, SMS e Relatório
A interface reúne várias modalidades; a API de lote possui operações próprias e deve seguir o contrato da rota escolhida.

Conhecer as oito operações publicadas

  • Listar despachos: GET /v2/api/external/{ApiID}/bulkDispatch/list com page e limit.
  • Consultar despacho: GET .../bulkDispatch/show/{dispatchId}.
  • Atualizar despacho: POST .../bulkDispatch/update/{dispatchId} com status e cancellationReason.
  • Incrementar progresso: POST .../bulkDispatch/incrementProgress/{dispatchId} com success.
  • Mensagem rápida em lote: POST .../bulkFastMessage com whatsappId, whatsappType, arrayNumbers, message, min e max.
  • Envio individual controlado: POST .../bulkIndividual com whatsappId, number, message e externalKey.
  • Texto para uma lista: POST .../bulkSendMessage com whatsappId, arrayNumbers, message, min e max.
  • Texto variável: POST .../bulkSendMessageWithVariable com whatsappId, message, dataInput, min e max.
Tela de APIs para consultar as rotas de envio em lote
Confirme o schema exato na documentação interativa, especialmente para dados variáveis e controle do despacho.

Definir canal, lista e cadência

  • whatsappId deve pertencer ao canal correto no mesmo ambiente da API.
  • arrayNumbers deve conter somente destinatários validados e autorizados.
  • min e max controlam o intervalo publicado para as rotas de lista; valide unidade e comportamento no sandbox da sua versão.
  • dataInput transporta os dados do envio variável; confirme o formato exigido pela rota antes de montar o arquivo ou conteúdo.
  • externalKey no bulkIndividual é um identificador único, não uma garantia automática de repetição segura.
  • dispatchId identifica o acompanhamento de um despacho e não deve ser reutilizado entre execuções.

Executar um lote de homologação

  1. 1

    Comece com dois ou três números controlados e uma mensagem identificada como teste.

  2. 2

    Escolha apenas uma rota de envio e registre a lista aprovada.

  3. 3

    Defina uma cadência conservadora e faça uma única requisição.

  4. 4

    Guarde o identificador do despacho retornado pela sua versão, quando disponível.

  5. 5

    Consulte o despacho e compare progresso, sucessos, falhas e destinatários ignorados.

  6. 6

    Abra os tickets de teste e confirme que cada contato recebeu no máximo a entrega esperada.

  7. 7

    Amplie o volume somente depois da reconciliação completa.

Relatório de Envios em Massa com filtros de status, tipo e período
Concilie o estado técnico do despacho com o relatório e os tickets antes de aumentar o volume.

Monitorar sem produzir duplicidades

  • Despacho não aparece: revise ApiID, dispatchId, paginação e ambiente.
  • Destinatário ignorado: verifique se havia ticket aberto ou pendente antes de considerar um novo envio.
  • Envio variável incorreto: pare o lote e valide o formato de dataInput com poucos registros.
  • Progresso divergente: compare a consulta do despacho, o relatório e os tickets; não ajuste o contador sem entender a origem.
  • Timeout na criação: consulte despachos e tickets antes de repetir a requisição.
  • Duplicidade: desative retentativas automáticas e procure dois consumidores ou duas execuções da mesma lista.