Viene creato un oggetto chiamata per ogni chiamata da o verso Contact Center AI Platform (CCAI Platform). Consulta il seguente modello per determinare quali campi potrebbero contenere PII.
[
{
"id": 0,
"parent_id": 0,
"lang": "en",
"call_type": "Voice Inbound (App)",
"status": "scheduled",
"sub_status": "Scheduled: Disconnected by unknown",
"created_at": "2018-06-07T19:49:52.896Z",
"queued_at": "2018-06-07T19:49:52.896Z",
"assigned_at": "2018-06-07T19:49:52.896Z",
"connected_at": "2018-06-07T19:49:52.896Z",
"ends_at": "2018-06-07T19:49:52.896Z",
"scheduled_at": "2018-06-07T19:49:52.896Z",
"updated_at": "2018-06-07T19:49:52.896Z",
"wait_duration": 0, //Deprecated, use queue_duration instead
"queue_duration": 0,
"call_duration": 0,
"hold_duration": 0,
"rating": 0,
"has_feedback": true,
"voip_provider": "voip_provider_twilio",
"out_ticket_id": "string",
"out_ticket_url": "string",
"verified": true,
"recording_url": "string",
"recording_permission": "not_asked",
"voicemail_reason": "not_voicemail",
"deflection": "no_deflection",
"disconnected_by": "disconnected_by_unknown",
"finish_reason": "no_reason",
"fail_details": "string",
"fail_reason": "nothing",
"adapter_fail_code": null,
"adapter_fail_message": null,
"support_number": "string",
"selected_menu": {
"id": 0,
"name": "string",
"parent_id": 0,
"position": 0,
"deleted": true,
"hidden": "string",
"menu_type": "ivr_menu",
"output_msg": "string"
},
"menu_path": {
"items_count": 0,
"name": "string",
"materialized_path": "string"
},
"agent_info": {
"id": 0,
"name": "string", //This may be considered PII
"last_name": "string", //This may be considered PII
"first_name": "string", //This may be considered PII
"agent_number": "string",
"avatar_url": "string"
},
"end_user": {
"id": 0, //This may be considered PII
"identifier": "string", //This may be considered PII
"out_contact_id": "string" //This may be considered PII
},
"photos": [
{
"id": 0, //This may be considered PII
"photo_type": "photo", //This may be considered PII
"url": "string" //This may be considered PII
}
],
"videos": [
{
"id": 0, //This may be considered PII
"url": "string" //This may be considered PII
}
],
"transfers": [
{
"id": 0,
"status": "transferring",
"fail_reason": "nothing",
"created_at": "2018-06-07T19:49:52.896Z",
"call_duration": 300,
"wait_duration": 40,
"assigned_at": "2018-06-07T19:50:32.896Z",
"connected_at": "2018-06-07T19:50:35.896Z",
"updated_at": "2018-06-07T19:55:35.896Z",
"deflection": 0,
"from_menu": {
"items_count": 0,
"name": "string",
"materialized_path": "string"
},
"to_menu": {
"items_count": 0,
"name": "string",
"materialized_path": "string"
},
"from_agent": {
"id": 0,
"name": "string", //This may be considered PII
"last_name": "string", //This may be considered PII
"first_name": "string", //This may be considered PII
"agent_number": "string",
"avatar_url": "string"
},
"to_agent": {
"id": 0,
"name": "string", //This may be considered PII
"last_name": "string", //This may be considered PII
"first_name": "string", //This may be considered PII
"agent_number": "string",
"avatar_url": "string"
}
}
],
"handle_durations": [
{
"agent_id": 0,
"acw_duration": 0,
"call_duration" 0,
"menu_path_id": 0,
"wait_duration": 0,
"lang": "en",
"transfer": false,
"started_at": "2019-07-17T07:27:14.000Z",
"ended_at": "2019-07-17T07:27:20.000Z",
"event": "call_finished"
}
],
"queue_durations": [
{
"agent_id": 0,
"queue_duration" 0,
"menu_path_id": 0,
"lang": "en",
"transfer": false,
"started_at": "2019-07-17T07:27:14.000Z",
"ended_at": "2019-07-17T07:27:20.000Z",
"service_level_abandon_time_threshold": 10,
"service_level_event": "not_in_sla",
"service_level_target_percent": 90,
"service_level_target_time": 60,
"event": "answered"
}
]
"participants": [
{
"id": 0,
"type": "end_user",
"status": "waiting",
"call_id": 0,
"user_id": 0, //This may be considered PII
"end_user_id": 0, //This may be considered PII
"call_duration": 0,
"hold_duration": 0,
"connected_at": "2018-06-07T19:49:52.896Z",
"ended_at": "2018-06-07T19:49:52.896Z",
"fail_reason": "nothing",
"adapter_fail_code": null,
"adapter_fail_message": null
},
"offer_type": null,
"offer_events": [],
"answer_type": "manual",
"outbound_number": null,
"wait_time_sms": [],
"in_call_sms": []
]
}
]
Il campo dello stato può avere uno dei seguenti stati:
| Stato della chiamata | Descrizione |
|---|---|
| Selezione | Stato che si verifica quando un utente finale ha chiamato il contact center, ma sta ancora navigando tra le opzioni del menu prima della richiesta di chiamata da un nodo foglia. |
| In coda | Stato che si verifica dopo che l'utente finale ha selezionato un nodo del menu secondario e ha avviato una richiesta di chiamata da trasmettere in modalità unicast o multicast a un agente. |
| Assegnata | Stato che si verifica quando un agente viene selezionato per ricevere la chiamata dell'utente finale. Si verifica quando un operatore risponde a una chiamata. |
| Connessione in corso… | Stato che si verifica dopo l'assegnazione di un agente e in attesa di stabilire una connessione tra l'utente finale e l'agente. |
| Connesso | Stato che si verifica quando la chiamata ha stabilito una connessione e l'agente e l'utente finale vengono entrambi inseriti in una chiamata. |
| Terminato | Stato che si verifica quando la conversazione tra un agente e un utente finale termina una chiamata senza errori. |
| Non riuscito | Stato che si verifica quando una chiamata termina a causa di un errore. Quando viene visualizzato questo stato, viene fornito anche un motivo per il mancato completamento per un contesto più ampio |
| Cambiamento modalità in corso | Stato che si verifica quando una chiamata non va a buon fine durante il tentativo di connessione e CCAI Platform tenta di connettere la chiamata con un altro fornitore VoIP. |
| Recuperato | Stato che si verifica quando viene richiamata una chiamata non riuscita. Questa nuova chiamata è una chiamata secondaria della chiamata originale. Recupera le note che la richiamata è terminata senza errori. |
| Pianificato | Stato che si verifica quando un utente finale ha scelto di essere chiamato in futuro nell'ambito di un'opzione di deviazione o ha selezionato di essere chiamato in futuro utilizzando In-Web o In-App. |
| Solo azione | Stato che si verifica quando una chiamata gestita dal provider di telefonia del nostro cliente viene connessa al nostro SDK per iOS o Android. |
| Azione solo terminata | Stato che si verifica quando una chiamata gestita dal provider di telefonia del nostro cliente viene connessa al nostro SDK per iOS o Android e termina |
| Deviato | Stato che si verifica in base alla configurazione per le code in sovracapacità o le chiamate fuori orario. Le opzioni di deviazione includono la segreteria, la pianificazione della chiamata e altre. La deviazione varia in base al canale (in-app, IVR, in-web) |
| Segreteria | Stato che si verifica quando un utente finale viene reindirizzato a un'opzione di segreteria telefonica e sceglie di lasciare un messaggio vocale da ascoltare in un secondo momento. Questo stato è presente quando l'utente finale sta lasciando il messaggio vocale |
| Messaggio vocale ricevuto | Stato che si verifica dopo che un utente finale ha lasciato un messaggio vocale e un agente non lo ha ascoltato |
| Messaggio vocale letto | Stato che si verifica quando un agente ha aperto il messaggio vocale per ascoltarlo. |
Il campo call_type può avere solo uno dei seguenti valori
| Tipo di chiamata | Descrizione |
|---|---|
| Inbound vocale (IVR) | Chiamata RTG in arrivo dal telefono di un utente finale. |
| Voice Inbound (app) | Chiamata in arrivo effettuata dall'interno di un'applicazione iOS o Android che utilizza il nostro SDK Mobile. |
| Richiamata vocale (web) | Richiesta di chiamata in arrivo effettuata dall'interno del nostro SDK web |
| Voice Scheduled (app) | Chiamata effettuata da un agente a un utente finale pianificata in anticipo utilizzando la funzionalità di pianificazione dell'SDK mobile. |
| Voice Scheduled (web) | Chiamata effettuata da un agente a un utente finale pianificata in anticipo utilizzando la funzionalità di pianificazione dell'SDK web |
| Voice Outbound | Chiamata effettuata da un agente a un utente finale utilizzando il tastierino o un altro metodo per chiamare una linea telefonica esterna. |
Il campo service_level_event può contenere solo uno dei seguenti valori:
| Evento del livello di servizio | Descrizione |
|---|---|
| in_sla | La chiamata ha ricevuto risposta entro i termini dello SLA |
| not_in_sla | La chiamata non ha ricevuto risposta entro lo SLA definito |
| esclusi | La chiamata non è stata inclusa nel calcolo del contratto di servizio (ad es. se la chiamata è stata abbandonata) |
Se non nulli, i campi adapter_fail_code e adapter_fail_message possono contenere solo uno dei seguenti valori:
| Codice di errore dell'adattatore | Messaggio di errore dell'adattatore |
|---|---|
| 10001 | Questa chiamata ha riscontrato un errore imprevisto. |
| 11001 | Questa chiamata è scaduta durante l'attesa in coda. |
| 20001 | Questa chiamata è stata annullata dal cliente. |
| 20002 | Questa chiamata è stata rifiutata dal cliente. |
| 20003 | Questa chiamata è stata abbandonata dal cliente. |
| 20004 | Questa chiamata è stata abbandonata dal cliente durante la selezione del menu. |
| 21001 | Impossibile connettere la chiamata; la linea del cliente è occupata. |
| 21002 | Il numero di telefono composto non è valido. |
| 21003 | Il cliente non ha risposto a questa chiamata. |
| 22001 | L'invio della notifica push per avviare questa chiamata non è riuscito. |
| 30001 | Questa chiamata è stata annullata. |
| 30002 | Questa chiamata scaduta non è stata effettuata. |
| 31001 | Impossibile rilevare il microfono. Controlla le impostazioni del dispositivo e riprova. |
| 31002 | Impossibile accedere al microfono. Controlla le autorizzazioni del dispositivo e riprova. |
| 32001 | Il numero in uscita selezionato non è valido. |
| 32002 | Impossibile collegare la chiamata al numero di telefono composto. |
| 41001 | Si è verificato un errore imprevisto con la connessione della chiamata. |
| 42001 | Si è verificato un errore imprevisto con la connessione della chiamata. |
| 43001 | Questa chiamata ha riscontrato un errore imprevisto. |
| 44001 | Questa chiamata ha riscontrato un errore imprevisto. |
| 44002 | Questa chiamata è terminata perché la connessione è scaduta. |
| 44003 | Questa chiamata ha riscontrato un errore imprevisto. |
| 90001 | Questa chiamata viene terminata perché non è stato rilevato alcun audio. |
| 90002 | Impossibile avviare il dispositivo audio. Controlla le autorizzazioni del dispositivo audio e riprova. |
Chiamate
| Parametro | Obbligatorio | Tipo di dati | Definizione |
|---|---|---|---|
| connected_at[from] | FALSE | Ora in UTC | crea un limite inferiore del campo Connesso il giorno. Tutti i record restituiti saranno precedenti al valore inserito. |
| connected_at[to] | FALSE | Ora in UTC | crea un limite superiore del campo Connesso il giorno. Tutti i record restituiti saranno precedenti al valore inserito. |
| updated_at[from] | FALSE | Ora in UTC | crea un limite inferiore del campo Aggiornato il. Tutti i record restituiti saranno successivi al valore inserito. |
| updated_at[to] | FALSE | Ora in UTC | crea un limite superiore del campo Connesso il giorno. Tutti i record restituiti saranno precedenti al valore inserito. |
| queued_at[from] | FALSE | Ora in UTC | crea un limite inferiore del campo In coda il giorno. Tutti i record restituiti saranno successivi al valore inserito. |
| queued_at[to] | FALSE | Ora in UTC | crea un limite superiore del campo In coda alle. Tutti i record restituiti saranno precedenti al valore inserito. |
| rating[from] | FALSE | Numero da 1 a 5 o null | crea un limite inferiore del campo di valutazione. Tutti i record restituiti saranno successivi al valore inserito. |
| rating[to] | FALSE | Numero da 1 a 5 o null | crea un limite superiore del campo di valutazione. Tutti i record restituiti saranno precedenti al valore inserito. |
| call_duration[from] | FALSE | Numero | crea un limite inferiore del campo della durata della chiamata. Tutti i record restituiti saranno successivi al valore inserito. |
| call_duration[to] | FALSE | Numero | crea un limite superiore del campo della durata della chiamata. Tutti i record restituiti saranno precedenti al valore inserito. |
| hold_duration[from] | FALSE | Numero | crea un limite inferiore del campo della durata della sospensione. Tutti i record restituiti saranno successivi al valore inserito. |
| hold_duration[to] | FALSE | Numero | crea un limite superiore del campo della durata della sospensione. Tutti i record restituiti saranno precedenti al valore inserito. |
| id[] | FALSE | Array[Stringa] | Array di stringhe. ID dei record da cercare e restituire. |
| agent_id[] | FALSE | Array[Stringa] | Filtra la risposta per ID agente |
| end_user_id[] | FALSE | Array[Stringa] | Filtra la risposta in base all'ID utente finale |
| call_status[] | FALSE | Array[Stringa] | Restituisci i record di un determinato stato nel ciclo di vita della chiamata. I valori possibili sono: scheduled, queued, assigned, connecting, switching, connected, finished, failed, recovered, deflected, selecting, action_only, action_only_finished, voicemail, voicemail_received, voicemail_read |
| call_fail_reason[] | FALSE | Array[Stringa] | Restituisce i record che non sono riusciti in un determinato modo. I valori possibili sono: nothing, unknown, expired, eu_canceled, eu_rejected, eu_abandoned, eu_in_menu_abandoned, eu_busy, eu_wrong_number, eu_no_answer, eu_noti_failed, ag_canceled, ag_ignored, ag_mic_no_device, ag_mic_denied, voip_twilio_error, voip_tokbox_error, voip_invalid_token, voip_conn_general, voip_conn_timeout, voip_conn_signal |
| verificato[] | FALSE | Booleano | Restituisce i record verificati (True) o non verificati (False) |
| call_type[] | FALSE | Array[Stringa] | Restituisce i record di un determinato tipo di chiamata. I valori possibili sono: IncomingCallApp, ScheduledCallApp, OutboundCall, AgentScheduledCall, IvrCall, IncomingCallWeb, ScheduledCallWeb, ActionOnlyCall |
| support_number[] | FALSE | Array[Stringa] | Filtra in base al numero di telefono utilizzato dall'utente finale per contattare (solo per la chiamata IVR) |
Endpoint:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/calls
Intestazioni:
| Chiave | Valore | Descrizione |
|---|---|---|
| Content-Type | application/json |
Altri esempi di richieste/risposte:
Esempio di richiesta: chiamate
Body: None
Esempio di risposta: Chiamate
[
{
"id": 1,
"lang": "en",
"call_type": "Voice Inbound (App)",
"status": "finished",
"created_at": "2016-02-19T18:53:56.000Z",
"queued_at": "2016-02-19T18:53:57.000Z",
"assigned_at": "2016-02-19T18:53:58.000Z",
"connected_at": "2016-02-19T18:54:18.000Z",
"ends_at": "2016-02-19T18:54:39.000Z",
"updated_at": "2016-02-19T18:54:39.000Z",
"scheduled_at": null,
"queue_duration": 22,
"wait_duration": 22,
"call_duration": 21,
"hold_duration": 0,
"rating": null,
"has_feedback": false,
"voip_provider": "voip_provider_twilio",
"out_ticket_id": null,
"out_ticket_url": null,
"verified": false,
"recording_url": null,
"recording_permission": "not_asked",
"voicemail_reason": "not_voicemail",
"deflection": "no_deflection",
"disconnected_by": "disconnected_by_unknown",
"fail_reason": "nothing",
"fail_details": null,
"recordings": [
{
"id": 7,
"call_id": 1,
"conference_sid": "CF50ec183fafcff801226b6fc332EC02ba7c4",
"duration": 20,
"recording_type": "default",
"redaction_times": [
{
"start": "2016-02-19T18:54:23.000Z",
"end": "2016-02-19T18:54:25.000Z",
"duration": 2.000,
"start_agent_id": 2,
"end_agent_id": 2
}
],
"started_at": "2016-02-19T18:54:18.000Z"
}
],
"support_number": "+12128675309",
"selected_menu": {
"id": 11,
"name": "Carpentry",
"parent_id": 1,
"position": 1,
"deleted": false,
"hidden": false,
"menu_type": "ivr_menu",
"output_msg": "Thanks for calling Death Star Carpentry"
},
"menu_path": {
"items_count": 1,
"name": "Carpentry",
"materialized_path": "Death Star/Carpentry"
},
"queue_priority_level": 0,
"end_user": {
"id": 3,
"identifier": "Death Star Carpentry Union",
"out_contact_id": "363876643527"
},
"photos": [{
"id": 0,
"photo_type": "photo",
"url": "www.photolocation.co/photo/123456868686"
}],
"videos": [{
"id": 0,
"url": "www.videolocation.co/video/123456868686"
}],
"transfers": [{
"id": 11,
"status": "transferring",
"fail_reason": "nothing",
"created_at": "2016-02-19T18:58:18.000Z",
"from_menu": {
"items_count": 2,
"name": "Cabinetry",
"materialized_path": "Death Star/Cabinetry"
},
"to_menu": {
"items_count": 2,
"name": "Carpentry",
"materialized_path": "Death Star/Carpentry"
},
"from_agent": {
"id": 2,
"name": "San Holo",
"last_name": "San",
"first_name": "Holo",
"agent_number": "6",
"avatar_url": "www.avatarurl.co/avatar/1234543"
},
"to_agent": {
"id": 0,
"name": "Farrison Hord",
"last_name": "Farrison",
"first_name": "Hord",
"agent_number": "12",
"avatar_url": "www.avatarurl.co/avatar/1234545"
}
}],
"participants": [
{
"id": 5,
"type": "end_user",
"status": "finished",
"call_id": 3,
"user_id": null,
"end_user_id": 3,
"call_duration": 21,
"hold_duration": null,
"connected_at": "2016-02-19T18:54:18.000Z",
"ended_at": "2016-02-19T18:54:39.000Z",
"fail_reason": "nothing"
},
{
"id": 3,
"type": "agent",
"status": "finished",
"call_id": 3,
"user_id": 5,
"end_user_id": null,
"call_duration": 21,
"hold_duration": null,
"connected_at": "2016-02-19T18:54:18.000Z",
"ended_at": "2016-02-19T18:54:39.000Z",
"fail_reason": "nothing"
},
{
"id": 6,
"type": "agent",
"status": "finished",
"call_id": 3,
"user_id": 12,
"end_user_id": null,
"call_duration": 21,
"hold_duration": null,
"connected_at": "2016-02-19T18:54:18.000Z",
"ended_at": "2016-02-19T18:54:39.000Z",
"fail_reason": "nothing"
}
],
"offer_type": "cascade",
"offer_events": [
{
"casting_time": "2018-11-12T15:52:38.000Z",
"group": "Group 1"
}
],
"answer_type": "manual",
"outbound_number": null,
"dispositions": [
{
"user_id": 3,
"participant_id": 225,
"code": "Product question"
},
{
"user_id": 3,
"transfer_id": 1,
"participant_id": 226,
"code": "Requires follow up"
}
],
"consumer_handle_durations": [
{
"id": 100,
"call_duration": 314,
"hold_duration": 3,
"started_at": "2016-02-19T18:50:08.000Z",
"ended_at": "2016-02-19T18:55:22.000Z"
}
],
"consumer_in_menu_durations": [
{
"id": 100,
"event": "finished",
"duration": 238,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"started_at": "2016-02-19T18:50:08.000Z",
"ended_at": "2016-02-19T18:54:06.000Z"
}
],
"consumer_event_durations": [
{
"id": 10,
"type": "payment",
"event": "finished",
"duration": 20,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"started_at": "2016-02-19T18:54:38.000Z",
"ended_at": "2016-02-19T18:54:58.000Z"
},
{
"id": 11,
"type": "csat",
"event": "abandoned",
"duration": 4,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"started_at": "2016-02-19T18:54:39.000Z",
"ended_at": "2016-02-19T18:54:43.000Z"
}
],
"handle_durations": [
{
"id": 10001,
"agent_id": 5,
"acw_duration": 0,
"bcw_duration": 0,
"call_duration": 21,
"assigned_connection_duration": 10,
"hold_duration": 3,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"barged": 0,
"transfer": 0,
"transfer_id": null,
"transfer_cold": 0,
"started_at": "2016-02-19T18:54:18.000Z",
"ended_at": "2016-02-19T18:54:39.000Z",
"scheduled_at": null
},
{
"id": 10002,
"agent_id": 5,
"acw_duration": 25,
"bcw_duration": 0,
"call_duration": 0,
"assigned_connection_duration": 0,
"hold_duration": 0,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"barged": 0,
"transfer": 0,
"transfer_id": null,
"transfer_cold": 0,
"started_at": "2016-02-19T18:54:39.000Z",
"ended_at": "2016-02-19T18:55:04.000Z",
"scheduled_at": null
},
{
"id": 10003,
"agent_id": 12,
"acw_duration": 1,
"bcw_duration": 0,
"call_duration": 21,
"assigned_connection_duration": 5,
"hold_duration": 0,
"menu_path_id": 4,
"menu_path": "Deathstar/Returns",
"lang": "en",
"barged": 0,
"transfer": 1,
"transfer_id": 11,
"transfer_cold": 0,
"started_at": "2016-02-19T18:54:18.000Z",
"ended_at": "2016-02-19T18:54:39.000Z",
"scheduled_at": null
}
],
"queue_durations": [
{
"id": 20011,
"agent_id": 5,
"queue_duration": 12,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"transfer": 0,
"transfer_id": null,
"transfer_cold": 0,
"started_at": "2016-02-19T18:54:06.000Z",
"ended_at": "2016-02-19T18:54:18.000Z",
"service_level_abandon_time_threshold": 10,
"service_level_event": "in_sla",
"service_level_target_percent": 90,
"service_level_target_time": 60
},
{
"id": 20012,
"agent_id": 12,
"queue_duration": 10,
"menu_path_id": 21,
"menu_path": "Deathstar/Returns",
"lang": "en",
"transfer": 1,
"transfer_id": 11,
"transfer_cold": 0,
"started_at": "2016-02-19T18:54:08.000Z",
"ended_at": "2016-02-19T18:54:18.000Z",
"service_level_abandon_time_threshold": 10,
"service_level_event": "not_in_sla",
"service_level_target_percent": 90,
"service_level_target_time": 60
}
],
"virtual_agent": {
"id": 10,
"name": "D2-R2"
},
"virtual_agent_deflected_escalations": [
{
"id": 1,
"deflection": "after_hours",
"escalation_id": 1,
"escalation_reason": "by_end_user_message",
"escalated_at": "2016-02-19T18:54:06.000Z",
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"virtual_agent": {
"id": 10,
"name": "D2-R2"
}
}
],
"virtual_agent_handle_durations": [
{
"id": 1,
"virtual_agent": {
"id": 10,
"name": "D2-R2"
},
"call_duration": 11,
"escalation_reason": "by_end_user_message",
"sentiment": 85,
"response_count": 11,
"fallback_response_count": 1,
"initiated_by": "end_user",
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"transfer": false,
"transfer_id": null,
"started_at": "2016-02-19T18:52:36.000Z",
"ended_at": "2016-02-19T18:54:06.000Z"
}
]
}
]
Codice di stato: 200