Creare una campagna
/v1/accounts/{accountId}/campaignsCrea una nuova campagna nello stato Draft. Dopo averla creata, aggiungi i numeri alla campagna e attivala per iniziare a chiamare.
Tutti i campi vengono convalidati quando la campagna viene creata, e di nuovo quando viene attivata. Alcuni controlli si applicano solo al momento dell'attivazione, ad esempio che la data di fine non sia nel passato, che il Queues Monitor sia online per le campagne Predictive e Progressive, o che una campagna Static abbia dei numeri.
Parametri di percorso
ID del tuo account SIP Caller. Consulta ID dell'account.
Corpo della richiesta
Un oggetto JSON con le impostazioni della campagna. Tutti i campi devono essere inviati, tranne quelli nullable, che valgono null se omessi.
Nome della campagna, tra 2 e 99 caratteri. Deve essere univoco nell'account.
ID dei tag della campagna. Solo gli utenti con almeno uno di questi tag possono vedere la campagna nella Console Web. Invia un array vuoto per non assegnare tag.
Priorità della campagna, utilizzata per decidere da quale campagna prendere i prossimi numeri da chiamare, quando più campagne condividono le risorse.
LowNormalHighID del sistema telefonico utilizzato per effettuare le chiamate.
ID dell'interno del sistema telefonico utilizzato per effettuare le chiamate.
Modalità dialer della campagna e relative impostazioni. Il campo mode definisce la modalità, e gli altri campi dipendono da essa.
Primo giorno in cui la campagna può effettuare chiamate.
Ultimo giorno in cui la campagna può effettuare chiamate (questo giorno incluso), oppure null per nessuna data di fine. Non può essere precedente a startDate.
ID del gruppo di festività della campagna, oppure null. Le festività utilizzano gli orari di lavoro definiti per le domeniche.
Fuso orario IANA della campagna, ad esempio America/New_York. Le date e gli orari di lavoro sono relativi a questo fuso orario.
Fasce orarie in cui possono essere effettuate le chiamate, per ogni giorno della settimana. Ogni giorno deve essere presente: invia un array vuoto per i giorni senza chiamate.
Indica se è possibile aggiungere o eliminare numeri una volta attivata la campagna (Dynamic) oppure no (Static). Una campagna statica termina automaticamente quando tutti i suoi numeri sono stati elaborati.
StaticDynamicOrdine in cui vengono chiamati i numeri: primo entrato, primo uscito (Fifo), oppure ultimo entrato, primo uscito (Lifo).
FifoLifoIndica se i numeri non ancora contattati vengono chiamati prima dei tentativi ripetuti (NotContacted), o viceversa (RetryPending).
NotContactedRetryPendingPrefisso aggiunto a ogni numero prima della chiamata, ad esempio per selezionare una linea in uscita, oppure "" per nessun prefisso. È possibile specificare fino a 256 prefissi separati da virgole, per ruotarli: ciascuno fino a 6 caratteri, tra cifre, *, # e +.
Tempo di attesa affinché la chiamata riceva risposta: tra 1 e 600 secondi, oppure tra 1 e 10 minuti. In modalità Progressive, si applica alla chiamata verso l'agente.
Numero massimo di volte in cui viene chiamato ogni numero, tra 1 e 9.
Tempo minimo tra i tentativi, fino a 6 mesi. È possibile definire tra 1 e 8 intervalli, per utilizzare tempi di attesa diversi per i tentativi successivi.
ID delle liste nere con i numeri che non devono essere chiamati. Invia un array vuoto per non utilizzarne nessuna.
Cosa succede quando una chiamata riceve risposta. Il campo $t definisce la modalità di gestione delle chiamate, e gli altri campi dipendono da essa. Obbligatorio per le modalità dialer Power e Predictive, e deve essere null per la modalità Progressive, in cui la chiamata viene sempre collegata a un agente.
ID del webhook che riceve gli eventi della campagna, oppure null.
Restituisce
Restituisce il nuovo oggetto campagna, con stato 201 Created. L'intestazione Location contiene l'URL della nuova campagna.
/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": "Normal",
"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"
}'Risposta
201 Created
{
"id": "01a0e2b4-5c1d-7f3a-9b2e-6d8c4a1f0e27",
"name": "Q4 Renewals",
"tagIds": [],
"state": "Draft",
"activeStatus": null,
"runningPriority": "Normal",
"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
}
