Les points de terminaison de l'e-mail permettent d'accéder aux objets de session de l'e-mail.
Voici un modèle de ressource d'assistance par e-mail. Examinez le modèle pour déterminer quels champs peuvent contenir des informations permettant d'identifier personnellement les utilisateurs.
[
{
"id": 1442,
"lang": "en",
"email_status": "paused",
"created_at": "2024-01-30T07:09:48.813Z",
"assigned_at": "2024-01-30T07:09:49.000Z",
"finished_at": "2024-02-29T10:00:11.000Z",
"updated_at": "2024-02-29T10:00:11.948Z",
"queue_duration": 0,
"email_duration": 10207,
"out_ticket_id": null,
"out_ticket_url": null,
"total_thread_numbers": 2,
"selected_menu": {
"id": 0,
"name": "string",
"parent_id": 0,
"position": 0,
"deleted": true,
"hidden": "string",
"menu_type": "email_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", //This may be considered PII
"avatar_url": "string"
},
"end_user": {
"id": 0,
"identifier": "string", //This may be considered PII
"out_contact_id": "string"
},
"email_attachments": [
{
"id": 0,
"file_type": "email_content",
"url": "string" //This may be considered PII
}
],
"email_threads": [
{
"id": 0,
"subject": "string", //This may be considered PII
"attachment_count": 0,
"direction": "string",
"is_read": true,
"is_draft": false,
"created_at": "2023-12-27T09:55:05.546Z",
"updated_at": "2023-12-27T09:55:50.701Z"
},
],
"transfers": [
{
"id": 0,
"status": "transferring",
"created_at": "2024-01-12T19:49:52.896Z",
"updated_at": "2024-01-12T19:55:35.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", //This may be considered PII
"last_name": "string", //This may be considered PII
"first_name": "string", //This may be considered PII
"agent_number": "string", //This may be considered PI
"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", //This may be considered PI
"avatar_url": "string"
}
}
],
"handle_durations": [
{
"agent_id": 0,
"email_duration": 0,
"menu_path_id": 0,
"menu_path": "string",
"lang": "en",
"transfer": false,
"transfer_id": 1,
"assignment_type": "string",
"started_at": "2024-01-10T07:27:14.000Z",
"ended_at": "2024-01-10T07:27:20.000Z",
}
],
"queue_durations": [
{
"agent_id": 0,
"queue_duration": 0,
"menu_path_id": 0,
"menu_path": "string",
"lang": "en",
"started_at": "2024-01-10T07:27:14.000Z",
"ended_at": "2024-01-10T07:27:20.000Z",
"assignment_type": "string",
}
],
"consumer_handle_durations": [
{
"id": 100,
"email_duration": 314,
"attachments_count": 10,
"started_at": "2016-02-19T18:50:08.000Z",
"ended_at": "2016-02-19T18:55:22.000Z"
}
]
}
]
| 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. |
| 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. |
| 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. |
| finished_at[from] | FALSE | Heure en UTC | Crée une limite inférieure pour le champ "Terminé à". Tous les enregistrements renvoyés seront postérieurs à la valeur saisie. |
| finished_at[to] | FALSE | Heure en UTC | Crée une limite supérieure pour le champ "Terminé à". Tous les enregistrements renvoyés seront antérieurs à la valeur saisie. |
| updated_at[from] | FALSE | Heure en UTC | Crée une limite inférieure du 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 "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. |
| id[] | FALSE | Tableau[Chaîne] | Tableau de chaînes. 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. |
| email_status[] | FALSE | Tableau[Chaîne] | Renvoie les enregistrements en fonction de l'étape du cycle de vie de l'e-mail. Valeurs possibles : "non ouvert", "actif", "en veille", "résolu", "fermé", "rouvert" |
| total_thread_numbers[from] | FALSE | Nombre | Crée une limite inférieure pour le champ "Nombre total de threads". Tous les enregistrements renvoyés seront postérieurs à la valeur saisie. |
| total_thread_numbers[to] | FALSE | Nombre | Crée une limite supérieure pour le champ "Nombre total de threads". Tous les enregistrements renvoyés seront antérieurs à la valeur saisie. |
Point de terminaison :
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/emails
Autres exemples de requêtes/réponses :
Exemple de requête : exemple d'e-mail
Requête : aucune
Corps : aucun
Exemple de réponse : exemple d'e-mail
[
{
"id": 1442,
"lang": "en",
"email_status": "paused",
"created_at": "2024-01-30T07:09:48.813Z",
"assigned_at": "2024-01-30T07:09:49.000Z",
"finished_at": "2024-02-29T10:00:11.000Z",
"updated_at": "2024-02-29T10:00:11.948Z",
"queue_duration": 0,
"email_duration": 10207,
"out_ticket_id": null,
"out_ticket_url": null,
"total_thread_numbers": 2,
"selected_menu": {
"id": 16,
"name": "Test Queue",
"parent_id": null,
"position": 3,
"deleted": false,
"menu_type": "email_menu",
"output_msg": null,
"hidden": false
},
"menu_path": {
"items_count": 1,
"name": "Test Queue",
"materialized_path": "16"
},
"agent_info": {
"id": 4,
"agent_number": "Bill",
"name": "Test Agent",
"last_name": "Agent",
"first_name": "Test",
"avatar_url": "https://subdomain.somedomain.com/data_uri_upload20230919-78154-airlnu.png"
},
"end_user": {
"id": 1499,
"identifier": null,
"out_contact_id": null
},
"email_attachments": [],
"email_threads": [
{
"id": 2287,
"subject": "3001-002",
"attachment_count": 0,
"direction": "Outbound",
"is_read": true,
"is_draft": false,
"created_at": "2024-01-30T07:09:48.886Z",
"updated_at": "2024-01-30T07:09:48.886Z"
},
{
"id": 2291,
"subject": "Re: 3001-002",
"attachment_count": 0,
"direction": "Inbound",
"is_read": true,
"is_draft": false,
"created_at": "2024-01-30T09:29:11.019Z",
"updated_at": "2024-01-30T09:30:52.853Z"
},
{
"id": 2292,
"subject": "Re: 3001-002",
"attachment_count": 0,
"direction": "Outbound",
"is_read": true,
"is_draft": false,
"created_at": "2024-01-30T09:31:21.567Z",
"updated_at": "2024-01-30T09:31:21.567Z"
},
{
"id": 2293,
"subject": "Re: 3001-002",
"attachment_count": 2,
"direction": "Inbound",
"is_read": false,
"is_draft": false,
"created_at": "2024-01-30T09:32:57.966Z",
"updated_at": "2024-01-30T09:32:57.966Z"
},
{
"id": 2295,
"subject": "Re: 3001-002",
"attachment_count": 3,
"direction": "Inbound",
"is_read": false,
"is_draft": false,
"created_at": "2024-01-30T09:57:13.536Z",
"updated_at": "2024-01-30T09:57:13.536Z"
},
{
"id": 2296,
"subject": "Re: 3001-002",
"attachment_count": 3,
"direction": "Inbound",
"is_read": false,
"is_draft": false,
"created_at": "2024-01-30T09:59:58.514Z",
"updated_at": "2024-01-30T09:59:58.514Z"
}
],
"transfers": [],
"handle_durations": [
{
"id": 63,
"agent_id": 4,
"email_duration": 0,
"menu_path_id": 5,
"menu_path": "Test Queue",
"lang": "en",
"transfer": false,
"transfer_id": null,
"started_at": "2024-01-30T07:09:48.813Z",
"ended_at": "2024-01-30T07:09:48.886Z",
"assignment_type": "auto",
"status": 1
},
{
"id": 65,
"agent_id": 4,
"email_duration": 130,
"menu_path_id": 5,
"menu_path": "Test Queue",
"lang": "en",
"transfer": false,
"transfer_id": null,
"started_at": "2024-01-30T09:29:11.019Z",
"ended_at": "2024-01-30T09:31:21.567Z",
"assignment_type": "auto",
"status": 1
},
{
"id": 67,
"agent_id": 4,
"email_duration": 1455,
"menu_path_id": 5,
"menu_path": "Test Queue",
"lang": "en",
"transfer": false,
"transfer_id": null,
"started_at": "2024-01-30T09:32:57.966Z",
"ended_at": "2024-01-30T09:57:13.536Z",
"assignment_type": "auto",
"status": 1
},
{
"id": 68,
"agent_id": 4,
"email_duration": 164,
"menu_path_id": 5,
"menu_path": "Test Queue",
"lang": "en",
"transfer": false,
"transfer_id": null,
"started_at": "2024-01-30T09:57:13.536Z",
"ended_at": "2024-01-30T09:59:58.514Z",
"assignment_type": "auto",
"status": 1
},
{
"id": 70,
"agent_id": 4,
"email_duration": 96,
"menu_path_id": 5,
"menu_path": "Test Queue",
"lang": "en",
"transfer": false,
"transfer_id": null,
"started_at": "2024-01-30T09:31:21.567Z",
"ended_at": "2024-01-30T09:32:57.966Z",
"assignment_type": "auto",
"status": 1
},
{
"id": 71,
"agent_id": 4,
"email_duration": 8362,
"menu_path_id": 5,
"menu_path": "Test Queue",
"lang": "en",
"transfer": false,
"transfer_id": null,
"started_at": "2024-01-30T07:09:48.886Z",
"ended_at": "2024-01-30T09:29:11.019Z",
"assignment_type": "auto",
"status": 1
}
],
"queue_durations": [
{
"id": 15,
"agent_id": 4,
"ended_at": "2024-01-30T07:09:49.308Z",
"lang": "en",
"menu_path_id": 5,
"menu_path": "Test Queue",
"queue_duration": 0,
"started_at": "2024-01-30T07:09:49.139Z",
"assignment_type": "auto",
"status": 1
}
],
"consumer_handle_durations": [
{
"id": 1,
"email_duration": 8362,
"started_at": "2024-01-30T07:09:48.886Z",
"ended_at": "2024-01-30T09:29:11.019Z",
"attachments_count": 0
},
{
"id": 2,
"email_duration": 96,
"started_at": "2024-01-30T09:31:21.567Z",
"ended_at": "2024-01-30T09:32:57.966Z",
"attachments_count": 2
},
{
"id": 4,
"email_duration": 1455,
"started_at": "2024-01-30T09:32:57.966Z",
"ended_at": "2024-01-30T09:57:13.536Z",
"attachments_count": 0
},
{
"id": 5,
"email_duration": 164,
"started_at": "2024-01-30T09:57:13.536Z",
"ended_at": "2024-01-30T09:59:58.514Z",
"attachments_count": 3
}
]
},
{
"id": 1443,
"lang": "en",
"email_status": "paused",
"created_at": "2024-01-30T07:25:34.736Z",
"assigned_at": "2024-01-30T07:25:35.000Z",
"finished_at": "2024-02-29T09:40:05.000Z",
"updated_at": "2024-02-29T09:40:05.784Z",
"queue_duration": 0,
"email_duration": 1396,
"out_ticket_id": null,
"out_ticket_url": null,
"total_thread_numbers": 1,
"selected_menu": {
"id": 16,
"name": "Test Queue",
"parent_id": null,
"position": 3,
"deleted": false,
"menu_type": "email_menu",
"output_msg": null,
"hidden": false
},
"menu_path": {
"items_count": 1,
"name": "Test Queue",
"materialized_path": "16"
},
"agent_info": {
"id": 4,
"agent_number": "Bill",
"name": "Test Agent",
"last_name": "Agent",
"first_name": "Test",
"avatar_url": "https://subdomain.somedomain.com/data_uri_upload20230919-78154-airlnu.png"
},
"end_user": {
"id": 1500,
"identifier": null,
"out_contact_id": null
},
"email_attachments": [],
"email_threads": [
{
"id": 2288,
"subject": "3001-003",
"attachment_count": 0,
"direction": "Outbound",
"is_read": true,
"is_draft": false,
"created_at": "2024-01-30T07:25:34.833Z",
"updated_at": "2024-01-30T07:25:34.833Z"
},
{
"id": 2289,
"subject": "Re: 3001-003",
"attachment_count": 0,
"direction": "Inbound",
"is_read": false,
"is_draft": false,
"created_at": "2024-01-30T09:15:43.549Z",
"updated_at": "2024-01-30T09:15:43.549Z"
},
{
"id": 2294,
"subject": "Re: 3001-003",
"attachment_count": 0,
"direction": "Inbound",
"is_read": false,
"is_draft": false,
"created_at": "2024-01-30T09:39:00.127Z",
"updated_at": "2024-01-30T09:39:00.127Z"
}
],
"transfers": [],
"handle_durations": [
{
"id": 64,
"agent_id": 4,
"email_duration": 0,
"menu_path_id": 5,
"menu_path": "Test Queue",
"lang": "en",
"transfer": false,
"transfer_id": null,
"started_at": "2024-01-30T07:25:34.736Z",
"ended_at": "2024-01-30T07:25:34.833Z",
"assignment_type": "auto",
"status": 1
},
{
"id": 66,
"agent_id": 4,
"email_duration": 1396,
"menu_path_id": 5,
"menu_path": "Test Queue",
"lang": "en",
"transfer": false,
"transfer_id": null,
"started_at": "2024-01-30T09:15:43.549Z",
"ended_at": "2024-01-30T09:39:00.127Z",
"assignment_type": "auto",
"status": 1
}
],
"queue_durations": [
{
"id": 16,
"agent_id": 4,
"ended_at": "2024-01-30T07:25:35.503Z",
"lang": "en",
"menu_path_id": 5,
"menu_path": "Test Queue",
"queue_duration": 0,
"started_at": "2024-01-30T07:25:35.280Z",
"assignment_type": "auto",
"status": 1
}
],
"consumer_handle_durations": [
{
"id": 3,
"email_duration": 1396,
"started_at": "2024-01-30T09:15:43.549Z",
"ended_at": "2024-01-30T09:39:00.127Z",
"attachments_count": 0
}
]
}
]
Code d'état : 200