调用ListCases获取指定实例下指定ID对应的预测式外呼活动的外呼名单执行详情列表。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| InstanceId |
string |
是 |
实例 ID。 |
ccc-test |
| CampaignId |
string |
是 |
预测式外呼活动 ID。 |
6badb397-a8b5-40b6-21019d382a09 |
| PhoneNumber |
string |
否 |
按电话号码过滤，不支持模糊匹配，非必填，默认为空。 |
无 |
| PageNumber |
integer |
是 |
分页序号，范围 1-100。 |
1 |
| PageSize |
integer |
是 |
分页大小，范围 1-100。 |
100 |
| State |
string |
否 |
Pending（待拨打） |
Pending |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| RequestId |
string |
请求 ID。 |
7CC6523B-0E51-1B62-8DA5-6A9831CAE316 |
| Message |
string |
响应信息。 |
无 |
| HttpStatusCode |
integer |
HTTP 状态码。 |
200 |
| Code |
string |
响应码。 |
OK |
| Data |
object |
数据。 |
|
| PageNumber |
integer |
分页序号，范围 1-100。 |
1 |
| PageSize |
integer |
分页大小，范围 1-100。 |
100 |
| TotalCount |
integer |
总数。 |
1 |
| List |
array<object> |
联系人名单执行详情列表。 |
|
|
object |
联系人名单执行详情。 |
||
| AbandonType |
string |
通话被放弃的类型，即未成功接通的原因。 枚举值：
|
NA |
| AttemptCount |
integer |
已尝试次数，对该联系人的总呼叫次数。 |
1 |
| FailureReason |
string |
外呼失败原因。 枚举值：
|
无 |
| PhoneNumber |
string |
电话号码。 |
1888888**** |
| State |
string |
状态。 枚举值：
|
Connected |
| CaseId |
string |
系统生成的联系人 ID，客户无需关心。 |
60ecb1a2-4480-4d01-bede-c5b7655bfadf |
| CustomVariables |
string |
客户自定义变量，格式为 JSON 对象，对象最多包含 10 个属性，每个属性的名称和值均由客户自定义，客户在创建预测式外呼活动时可以设置。 |
{"name":"yy","客戶标签":"tag-yy"} |
| AbandonPhase |
string |
通话被放弃的阶段。
|
Ringing |
示例
正常返回示例
JSON格式
{
"RequestId": "7CC6523B-0E51-1B62-8DA5-6A9831CAE316",
"Message": "无",
"HttpStatusCode": 200,
"Code": "OK",
"Data": {
"PageNumber": 1,
"PageSize": 100,
"TotalCount": 1,
"List": [
{
"AbandonType": "NA",
"AttemptCount": 1,
"FailureReason": "无",
"PhoneNumber": "1888888****",
"State": "Connected",
"CaseId": "60ecb1a2-4480-4d01-bede-c5b7655bfadf",
"CustomVariables": "{\"name\":\"yy\",\"客戶标签\":\"tag-yy\"}",
"AbandonPhase": "Ringing"
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。