首页 云呼叫中心 API参考 API目录 预测式外呼 ListCases - 获取预测式外呼名单列表

ListCases - 获取预测式外呼名单列表

调用ListCases获取指定实例下指定ID对应的预测式外呼活动的外呼名单执行详情列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
InstanceIdstring

实例ID。

ccc-test
CampaignIdstring

预测式外呼活动ID。

6badb397-a8b5-40b6-21019d382a09
PhoneNumberstring

按电话号码过滤,不支持模糊匹配,非必填,默认为空。

PageNumberlong

分页序号,范围1-100。

1
PageSizelong

分页大小,范围1-100。

100

返回参数

名称类型描述示例值
object
RequestIdstring

请求ID。

7CC6523B-0E51-1B62-8DA5-6A9831CAE316
Messagestring

响应信息。

HttpStatusCodelong

HTTP状态码。

200
Codestring

响应码。

OK
Dataobject

数据。

PageNumberlong

分页序号,范围1-100。

1
PageSizelong

分页大小,范围1-100。

100
TotalCountlong

总数。

1
Listarray

联系人名单执行详情列表。

object

联系人名单执行详情。

AbandonTypestring

通话被放弃的类型,即未成功接通的原因。

NA
枚举值:
- NA: 未放弃
- IVR: IVR交互阶段
- Ringing: 坐席振铃阶段
- Queuing: 排队阶段
AttemptCountlong

已尝试次数,对该联系人的总呼叫次数。

1
FailureReasonstring

外呼失败原因。

枚举值:
- AbandonedInQueue: 排队放弃
- AbandonedInRing: 振铃放弃
- AbandonedInIVR: IVR放弃
- NoAnswer: 客户未接
- QueuingTimeout: 排队超时
- Reject: 客户拒接
- Voicemail: 转语音邮箱
- QueuingFailed: 转人工失败
- QueuingOverflow: 排队溢出
- AbandonedInVoiceNavigator: 智能导航中放弃
- IVRException: IVR异常
- ForwardToOutsideNumber: 转外线
PhoneNumberstring

电话号码。

1888888****
Statestring

状态。

Connected
枚举值:
- Connected: 联系成功
- Failed: 联系失败
- Executing: 拨打中
- Pending: 待拨打
- Aborted: 已止呼
CaseIdstring

系统生成的联系人ID,客户无需关心。

60ecb1a2-4480-4d01-bede-c5b7655bfadf
CustomVariablesstring

客户自定义变量,格式为JSON对象,对象最多包含10个属性,每个属性的名称和值均由客户自定义,客户在创建预测式外呼活动时可以设置。

{"name":"yy","客戶标签":"tag-yy"}

示例

正常返回示例

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\"}"
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。

阿里云首页 云呼叫中心 相关技术圈