文档

ListCustomCallTagging - 获取呼入号码标记列表

更新时间:
目前该API接口已标记为弃用,推荐使用替代API:CCC(2020-07-01) - ListCustomCallTaggings

调用ListCustomCallTagging获取指定实例下的呼入号码标记列表。

调试

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

授权信息

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

请求参数

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

实例 ID。

ccc-test
PageNumberinteger

分页序号,范围 1-100。

1
PageSizeinteger

分页大小,范围 1-100。

10
SearchPatternstring

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

1312121****
CallTagNameListstring

按号码标签名称列表过滤,非必填,默认为空,表示不过滤。格式为 JSON 数组的字符串,数组元素是号码标签名称。

["TagA"]

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

BA03159C-E808-4FF1-B27E-A61B6E888D7F
HttpStatusCodeinteger

HTTP 状态码。

200
Codestring

响应码。

OK
Messagestring

响应信息。

Dataobject

数据。

PageNumberinteger

分页序号,范围 1-100。

1
PageSizeinteger

分页大小,范围 1-100。

10
TotalCountinteger

总数。

10
Listobject []

呼入号码标记列表。

InstanceIdstring

实例 ID。

ccc-test
Numberstring

呼入号码标记的号码。

1312121****
Descriptionstring

呼入号码标记的描述。

王先生
Creatorstring

创建者。

agent
UpdateTimestring

最后一次更新时间。

2020-07-05 00:00:00.0
CallTagListobject []

号码标签列表。

InstanceIdstring

实例 ID。

ccc-test
TagNamestring

号码标签名称。

TagA

示例

正常返回示例

JSON格式

{
  "RequestId": "BA03159C-E808-4FF1-B27E-A61B6E888D7F",
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "无",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 10,
    "List": [
      {
        "InstanceId": "ccc-test",
        "Number": "1312121****",
        "Description": "王先生",
        "Creator": "agent",
        "UpdateTime": "2020-07-05 00:00:00.0",
        "CallTagList": [
          {
            "InstanceId": "ccc-test",
            "TagName": "TagA"
          }
        ]
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400Parameter.BlankThe parameter %s must not be null or empty.该参数不能为null值。
400Parameter.MaximumThe parameter %s must be less than or equal to %s.参数必须小于或等于系统规定的最大值。
400Parameter.MinimumThe parameter %s must be greater than or equal to %s.参数必须大于或等于系统规定的最小值。
404NotExists.InstanceIdThe specified instance %s does not exist.指定的呼叫中心实例不存在。
500InternalService.DBAn internal DB service error occurred. %s内部数据服务错误。

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

变更历史

变更时间变更内容概要操作
2022-02-24新增 OpenAPI看变更集
  • 本页导读 (0)
文档反馈