L'oggetto campagna

Identificatore univoco della campagna.

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.

Stato della campagna. Le nuove campagne vengono create come Draft. Usa Cambiare lo stato della campagna per attivare, mettere in pausa o annullare una campagna. Le campagne passano a Finished automaticamente.

Solo per le campagne Active, altrimenti null: indica se la campagna sta effettuando chiamate (Running), o il motivo per cui non le sta effettuando.

Priorità della campagna, tra -20 (la più bassa) e 20 (la più alta). Quando più campagne condividono le risorse, i prossimi numeri da chiamare vengono presi prima dalle campagne con la priorità più alta. Le richieste possono anche usare i nomi Min (-20), Low (-10), Normal (0), High (10) e Max (20), che distinguono tra maiuscole e minuscole, ma non numeri tra virgolette, come "10". Le risposte restituiscono sempre il numero.

ID 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.

Ordine in cui vengono chiamati i numeri: primo entrato, primo uscito (Fifo), oppure ultimo entrato, primo uscito (Lifo).

Indica se i numeri non ancora contattati vengono chiamati prima dei tentativi ripetuti (NotContacted), o viceversa (RetryPending).

Prefisso 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.

Quantità di numeri della campagna.

Quantità di numeri in ciascuno stato.

Nomi delle variabili i cui valori vengono memorizzati per ogni numero, oppure null se la campagna non ha ancora numeri. Sono definiti dai primi numeri aggiunti alla campagna.

Indica se la campagna è archiviata. Le campagne archiviate sono nascoste per impostazione predefinita nella Console Web.

Interazioni della campagna i cui risultati vengono riportati per ogni chiamata, come gli input DTMF dei flussi di chiamata o gli obiettivi dell'agente IA. Utilizzate per interpretare gli inputResults dei dettagli delle chiamate.

Data e ora di creazione della campagna.

Data e ora dell'ultima modifica. Invia questo valore come lastUpdatedAt quando modifichi la campagna.

Sempre null, tranne nella risposta di Eliminare una campagna, dove contiene la data e l'ora in cui la campagna è stata eliminata.

Data e ora in cui la campagna ha iniziato a effettuare chiamate, oppure null.

Data e ora in cui la campagna è stata annullata o è terminata, oppure null.