O objeto campanha

Identificador único da campanha.

Nome da campanha, entre 2 e 99 caracteres. Deve ser único na conta.

IDs das tags da campanha. Somente os usuários com pelo menos uma dessas tags podem ver a campanha no Console Web. Envie um array vazio para não atribuir tags.

Estado da campanha. As novas campanhas são criadas como Draft. Use Alterar o estado da campanha para ativar, pausar ou cancelar uma campanha. As campanhas mudam para Finished automaticamente.

Somente para campanhas Active, e null nos demais casos: indica se a campanha está fazendo chamadas (Running), ou o motivo pelo qual não está.

Prioridade da campanha, entre -20 (a mais baixa) e 20 (a mais alta). Quando várias campanhas compartilham recursos, os próximos números para ligar são obtidos primeiro das campanhas com a prioridade mais alta. As requisições também podem usar os nomes Min (-20), Low (-10), Normal (0), High (10) e Max (20), que diferenciam maiúsculas de minúsculas, mas não números entre aspas, como "10". As respostas sempre retornam o número.

ID da central telefônica usada para fazer as chamadas.

ID do ramal da central telefônica usado para fazer as chamadas.

Modo do discador da campanha, e suas configurações. O campo mode define o modo, e os demais campos dependem dele.

Primeiro dia em que a campanha pode fazer chamadas.

Último dia em que a campanha pode fazer chamadas (incluindo esse dia), ou null para não ter data de término. Não pode ser anterior a startDate.

ID do grupo de feriados da campanha, ou null. Os feriados usam os horários de funcionamento definidos para os domingos.

Fuso horário IANA da campanha, como America/New_York. As datas e os horários de funcionamento são relativos a esse fuso horário.

Faixas de horário em que as chamadas podem ser feitas, para cada dia da semana. Todos os dias devem estar presentes: envie um array vazio para os dias sem chamadas.

Indica se é possível adicionar ou excluir números depois que a campanha for ativada (Dynamic) ou não (Static). Uma campanha estática é finalizada automaticamente quando todos os seus números foram processados.

Ordem em que os números são chamados: primeiro a entrar, primeiro a sair (Fifo), ou último a entrar, primeiro a sair (Lifo).

Indica se os números ainda não contatados são chamados antes das novas tentativas (NotContacted), ou o contrário (RetryPending).

Prefixo adicionado a cada número antes de ligar, por exemplo para selecionar uma linha de saída, ou "" para não usar prefixo. É possível especificar até 256 prefixos separados por vírgulas, para alternar entre eles: cada um com até 6 caracteres, entre dígitos, *, # e +.

Tempo de espera para que a chamada seja atendida: entre 1 e 600 segundos, ou entre 1 e 10 minutos. No modo Progressive, aplica-se à chamada para o agente.

Número máximo de vezes que cada número é chamado, entre 1 e 9.

Tempo mínimo entre tentativas, até 6 meses. É possível definir entre 1 e 8 intervalos, para usar tempos de espera diferentes em tentativas sucessivas.

IDs das listas negras com números que não devem ser chamados. Envie um array vazio para nenhuma.

O que acontece quando uma chamada é atendida. O campo $t define o modo de tratamento da chamada, e os demais campos dependem dele. Obrigatório para os modos de discador Power e Predictive, e deve ser null para o modo Progressive, em que a chamada é sempre conectada a um agente.

ID do webhook que recebe os eventos da campanha, ou null.

Quantidade de números da campanha.

Quantidade de números em cada status.

Nomes das variáveis cujos valores são armazenados para cada número, ou null se a campanha ainda não tiver números. São definidos pelos primeiros números adicionados à campanha.

Indica se a campanha está arquivada. As campanhas arquivadas ficam ocultas por padrão no Console Web.

Interações da campanha cujos resultados são informados para cada chamada, como as entradas DTMF dos fluxos de chamada, ou os objetivos do agente de IA. Usado para interpretar os inputResults dos detalhes da chamada.

Data e hora em que a campanha foi criada.

Data e hora da última alteração. Envie esse valor como lastUpdatedAt ao atualizar a campanha.

Sempre null, exceto na resposta de Excluir uma campanha, em que contém a data e hora em que a campanha foi excluída.

Data e hora em que a campanha começou a fazer chamadas, ou null.

Data e hora em que a campanha foi cancelada ou finalizada, ou null.