首页 云呼叫中心 API参考 API目录 外呼控制 ListDoNotCallNumbers - 获取禁止外呼号码列表

ListDoNotCallNumbers - 获取禁止外呼号码列表

调用ListDoNotCallNumbers获取指定实例下指定搜索条件过滤后的禁止外呼号码列表。

调试

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

调试

授权信息

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

请求参数

名称 类型 必填 描述 示例值
InstanceId string

实例ID。

ccc-test
SearchPattern string

根据电话号码或备注进行模糊匹配,非必填,默认为空,为空表示不过滤。

RemarkA
PageNumber integer

分页序号,范围1-100。

1
PageSize integer

分页大小,范围1-100。

10
Scope string

应用范围,包括SYSTEM和INSTANCE,分别对应系统级禁止外呼和客户自定义禁止外呼,SYSTEM是关联实例所属的阿里云主账号的,INSTANCE只和当前实例关联,非必填,默认值INSTANCE。

INSTANCE

返回参数

名称 类型 描述 示例值
object
Code string

响应码。

OK
HttpStatusCode integer

HTTP状态码。

200
Message string

响应信息。

RequestId string

请求ID。

BA03159C-E808-4FF1-B27E-A61B6E888D7F
Data object

数据。

PageNumber integer

分页序号,范围1-100。

1
PageSize integer

分页大小,范围1-100。

10
TotalCount integer

总数。

1
List array

禁止外呼号码列表。

object

禁止外呼号码信息。

Number string

电话号码。

1900000****
Scope string

应用范围。

INSTANCE
Remark string

备注。

测试
CreateTime long

禁止外呼号码配置的创建时间,格式为Unix时间戳,单位毫秒。

1626962425000
Creator string

创建人,创建该记录的坐席的坐席登录名。

agent

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "HttpStatusCode": 200,
  "Message": "无",
  "RequestId": "BA03159C-E808-4FF1-B27E-A61B6E888D7F",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 1,
    "List": [
      {
        "Number": "1900000****",
        "Scope": "INSTANCE",
        "Remark": "测试",
        "CreateTime": 1626962425000,
        "Creator": "agent"
      }
    ]
  }
}

错误码

Http code 错误码 错误信息 描述
400 Parameter.Blank The parameter %s must not be null or empty. 该参数不能为null值。
400 Parameter.Enumeration The parameter %s must be one of the value of enumeration %s. 该参数必须为系统限定的枚举值之一。
400 Parameter.Empty The parameter %s may not be null or empty. 该参数不能为null值或为空字符串。
404 NotExists.InstanceId The specified instance %s does not exist. 指定的呼叫中心实例不存在。

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

变更历史

变更时间 变更内容概要 操作
2022-02-24 新增 OpenAPI
阿里云首页 云呼叫中心 相关技术圈