Planejar antes de criar

Campanha possui cadastro, lista de contatos e ciclo próprio de início, pausa, retomada, cancelamento e relatório. Para uma entrega técnica avulsa ou uma lista montada pelo sistema consumidor, avalie o guia de envio em lote.

Formulário vazio de nova campanha com sessão, início, atraso e mensagens
Defina sessão, horário, cadência e conteúdo em uma campanha de teste antes de automatizar.

Conhecer as operações publicadas

  • Criar: POST /v2/api/external/{ApiID}/campaign/create com name, start, message1, message2, message3, sessionId e delay.
  • Listar: GET .../campaign/list com page e limit.
  • Atualizar: POST .../campaign/update/{campaignId} com os campos publicados na rota.
  • Duplicar: POST .../campaign/duplicate/{campaignId}.
  • Iniciar, pausar, retomar, pular e cancelar: rotas próprias .../start, .../pause, .../resume, .../skip e .../cancel.
  • Relatório: GET .../campaign/report/{campaignId}.
  • Excluir: POST .../campaign/delete/{campaignId}.
Tela de APIs usada para consultar as rotas de campanhas
Abra cada rota na documentação interativa da sua versão antes de criar o fluxo no sistema consumidor.

Montar e conferir a audiência

  • Adicionar contatos: POST .../campaign/contacts/add/{campaignId}; confirme o schema exibido no seu ambiente antes de enviar a lista.
  • O schema publicado para adicionar contatos apresenta uma lista de objetos com name e number; normalize e deduplique essa lista antes do envio.
  • Listar contatos: GET .../campaign/contacts/{campaignId}.
  • Remover um contato: POST .../campaign/contacts/remove/{campaignId}/{contactId}.
  • Remover todos: POST .../campaign/contacts/removeAll/{campaignId}.
  1. 1

    Crie uma campanha de homologação sem iniciá-la.

  2. 2

    Adicione um grupo mínimo de contatos controlados.

  3. 3

    Liste a audiência e compare quantidade e identificadores com a origem.

  4. 4

    Remova qualquer contato inesperado antes de programar o início.

  5. 5

    Registre a versão da lista aprovada para auditoria.

Controlar o ciclo da campanha

  1. 1

    Liste e consulte os dados da campanha criada.

  2. 2

    Confirme sessão, data de início, atraso e as três mensagens publicadas no cadastro.

  3. 3

    Inicie somente depois de validar a audiência.

  4. 4

    Use pausa e retomada como ações explícitas do operador ou do fluxo aprovado.

  5. 5

    Consulte o relatório antes de pular, cancelar, duplicar ou excluir.

  6. 6

    Guarde o campaignId e o resultado de cada transição sem registrar conteúdo pessoal.

Acompanhar e solucionar falhas

  • Campanha não inicia: confirme horário, sessão, audiência e estado atual.
  • Contato ausente: liste a audiência e valide o contactId no mesmo ambiente.
  • Conteúdo incorreto: pause a campanha, revise as mensagens e teste novamente com audiência controlada.
  • Campanha duplicada: procure repetição de campaign/create ou duplicate no sistema consumidor.
  • Estado incerto após timeout: consulte a listagem e o relatório antes de repetir a transição.
  • Exclusão recusada: interrompa as tentativas e confirme se a campanha ainda está ativa ou possui histórico que deve ser preservado.