“广告系列”是指一种外呼自动拨号器功能，可按顺序联系联系人列表中的联系人、发起外呼，并将每个联系人转接到空闲客服人员。广告系列端点可用于访问与广告系列相关的数据，从而检索广告系列和联系人对象。
广告系列对象：表示平台中的单个广告系列
联系人对象：表示特定广告系列中的各个广告系列联系人
请参阅以下模型，确定哪些字段可能包含个人身份信息：
[
{
"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