電子郵件端點可存取電子郵件工作階段物件。
以下是電子郵件支援資源的模型。查看模型，判斷哪些欄位可能含有 PII。
[
{
"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"
}
]
}
]
電子郵件
| 參數 | 必填 | 資料類型 | 定義 |
|---|---|---|---|
| sort_column | FALSE | 字串 | 根據回應物件中的任何欄位排序回應。 |
| sort_direction | FALSE | ASC 或 DESC | 註記排序方向，無論是遞增或遞減。 |
| 頁面 | FALSE | 字串 | 搭配「per」使用，註明記錄的頁面。舉例來說，如果 per 設為 200，page 設為 2，則回應會包含記錄 201-400。 |
| / | FALSE | 字串 | 與頁面配對，記錄一頁記錄中會包含多少筆記錄。舉例來說，如果 per 設為 200，page 設為 2，則回應會包含記錄 201-400。 |
| assigned_at[from] | FALSE | 世界標準時間 | 建立「指派時間」欄位的下限。系統會傳回輸入值之後的所有記錄。 |
| assigned_at[to] | FALSE | 世界標準時間 | 為「指派時間」欄位建立上限。傳回的所有記錄都會早於輸入值。 |
| finished_at[from] | FALSE | 世界標準時間 | 為「完成時間」欄位建立下限。系統會傳回輸入值之後的所有記錄。 |
| finished_at[to] | FALSE | 世界標準時間 | 建立「完成時間」欄位的上限。傳回的所有記錄都會早於輸入值。 |
| updated_at[from] | FALSE | 世界標準時間 | 建立更新時間欄位的下限。系統會傳回輸入值之後的所有記錄。 |
| updated_at[to] | FALSE | 世界標準時間 | 建立「更新時間」欄位的上限。傳回的所有記錄都會早於輸入值。 |
| created_at[from] | FALSE | 世界標準時間 | 建立「建立時間」欄位的下限。系統會傳回輸入值之後的所有記錄。 |
| created_at[to] | FALSE | 世界標準時間 | 建立「建立時間」欄位的上限。傳回的所有記錄都會早於輸入值。 |
| id[] | FALSE | Array[String] | 字串陣列。要搜尋及傳回的記錄 ID。 |
| agent_id[] | FALSE | Array[String] | 依代理商 ID 篩選回覆。 |
| end_user_id[] | FALSE | Array[String] | 根據使用者 ID 篩選回應。 |
| email_status[] | FALSE | Array[String] | 根據電子郵件在電子郵件生命週期中的位置傳回記錄。可能的值：unopened、active、paused、resolved、closed、reopened |
| total_thread_numbers[from] | FALSE | 數字 | 建立總執行緒數欄位的下限。系統會傳回輸入值之後的所有記錄。 |
| total_thread_numbers[to] | FALSE | 數字 | 建立總執行緒數欄位的上限。傳回的所有記錄都會早於輸入值。 |
端點：
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/emails
更多要求/回應範例：
要求範例：電子郵件範例
查詢：無
內文：無
回覆範例：電子郵件範例
[
{
"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
}
]
}
]
狀態碼：200