Di seguito è riportato un modello della risorsa chat. Fai riferimento a questo modello per determinare quali campi potrebbero contenere informazioni che consentono PII;identificazione personale.
[
{
"id": 31354,
"lang": "en",
"chat_type": "Messaging Inbound (App Chat)",
"status": "finished",
"sub_status": "Disconnected by end user",
"created_at": "2019-07-17T07:27:14.000Z",
"assigned_at": "2019-07-17T07:27:20.000Z",
"ends_at": "2019-07-17T07:29:02.000Z",
"updated_at": "2019-07-17T07:29:02.000Z",
"first_msg_sent_at": "2019-07-17T07:27:26.000Z",
"last_msg_sent_at": "2019-07-17T07:27:28.000Z",
"wait_duration": 0, //Deprecated, use queue_duration instead
"queue_duration": 0,
"chat_duration": 0,
"verified": false,
"rating": 0,
"has_feedback": false,
"out_ticket_id": "string",
"out_ticket_url": "string",
"finish_reason": "finish_reason_none",
"fail_reason": null,
"message_count": 3,
"average_response_time": 0,
"longest_response_time": 0,
"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": 1,
"name": "Ringo",
"materialized_path": "3389"
},
"agent_info": {
"id": 0,
"name": "string",
"last_name": "string",
"first_name": "string",
"agent_number": "string",
"avatar_url": "string"
},
"end_user": {
"id": 0,
"identifier": "string",
"out_contact_id": "string"
},
"photos": [
{
"id": 0,
"photo_type": "photo",
"url": "string"
}
],
"videos": [
{
"id": 0,
"url": "string"
}
],
"transfers": [
{
"id": 0,
"status": "transferring",
"fail_reason": "nothing",
"created_at": "2018-06-07T19:49:52.896Z",
"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",
"last_name": "string",
"first_name": "string",
"agent_number": "string",
"avatar_url": "string"
},
"to_agent": {
"id": 0,
"name": "string",
"last_name": "string",
"first_name": "string",
"agent_number": "string",
"avatar_url": "string"
}
}
],
"handle_durations": [
{
"agent_id": 0,
"acw_duration": 0,
"chat_duration" 0,
"wait_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",
"event": "chat_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,
"end_user_id": 0,
"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"
}
]
}
"offer_type": "cascade",
"offer_events": [
{
"casting_time": "2019-07-17T07:27:15.000Z",
"group": "Group 1"
}
]
},
Il campo service_level_event può avere 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) |
Chat
| Parametro | Obbligatorio | Tipo di dati | Definizione |
|---|---|---|---|
| sort_column | FALSE | Stringa | Ordina la risposta in base a qualsiasi campo dell'oggetto risposta. |
| sort_direction | FALSE | ASC o DESC | Indica la direzione dell'ordinamento, crescente o decrescente |
| pagina | FALSE | Stringa | Coppie con per per indicare la pagina dei record. Ad esempio, se per è impostato su 200 e page è 2, la risposta conterrà i record da 201 a 400, poiché la pagina 1 conterrà i record da 1 a 200. |
| per | FALSE | Stringa | Coppie con la pagina per annotare quanti record verranno inclusi in una pagina di record. Ad esempio, se per è impostato su 200 e page è 2, la risposta conterrà i record da 201 a 400, poiché la pagina 1 conterrà i record da 1 a 200. |
| assigned_at[from] | FALSE | Ora in UTC | crea un limite inferiore del campo Assegnato il. Tutti i record restituiti saranno successivi al valore inserito. |
| assigned_at[to] | FALSE | Ora in UTC | crea un limite superiore del campo Assegnato il. Tutti i record restituiti saranno precedenti al valore inserito. |
| ends_at[from] | FALSE | Ora in UTC | crea un limite inferiore del campo ends at. Tutti i record restituiti saranno successivi al valore inserito. |
| ends_at[to] | FALSE | Ora in UTC | crea un limite superiore del campo Termina il. 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 Aggiornato il. Tutti i record restituiti saranno precedenti al valore inserito. |
| created_at[from] | FALSE | Ora in UTC | crea un limite inferiore del campo creato il. Tutti i record restituiti saranno successivi al valore inserito. |
| created_at[to] | FALSE | Ora in UTC | crea un limite superiore del campo creato il. 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. |
| first_msg_sent_at[from] | FALSE | Ora in UTC | crea un limite inferiore del primo campo msg sent at. Tutti i record restituiti saranno successivi al valore inserito. |
| first_msg_sent_at[to] | FALSE | Ora in UTC | crea un limite superiore del primo messaggio inviato nel campo. Tutti i record restituiti saranno precedenti al valore inserito. |
| last_msg_sent_at[from] | FALSE | Ora in UTC | crea un limite inferiore dell'ultimo messaggio inviato nel campo. Tutti i record restituiti saranno successivi al valore inserito. |
| last_msg_sent_at[to] | FALSE | Ora in UTC | crea un limite superiore del campo Ultimo messaggio inviato alle ore. Tutti i record restituiti saranno precedenti al valore inserito. |
| chat_duration[from] | FALSE | Numero | crea un limite inferiore del campo della durata della chat. Tutti i record restituiti saranno successivi al valore inserito. |
| chat_duration[to] | FALSE | Numero | crea un limite superiore del campo della durata della chat. Tutti i record restituiti saranno precedenti al valore inserito. |
| message_count[from] | FALSE | Numero | crea un limite inferiore del campo conteggio messaggi. Tutti i record restituiti saranno successivi al valore inserito. |
| message_count[to] | FALSE | Numero | crea un limite superiore del campo del conteggio dei messaggi. Tutti i record restituiti saranno precedenti al valore inserito. |
| average_response_time[from] | FALSE | Numero | crea un limite inferiore del campo tempo di risposta medio. Tutti i record restituiti saranno successivi al valore inserito. |
| average_response_time[to] | FALSE | Numero | crea un limite superiore del campo Tempo di risposta medio. Tutti i record restituiti saranno precedenti al valore inserito. |
| longest_response_time[from] | FALSE | Numero | crea un limite inferiore del campo del tempo di risposta più lungo. Tutti i record restituiti saranno successivi al valore inserito. |
| longest_response_time[to] | FALSE | Numero | crea un limite superiore del campo del tempo di risposta più lungo. Tutti i record restituiti saranno precedenti al valore inserito. |
| wait_duration[from] | FALSE | Numero | crea un limite inferiore del campo della durata dell'attesa. Tutti i record restituiti saranno successivi al valore inserito. |
| wait_duration[to] | FALSE | Numero | crea un limite superiore del campo della durata dell'attesa. Tutti i record restituiti saranno precedenti al valore inserito. |
| id[] | FALSE | Array[Stringa] | Array[Strings]. 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 |
| chat_type[] | FALSE | Array[Stringa] | Restituisce i record in base alla modalità di accesso alla chat da parte dell'utente finale. Valori possibili: Messaggistica in entrata (chat app), Messaggistica in entrata (chat web), Messaggistica (SMS) |
| chat_status[] | FALSE | Array[Stringa] | Restituisce i record in base alla fase del ciclo di vita della chat in cui si trova l'utente. Valori possibili: queued, assigned, finished, canceled, failed, no_response |
| verificato[] | FALSE | Booleano | Restituisce i record verificati (True) o non verificati (False) |
| chat_fail_reason[] | FALSE | Array[Stringa] | Restituisce i record in base al motivo per cui una chat potrebbe non essere andata a buon fine. Valori possibili: nothing, unknown, no_response, expired |
Il valore di service_level_event può essere uno dei seguenti.
| 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) |
Endpoint:
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/chats
Altri esempi di richieste/risposte:
Richiesta di esempio: chat
Query:
| Chiave | Valore | Descrizione |
|---|---|---|
| updated_at[from] | \{updated_at\[from\]\} | Ora in formato UTC. Crea un limite inferiore del campo Aggiornato il. Tutti i record restituiti saranno successivi al valore inserito. |
| updated_at[to] | \{updated_at\[to\]\} | Ora in formato UTC. Crea un limite superiore del campo Aggiornato il. Tutti i record restituiti saranno precedenti al valore inserito. |
Body: None
Esempio di risposta: Chat
[
{
"id": 1,
"lang": "en",
"chat_type": "Messaging Inbound (App Chat)",
"status": "finished",
"created_at": "2016-02-26T18:35:54.000Z",
"assigned_at": "2016-02-26T18:36:05.000Z",
"ends_at": "2016-02-26T18:37:24.000Z",
"updated_at": "2016-02-26T18:37:24.000Z",
"first_msg_sent_at": null,
"last_msg_sent_at": null,
"chat_duration": 11,
"wait_duration": 22,
"queue_duration": 22,
"verified": true,
"rating": 5,
"has_feedback": false,
"out_ticket_id": "209",
"out_ticket_url": null,
"fail_reason": null,
"message_count": 0,
"average_response_time": 0,
"longest_response_time": 0,
"selected_menu": null,
"menu_path": null,
"agent_info": {
"id": 4,
"agent_number": "007",
"name": "Storm Trooper 1",
"last_name": "Storm",
"first_name": "Trooper 1",
},
"end_user": {
"id": 1,
"identifier": "Death Star Carpentry",
"out_contact_id": "360949501087"
},
"photos": [
{
"id": 3,
"photo_type": "photo",
"url": "true"
}
],
"consumer_handle_durations": [
{
"id": 100,
"chat_duration": 314,
"message_count": 10,
"response_count": 6,
"response_time_total": 85,
"response_time_max": 25,
"response_time_avg": 12,
"started_at": "2016-02-19T18:50:08.000Z",
"ended_at": "2016-02-19T18:55:22.000Z"
}
],
"consumer_event_durations": [
{
"id": 11,
"type": "csat",
"event": "finished",
"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": 30001,
"agent_id": 4,
"acw_duration": 0,
"chat_duration": 11,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"transfer": 0,
"transfer_id": null,
"started_at": "2016-03-02T23:24:08.000Z",
"ended_at": "2016-03-02T23:24:42.000Z",
"response_count": 11,
"response_time_total": 259,
"response_time_max": 29,
"response_time_avg": 24,
"assigned_connection_duration": 10
}
],
"queue_durations": [
{
"id": 41234,
"agent_id": 5,
"queue_duration": 22,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"transfer": 0,
"transfer_id": null,
"transfer_cold": 0,
"started_at": "2016-03-02T23:23:56.000Z",
"ended_at": "2016-03-02T23:24:08.000Z",
"service_level_abandon_time_threshold": 10,
"service_level_event": "not_in_sla",
"service_level_target_percent": 90,
"service_level_target_time": 60
}
]
"videos": [],
"transfers": [],
"participants": [],
"virtual_agent": null,
"virtual_agent_deflected_escalations": [],
"virtual_agent_handle_durations": []
},
{
"id": 2,
"lang": "en",
"chat_type": "in-app",
"status": "finished",
"created_at": "2016-03-02T23:24:05.000Z",
"assigned_at": "2016-03-02T23:24:08.000Z",
"ends_at": "2016-03-02T23:24:42.000Z",
"updated_at": "2016-03-02T23:24:42.000Z",
"first_msg_sent_at": null,
"last_msg_sent_at": null,
"wait_duration": 12,
"queue_duration": 12,
"chat_duration": 34,
"verified": false,
"rating": 2,
"has_feedback": false,
"out_ticket_id": "214",
"out_ticket_url": null,
"fail_reason": null,
"message_count": 0,
"average_response_time": 0,
"longest_response_time": 0,
"selected_menu": null,
"menu_path": null,
"agent_info": null,
"end_user": {
"id": 1,
"identifier": "Death Star Carpentry",
"out_contact_id": "360949501087"
},
"photos": [],
"videos": [],
"transfers": [],
"participants": [],
"handle_durations": [
{
"id": 30001,
"agent_id": 4,
"acw_duration": 0,
"chat_duration": 34,
"menu_path_id": 11,
"menu_path": "Deathstar/Shipping",
"lang": "en",
"transfer": 0,
"transfer_id": null,
"started_at": "2016-03-02T23:24:08.000Z",
"ended_at": "2016-03-02T23:24:42.000Z",
"response_count": 11,
"response_time_total": 259,
"response_time_max": 29,
"response_time_avg": 24,
"assigned_connection_duration": 10
}
],
"queue_durations": [
{
"id": 41234,
"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-03-02T23:23:56.000Z",
"ended_at": "2016-03-02T23:24:08.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_reason": "by_end_user_message",
"escalated_at": "2016-03-02T23:23:56.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"
},
"chat_duration": 11,
"escalation_reason": "by_end_user_message",
"response_count": 11,
"response_time_total": 34,
"response_time_max": 4,
"response_time_avg": 3,
"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-03-02T23:23:16.000Z",
"ended_at": "2016-03-02T23:23:56.000Z"
}
]
}
]
Codice di stato: 200