Voici un modèle de la ressource de chat. Reportez-vous à ce modèle pour déterminer quels champs peuvent contenir des informations personnelles.
[
{
"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"
}
]
},
Le champ "service_level_event" ne peut prendre que l'une des valeurs suivantes :
| Événement de niveau de service | Description |
|---|---|
| in_sla | L'appel a été pris dans le délai du SLA |
| not_in_sla | L'appel n'a pas reçu de réponse dans le délai de réponse défini |
| exclus | L'appel n'a pas été inclus dans le calcul du SLA (par exemple, s'il a été abandonné). |
Discussions
| Paramètre | Obligatoire | Type de données | Définition |
|---|---|---|---|
| sort_column | FALSE | Chaîne | Trie la réponse en fonction de n'importe quel champ de l'objet de réponse. |
| sort_direction | FALSE | ASC ou DESC | Indique le sens du tri (croissant ou décroissant). |
| page | FALSE | Chaîne | Associé à "par" pour indiquer la page des enregistrements. Par exemple, si "per" est défini sur 200 et "page" sur 2, la réponse contiendra les enregistrements 201 à 400, car la page 1 contiendra les enregistrements 1 à 200. |
| par | FALSE | Chaîne | Associez-le à la page pour indiquer le nombre d'enregistrements à inclure sur une page d'enregistrements. Par exemple, si "per" est défini sur 200 et "page" sur 2, la réponse contiendra les enregistrements 201 à 400, car la page 1 contiendra les enregistrements 1 à 200. |
| assigned_at[from] | FALSE | Heure en UTC | crée une limite inférieure pour le champ "Assigné à". Tous les enregistrements renvoyés seront postérieurs à la valeur saisie. |
| assigned_at[to] | FALSE | Heure en UTC | crée une limite supérieure pour le champ "Assigné à". Tous les enregistrements renvoyés seront antérieurs à la valeur saisie. |
| ends_at[from] | FALSE | Heure en UTC | crée une limite inférieure pour le champ "Fin à". Tous les enregistrements renvoyés seront postérieurs à la valeur saisie. |
| ends_at[to] | FALSE | Heure en UTC | crée une limite supérieure pour le champ "Fin à". Tous les enregistrements renvoyés seront antérieurs à la valeur saisie. |
| updated_at[from] | FALSE | Heure en UTC | crée une limite inférieure pour le champ "Updated at" (Mis à jour le). Tous les enregistrements renvoyés seront postérieurs à la valeur saisie. |
| updated_at[to] | FALSE | Heure en UTC | crée une limite supérieure pour le champ "Updated at" (Mis à jour le). Tous les enregistrements renvoyés seront antérieurs à la valeur saisie. |
| created_at[from] | FALSE | Heure en UTC | crée une limite inférieure pour le champ "created at" (créé le). Tous les enregistrements renvoyés seront postérieurs à la valeur saisie. |
| created_at[to] | FALSE | Heure en UTC | crée une limite supérieure pour le champ "created at" (créé le). Tous les enregistrements renvoyés seront antérieurs à la valeur saisie. |
| rating[from] | FALSE | Nombre de 1 à 5 ou valeur nulle | crée une limite inférieure pour le champ de classification. Tous les enregistrements renvoyés seront postérieurs à la valeur saisie. |
| rating[to] | FALSE | Nombre de 1 à 5 ou valeur nulle | crée une limite supérieure pour le champ de classification. Tous les enregistrements renvoyés seront antérieurs à la valeur saisie. |
| first_msg_sent_at[from] | FALSE | Heure en UTC | crée une limite inférieure pour le premier champ "msg sent at". Tous les enregistrements renvoyés seront postérieurs à la valeur saisie. |
| first_msg_sent_at[to] | FALSE | Heure en UTC | crée une limite supérieure pour le premier champ "msg sent at". Tous les enregistrements renvoyés seront antérieurs à la valeur saisie. |
| last_msg_sent_at[from] | FALSE | Heure en UTC | crée une limite inférieure pour le champ "Dernier message envoyé". Tous les enregistrements renvoyés seront postérieurs à la valeur saisie. |
| last_msg_sent_at[to] | FALSE | Heure en UTC | crée une limite supérieure pour le champ "Dernier message envoyé". Tous les enregistrements renvoyés seront antérieurs à la valeur saisie. |
| chat_duration[from] | FALSE | Nombre | crée une limite inférieure pour le champ de durée du chat. Tous les enregistrements renvoyés seront postérieurs à la valeur saisie. |
| chat_duration[to] | FALSE | Nombre | crée une limite supérieure pour le champ de durée du chat. Tous les enregistrements renvoyés seront antérieurs à la valeur saisie. |
| message_count[from] | FALSE | Nombre | crée une limite inférieure pour le champ du nombre de messages. Tous les enregistrements renvoyés seront postérieurs à la valeur saisie. |
| message_count[to] | FALSE | Nombre | crée une limite supérieure pour le champ du nombre de messages. Tous les enregistrements renvoyés seront antérieurs à la valeur saisie. |
| average_response_time[from] | FALSE | Nombre | crée une limite inférieure pour le champ "Temps de réponse moyen". Tous les enregistrements renvoyés seront postérieurs à la valeur saisie. |
| average_response_time[to] | FALSE | Nombre | crée une limite supérieure pour le champ "Temps de réponse moyen". Tous les enregistrements renvoyés seront antérieurs à la valeur saisie. |
| longest_response_time[from] | FALSE | Nombre | crée une limite inférieure pour le champ du temps de réponse le plus long. Tous les enregistrements renvoyés seront postérieurs à la valeur saisie. |
| longest_response_time[to] | FALSE | Nombre | crée une limite supérieure pour le champ de durée de réponse la plus longue. Tous les enregistrements renvoyés seront antérieurs à la valeur saisie. |
| wait_duration[from] | FALSE | Nombre | crée une limite inférieure pour le champ de durée d'attente. Tous les enregistrements renvoyés seront postérieurs à la valeur saisie. |
| wait_duration[to] | FALSE | Nombre | crée une limite supérieure pour le champ de durée d'attente. Tous les enregistrements renvoyés seront antérieurs à la valeur saisie. |
| id[] | FALSE | Tableau[Chaîne] | Array[Strings]. ID des enregistrements à rechercher et à renvoyer |
| agent_id[] | FALSE | Tableau[Chaîne] | Filtre la réponse par ID d'agent |
| end_user_id[] | FALSE | Tableau[Chaîne] | Filtre la réponse en fonction de l'ID de l'utilisateur final |
| chat_type[] | FALSE | Tableau[Chaîne] | Renvoie les enregistrements en fonction de la façon dont l'utilisateur final a accédé au chat. Valeurs possibles : "Messaging Inbound (App Chat)", "Messaging Inbound (Web Chat)", "Messaging (SMS)" |
| chat_status[] | FALSE | Tableau[Chaîne] | Renvoie des enregistrements en fonction de l'étape du cycle de vie du chat à laquelle se trouve l'utilisateur. Valeurs possibles : queued, assigned, finished, canceled, failed, no_response |
| verified[] | FALSE | Booléen | Renvoie les enregistrements qui ont été validés (True) ou non (False). |
| chat_fail_reason[] | FALSE | Tableau[Chaîne] | Renvoie les enregistrements en fonction de la raison pour laquelle un chat a pu échouer. Valeurs possibles : nothing, unknown, no_response, expired |
La valeur service_level_event peut prendre les valeurs suivantes.
| Événement de niveau de service | Description |
|---|---|
| in_sla | L'appel a été pris dans le délai du SLA |
| not_in_sla | L'appel n'a pas reçu de réponse dans le délai de réponse défini |
| exclus | L'appel n'a pas été inclus dans le calcul du SLA (par exemple, s'il a été abandonné). |
Point de terminaison :
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/chats
Autres exemples de requêtes/réponses :
Exemple de requête : Chats
Requête
| Clé | Valeur | Description |
|---|---|---|
| updated_at[from] | \{updated_at\[from\]\} | Heure en UTC. Crée une limite inférieure pour le champ "Updated at" (Mis à jour le). Tous les enregistrements renvoyés seront postérieurs à la valeur saisie. |
| updated_at[to] | \{updated_at\[to\]\} | Heure en UTC. Crée une limite supérieure pour le champ "Updated at" (Mis à jour le). Tous les enregistrements renvoyés seront antérieurs à la valeur saisie. |
Corps : aucun
Exemple de réponse : Chats
[
{
"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"
}
]
}
]
Code d'état : 200