Criar uma campanha
/v1/accounts/{accountId}/campaignsCria uma nova campanha no estado Draft. Depois de criá-la, adicione números à campanha e ative-a para começar a ligar.
Todos os campos são validados quando a campanha é criada, e novamente quando ela é ativada. Algumas verificações só se aplicam no momento da ativação, como a data de término não estar no passado, o Queues Monitor estar online para campanhas Predictive e Progressive, ou uma campanha Static ter números.
Parâmetros de caminho
ID da sua conta SIP Caller. Consulte ID da conta.
Corpo da solicitação
Um objeto JSON com as configurações da campanha. Todos os campos devem ser enviados, exceto os anuláveis, que assumem o valor null quando omitidos.
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.
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.
StaticDynamicOrdem em que os números são chamados: primeiro a entrar, primeiro a sair (Fifo), ou último a entrar, primeiro a sair (Lifo).
FifoLifoIndica se os números ainda não contatados são chamados antes das novas tentativas (NotContacted), ou o contrário (RetryPending).
NotContactedRetryPendingPrefixo 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.
Retorna
Retorna o novo objeto campanha, com o status 201 Created. O cabeçalho Location contém a URL da nova campanha.
/v1/accounts/ACCOUNT_ID/campaigns
curl -X POST 'https://api.sipcaller.com/v1/accounts/ACCOUNT_ID/campaigns' \
-H 'Authorization: Bearer API_KEY_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"name": "Q4 Renewals",
"tagIds": [],
"runningPriority": 0,
"phoneSystemId": "0199817e-52e0-7079-9585-99a655c2acb3",
"extensionId": "93e5cdfc-6e42-4995-8263-9388a9047c29",
"dialer": {
"mode": "Predictive",
"intensity": 0
},
"startDate": "2026-10-01",
"endDate": null,
"holidayGroupId": null,
"timeZoneId": "America/New_York",
"workingTimes": {
"monday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"tuesday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"wednesday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"thursday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"friday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"saturday": [],
"sunday": []
},
"numberProvisioning": "Dynamic",
"numberSelection": "Fifo",
"numberPriority": "RetryPending",
"callPrefix": "",
"ringTimeout": {
"value": 30,
"unit": "Seconds"
},
"maxAttempts": 3,
"retryIntervals": [
{
"value": 1,
"unit": "Hours"
},
{
"value": 1,
"unit": "Days"
}
],
"blackListIds": [
"01a0dedd-b9a2-729d-8e0a-4e3ad9197aea"
],
"callHandling": {
"$t": "Callflow",
"answerTypeDetector": {
"$t": "AmdAgent",
"amdAgentId": "019f9cef-4a91-7c97-b7cd-edbb06a5038d",
"unknownAnswerTreatment": "Human",
"messageForVoicemail": {
"$t": "OnFirstDetection",
"callflowId": "019f81ba-a149-731a-a6cb-b47146c5f90d",
"isCallRetryEnabled": true
}
},
"callflowId": "019f9cd5-e8cd-716b-a9a6-37c9db2f97a2",
"ttsVoiceId": "azu-en-US-AvaMultilingualNeural"
},
"webhookEndpointId": "019af0c3-62d6-70f2-84a1-5ab5671721bb"
}'Resposta
201 Created
{
"id": "01a0e2b4-5c1d-7f3a-9b2e-6d8c4a1f0e27",
"name": "Q4 Renewals",
"tagIds": [],
"state": "Draft",
"activeStatus": null,
"runningPriority": 0,
"phoneSystemId": "0199817e-52e0-7079-9585-99a655c2acb3",
"extensionId": "93e5cdfc-6e42-4995-8263-9388a9047c29",
"dialer": {
"mode": "Predictive",
"intensity": 0
},
"startDate": "2026-10-01",
"endDate": null,
"holidayGroupId": null,
"timeZoneId": "America/New_York",
"workingTimes": {
"monday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"tuesday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"wednesday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"thursday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"friday": [
{
"start": "09:00",
"end": "13:00"
},
{
"start": "14:00",
"end": "18:00"
}
],
"saturday": [],
"sunday": []
},
"numberProvisioning": "Dynamic",
"numberSelection": "Fifo",
"numberPriority": "RetryPending",
"callPrefix": "",
"ringTimeout": {
"value": 30,
"unit": "Seconds"
},
"maxAttempts": 3,
"retryIntervals": [
{
"value": 1,
"unit": "Hours"
},
{
"value": 1,
"unit": "Days"
}
],
"blackListIds": [
"01a0dedd-b9a2-729d-8e0a-4e3ad9197aea"
],
"callHandling": {
"$t": "Callflow",
"answerTypeDetector": {
"$t": "AmdAgent",
"amdAgentId": "019f9cef-4a91-7c97-b7cd-edbb06a5038d",
"unknownAnswerTreatment": "Human",
"messageForVoicemail": {
"$t": "OnFirstDetection",
"callflowId": "019f81ba-a149-731a-a6cb-b47146c5f90d",
"isCallRetryEnabled": true
}
},
"callflowId": "019f9cd5-e8cd-716b-a9a6-37c9db2f97a2",
"ttsVoiceId": "azu-en-US-AvaMultilingualNeural"
},
"webhookEndpointId": "019af0c3-62d6-70f2-84a1-5ab5671721bb",
"numbersCount": 0,
"progress": {
"notContacted": 0,
"contacting": 0,
"success": 0,
"failure": 0,
"retryPending": 0,
"blacklisted": 0,
"deleted": 0
},
"varNames": null,
"isArchived": false,
"interactionLabels": [
{
"id": "a6d5b2e5-6b3f-49d8-aaa3-bc7b4c693f05",
"label": "Renewal confirmation"
}
],
"createdAt": "2026-09-28T14:02:11.482",
"updatedAt": "2026-09-28T14:02:11.482",
"deletedAt": null,
"startedAt": null,
"endedAt": null
}
