Una campagna si riferisce a una funzionalità di composizione automatica in uscita che contatta in sequenza un elenco di contatti, avvia chiamate in uscita e collega ogni contatto a un agente disponibile. Gli endpoint della campagna forniscono l'accesso ai dati correlati alla campagna, consentendo il recupero degli oggetti campagna e contatto.
Oggetto campagna: rappresenta una singola campagna all'interno della piattaforma
Oggetto Contatto: rappresenta i singoli contatti della campagna all'interno di una campagna specifica
Consulta il seguente modello per determinare quali campi potrebbero contenere PII:
[
{
"campaign_type" : "default",
"id" : 67,
"external_campaign_id" : null,
"max_abandonment_percent" : 3,
"max_redial_count" : 3,
"mode" : "preview",
"name" : "string",
"overdial_adjustment_multiplier" : 1,
"queue" : {
"deleted" : false,
"hidden" : false,
"id" : 60,
"menu_type" : "ivr_menu",
"name" : "string",
"output_msg" : null,
"parent_id" : 59,
"position" : 4
},
"redial_interval_minutes" : 120,
"status" : "dialing",
"target_number_to_process" : 1000,
"created_at" : "2023-04-01T23:23:43.000Z",
"starts_at" : "2023-04-01T23:28:08.000Z",
"ends_at" : null,
"updated_at" : "2023-04-01T23:28:08.000Z",
"contact_stats" : {
"Abandoned by Contact" : 0,
"Abandoned by Dialer" : 0,
"Average Redials per Number" : 0,
"Carrier Error" : 0,
"Completed" : 50,
"Connected" : 0,
"Contacts" : 1000,
"Dialer General Error" : 0,
"Dialing" : 0,
"Do Not Call" : 0,
"Finished" : 40,
"Invalid Number or Name" : 0,
"Invalid outbound number" : 0,
"Not Picked Up" : 0,
"Not Reached to Contact" : 0,
"Not reached" : 10,
"Not yet reached" : 960,
"Queued" : 0,
"Reached" : 0,
"Redial Scheduled" : 0,
"Redials" : 0,
"Remaining" : 950,
"Running" : 0,
"Skipped" : 0,
"Skipped & Closed" : 10,
"Transferred" : 0,
"Transferred and Finished" : 0,
"Upcoming" : 950,
"Voicemail Hung Up" : 0
}
}
]
Campo Stato campagna
Il campo status può avere uno dei seguenti stati:
| Stato della campagna | Descrizione |
|---|---|
| creato | È stata creata una campagna, ma non sono state avviate chiamate in uscita. |
| iniziato | Una campagna ha iniziato a effettuare chiamate in uscita, ma non ha iniziato a comporre (conversazione). |
| composizione | Una campagna sta effettuando chiamate in uscita. |
| metti in pausa | Una campagna è stata messa in pausa da un agente o da un gestore. |
| completato | Una campagna ha completato tutte le chiamate. |
Campo Modalità campagna
Il campo mode può avere uno dei seguenti valori:
| Modalità campagna | Descrizione |
|---|---|
| anteprima | Per una campagna di anteprima, un agente si connette a un utente finale o sceglie l'azione da intraprendere per un determinato contatto. In una campagna di anteprima, il contatto o l'utente finale è noto. |
| predittivo | Per una campagna predittiva, un agente è connesso a una chiamata di prenotazione. Attiviamo il rilevamento automatico per la chiamata, che ci indica se la risposta a una chiamata in uscita proviene da una persona o da una macchina (ad esempio, una segreteria telefonica), mettendo in contatto l'agente solo con una persona. |
| progressivo/progressiva | Per la campagna progressiva, il dialer si connette prima al primo agente disponibile. Una volta stabilita la connessione, il dialer chiamerà e fornirà all'agente il primo contatto disponibile (un contatto che non è ancora stato chiamato per una determinata campagna). |
Campo Tipo di campagna
Il campo campaign_type può contenere uno qualsiasi dei seguenti valori:
| Tipo di campagna | Descrizione |
|---|---|
| predefinito | I contatti della campagna provengono da file CSV caricati dagli utenti. |
| external_list | I contatti della campagna provengono da servizi esterni o di terze parti. |
Elenco campagne
Endpoint:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns
Altri esempi di richieste/risposte:
Richiesta di esempio: elenco delle campagne
Query: nessuna
Body: None
Esempio di risposta: elenco campagne
[
{
"campaign_type": "default",
"id": 67,
"external_campaign_id": null,
"max_abandonment_percent": 3,
"max_redial_count": 3,
"mode": "preview",
"name": "string",
"overdial_adjustment_multiplier": 1,
"queue": {
"deleted": false,
"hidden": false,
"id": 60,
"menu_type": "ivr_menu",
"name": "string",
"output_msg": null,
"parent_id": 59,
"position": 4
},
"redial_interval_minutes": 120,
"status": "dialing",
"target_number_to_process": 1000,
"created_at": "2023-04-01T23:23:43.000Z",
"starts_at": "2023-04-01T23:28:08.000Z",
"ends_at": null,
"updated_at": "2023-04-01T23:28:08.000Z",
"contact_stats": {
"Abandoned by Contact": 0,
"Abandoned by Dialer": 0,
"Average Redials per Number": 0,
"Carrier Error": 0,
"Completed": 50,
"Connected": 0,
"Contacts": 1000,
"Dialer General Error": 0,
"Dialing": 0,
"Do Not Call": 0,
"Finished": 40,
"Invalid Number or Name": 0,
"Invalid outbound number": 0,
"Not Picked Up": 0,
"Not Reached to Contact": 0,
"Not reached": 10,
"Not yet reached": 960,
"Queued": 0,
"Reached": 0,
"Redial Scheduled": 0,
"Redials": 0,
"Remaining": 950,
"Running": 0,
"Skipped": 0,
"Skipped & Closed": 10,
"Transferred": 0,
"Transferred and Finished": 0,
"Upcoming": 950,
"Voicemail Hung Up": 0
}
}
]
Codice di stato: 200
Campagna singola
Endpoint:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}
Altri esempi di richieste/risposte:
Richiesta di esempio: singola campagna
Query:
| Parametro | Obbligatorio | Tipo di dati | Definizione |
|---|---|---|---|
| campaign_id | VERO | Numero intero | L'ID della campagna che vuoi recuperare |
Body: None
Esempio di risposta: singola campagna
{
"campaign_type": "default",
"id": 67,
"external_campaign_id": null,
"max_abandonment_percent": 3,
"max_redial_count": 3,
"mode": "preview",
"name": "string",
"overdial_adjustment_multiplier": 1,
"queue": {
"deleted": false,
"hidden": false,
"id": 60,
"menu_type": "ivr_menu",
"name": "string",
"output_msg": null,
"parent_id": 59,
"position": 4
},
"redial_interval_minutes": 120,
"status": "dialing",
"target_number_to_process": 1000,
"created_at": "2023-04-01T23:23:43.000Z",
"starts_at": "2023-04-01T23:28:08.000Z",
"ends_at": null,
"updated_at": "2023-04-01T23:28:08.000Z",
"contact_stats": {
"Abandoned by Contact": 0,
"Abandoned by Dialer": 0,
"Average Redials per Number": 0,
"Carrier Error": 0,
"Completed": 50,
"Connected": 0,
"Contacts": 1000,
"Dialer General Error": 0,
"Dialing": 0,
"Do Not Call": 0,
"Finished": 40,
"Invalid Number or Name": 0,
"Invalid outbound number": 0,
"Not Picked Up": 0,
"Not Reached to Contact": 0,
"Not reached": 10,
"Not yet reached": 960,
"Queued": 0,
"Reached": 0,
"Redial Scheduled": 0,
"Redials": 0,
"Remaining": 950,
"Running": 0,
"Skipped": 0,
"Skipped & Closed": 10,
"Transferred": 0,
"Transferred and Finished": 0,
"Upcoming": 950,
"Voicemail Hung Up": 0
}
}
Codice di stato: 200
Elenco contatti
| Parametro | Obbligatorio | Tipo di dati | Definizione |
|---|---|---|---|
| campaign_id | VERO | Numero intero | L'ID della campagna per cui vuoi ottenere i contatti |
Endpoint:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}/contacts
Altri esempi di richieste/risposte:
Esempio di richiesta: elenco contatti
Query:
| Parametro | Obbligatorio | Tipo di dati | Definizione |
|---|---|---|---|
| campaign_id | VERO | Numero intero | L'ID della campagna per cui vuoi ottenere i contatti |
Body: None
Esempio di risposta: elenco contatti
[
{
"assigned_call_id": 32001,
"assigned_participant_id": 54321,
"campaign_id": 240,
"created_at": "2023-04-01T17:15:38.000Z",
"id": 16312,
"name": "string",
"outbound_number": null,
"priority": null,
"status": "Upcoming",
"unique_id": "string",
"updated_at": "2023-04-01T17:15:38.000Z"
},
{
"assigned_call_id": 32002,
"assigned_participant_id": 54330,
"campaign_id": 240,
"created_at": "2023-04-01T17:15:38.000Z",
"id": 16313,
"name": "string",
"outbound_number": null,
"priority": null,
"status": "Upcoming",
"unique_id": "string",
"updated_at": "2023-04-01T17:15:38.000Z"
}
]
Codice di stato: 200