文档

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
Statestring

Pending(待拨打)
Executing(拨打中)
Connected(联系成功)
Failed(联系失败)
Aborted(止呼, 取消呼叫)
Forbidden(规则禁止呼叫,比如黑名单)

Pending

返回参数

名称类型描述示例值
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>

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

object

联系人名单执行详情。

AbandonTypestring

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

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

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

1
FailureReasonstring

外呼失败原因。

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

电话号码。

1888888****
Statestring

状态。

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

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

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

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

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

通话被放弃的阶段。

  • IVR(IVR 交互阶段)
  • Queuing(排队阶段)
  • Ringing(坐席振铃阶段)
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"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-11-22OpenAPI 返回结构发生变更查看变更详情