所謂的「活動」是指外撥自動撥號功能，可依序聯絡聯絡人清單中的對象、發起外撥電話，並將每位聯絡人轉接給可用的服務專員。廣告活動端點可存取廣告活動相關資料，並擷取廣告活動和聯絡人物件。
廣告活動物件：代表平台中的單一廣告活動
聯絡人物件：代表特定廣告活動中的個別廣告活動聯絡人
請參閱下列模型，判斷哪些欄位可能含有 PII：
[
{
"campaign_type" : "default",
"id" : 67,
"external_campaign_id" : null,
"max_abandonment_percent" : 3,
"max_redial_count" : 3,
"mode" : "preview",
"name" : "string",
"overdial_adjustment_multiplier" : 1,
"queue" : {
"deleted" : false,
"hidden" : false,
"id" : 60,
"menu_type" : "ivr_menu",
"name" : "string",
"output_msg" : null,
"parent_id" : 59,
"position" : 4
},
"redial_interval_minutes" : 120,
"status" : "dialing",
"target_number_to_process" : 1000,
"created_at" : "2023-04-01T23:23:43.000Z",
"starts_at" : "2023-04-01T23:28:08.000Z",
"ends_at" : null,
"updated_at" : "2023-04-01T23:28:08.000Z",
"contact_stats" : {
"Abandoned by Contact" : 0,
"Abandoned by Dialer" : 0,
"Average Redials per Number" : 0,
"Carrier Error" : 0,
"Completed" : 50,
"Connected" : 0,
"Contacts" : 1000,
"Dialer General Error" : 0,
"Dialing" : 0,
"Do Not Call" : 0,
"Finished" : 40,
"Invalid Number or Name" : 0,
"Invalid outbound number" : 0,
"Not Picked Up" : 0,
"Not Reached to Contact" : 0,
"Not reached" : 10,
"Not yet reached" : 960,
"Queued" : 0,
"Reached" : 0,
"Redial Scheduled" : 0,
"Redials" : 0,
"Remaining" : 950,
"Running" : 0,
"Skipped" : 0,
"Skipped & Closed" : 10,
"Transferred" : 0,
"Transferred and Finished" : 0,
"Upcoming" : 950,
"Voicemail Hung Up" : 0
}
}
]
廣告活動狀態欄位
status 欄位可以處於下列任一狀態：
| 行銷活動狀態 | 說明 |
|---|---|
| 已建立 | 已建立廣告活動，但尚未開始撥出電話。 |
| 已開始 | 廣告活動已開始撥出電話，但尚未開始撥號 (對話)。 |
| 撥號 | 廣告活動正在撥打外撥電話。 |
| 暫停 | 廣告活動已由代理商或管理員暫停。 |
| 已完成 | 廣告活動已完成所有通話。 |
廣告活動模式欄位
mode 欄位可設為下列任一值：
| 廣告活動模式 | 說明 |
|---|---|
| 預覽 | 在預覽版廣告活動中，服務專員會與使用者建立連線，或選擇要對特定聯絡人採取哪些動作。在預覽版廣告活動中，聯絡人或使用者是已知的。 |
| 預測式 | 如果是預測型廣告活動，系統會將服務專員連線至預訂通話。我們會為該通電話啟用機器偵測功能，判斷外撥電話的回覆來自真人還是機器 (例如語音信箱)，並只將真人連線給服務專員。 |
| 進步主義 | 如果是漸進式廣告活動，撥號器會先連線至第一位可用的服務專員。連線後，撥號器會撥打電話，並將第一個可用的聯絡人 (尚未針對特定廣告活動撥打電話的聯絡人) 交給專員。 |
廣告活動類型欄位
campaign_type 欄位可設為下列任一值：
| 廣告活動類型 | 說明 |
|---|---|
| 預設 | 宣傳活動聯絡人來自使用者上傳的 CSV 檔案。 |
| external_list | 宣傳活動聯絡人來自外部或第三方服務。 |
廣告活動清單
端點：
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns
更多要求/回應範例：
要求範例：廣告活動清單
查詢：無
內文：無
回應範例：廣告活動清單
[
{
"campaign_type": "default",
"id": 67,
"external_campaign_id": null,
"max_abandonment_percent": 3,
"max_redial_count": 3,
"mode": "preview",
"name": "string",
"overdial_adjustment_multiplier": 1,
"queue": {
"deleted": false,
"hidden": false,
"id": 60,
"menu_type": "ivr_menu",
"name": "string",
"output_msg": null,
"parent_id": 59,
"position": 4
},
"redial_interval_minutes": 120,
"status": "dialing",
"target_number_to_process": 1000,
"created_at": "2023-04-01T23:23:43.000Z",
"starts_at": "2023-04-01T23:28:08.000Z",
"ends_at": null,
"updated_at": "2023-04-01T23:28:08.000Z",
"contact_stats": {
"Abandoned by Contact": 0,
"Abandoned by Dialer": 0,
"Average Redials per Number": 0,
"Carrier Error": 0,
"Completed": 50,
"Connected": 0,
"Contacts": 1000,
"Dialer General Error": 0,
"Dialing": 0,
"Do Not Call": 0,
"Finished": 40,
"Invalid Number or Name": 0,
"Invalid outbound number": 0,
"Not Picked Up": 0,
"Not Reached to Contact": 0,
"Not reached": 10,
"Not yet reached": 960,
"Queued": 0,
"Reached": 0,
"Redial Scheduled": 0,
"Redials": 0,
"Remaining": 950,
"Running": 0,
"Skipped": 0,
"Skipped & Closed": 10,
"Transferred": 0,
"Transferred and Finished": 0,
"Upcoming": 950,
"Voicemail Hung Up": 0
}
}
]
狀態碼：200
單一廣告活動
端點：
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}
更多要求/回應範例：
要求範例：單一廣告活動
查詢：
| 參數 | 必填 | 資料類型 | 定義 |
|---|---|---|---|
| campaign_id | TRUE | 整數 | 要擷取的廣告活動 ID |
內文：無
回覆範例：單一廣告活動
{
"campaign_type": "default",
"id": 67,
"external_campaign_id": null,
"max_abandonment_percent": 3,
"max_redial_count": 3,
"mode": "preview",
"name": "string",
"overdial_adjustment_multiplier": 1,
"queue": {
"deleted": false,
"hidden": false,
"id": 60,
"menu_type": "ivr_menu",
"name": "string",
"output_msg": null,
"parent_id": 59,
"position": 4
},
"redial_interval_minutes": 120,
"status": "dialing",
"target_number_to_process": 1000,
"created_at": "2023-04-01T23:23:43.000Z",
"starts_at": "2023-04-01T23:28:08.000Z",
"ends_at": null,
"updated_at": "2023-04-01T23:28:08.000Z",
"contact_stats": {
"Abandoned by Contact": 0,
"Abandoned by Dialer": 0,
"Average Redials per Number": 0,
"Carrier Error": 0,
"Completed": 50,
"Connected": 0,
"Contacts": 1000,
"Dialer General Error": 0,
"Dialing": 0,
"Do Not Call": 0,
"Finished": 40,
"Invalid Number or Name": 0,
"Invalid outbound number": 0,
"Not Picked Up": 0,
"Not Reached to Contact": 0,
"Not reached": 10,
"Not yet reached": 960,
"Queued": 0,
"Reached": 0,
"Redial Scheduled": 0,
"Redials": 0,
"Remaining": 950,
"Running": 0,
"Skipped": 0,
"Skipped & Closed": 10,
"Transferred": 0,
"Transferred and Finished": 0,
"Upcoming": 950,
"Voicemail Hung Up": 0
}
}
狀態碼：200
聯絡人清單
| 參數 | 必填 | 資料類型 | 定義 |
|---|---|---|---|
| campaign_id | TRUE | 整數 | 要取得聯絡人的廣告活動 ID |
端點：
Method: GET
Type:
URL: https://{{subdomain}}.{{domain}}/manager/api/v1/outbound_dialer/campaigns/\{campaign_id\}/contacts
更多要求/回應範例：
要求範例：聯絡人清單
查詢：
| 參數 | 必填 | 資料類型 | 定義 |
|---|---|---|---|
| campaign_id | TRUE | 整數 | 要取得聯絡人的廣告活動 ID |
內文：無
回覆範例：聯絡人清單
[
{
"assigned_call_id": 32001,
"assigned_participant_id": 54321,
"campaign_id": 240,
"created_at": "2023-04-01T17:15:38.000Z",
"id": 16312,
"name": "string",
"outbound_number": null,
"priority": null,
"status": "Upcoming",
"unique_id": "string",
"updated_at": "2023-04-01T17:15:38.000Z"
},
{
"assigned_call_id": 32002,
"assigned_participant_id": 54330,
"campaign_id": 240,
"created_at": "2023-04-01T17:15:38.000Z",
"id": 16313,
"name": "string",
"outbound_number": null,
"priority": null,
"status": "Upcoming",
"unique_id": "string",
"updated_at": "2023-04-01T17:15:38.000Z"
}
]
狀態碼：200