目前该API接口已标记为弃用,推荐使用替代API:CCC(2020-07-01) - ListCustomCallTaggings。
调用ListCustomCallTagging获取指定实例下的呼入号码标记列表。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例 ID。 | ccc-test |
PageNumber | integer | 是 | 分页序号,范围 1-100。 | 1 |
PageSize | integer | 是 | 分页大小,范围 1-100。 | 10 |
SearchPattern | string | 否 | 根据号码或描述进行模糊匹配,非必填,默认为空,为空表示不过滤。 | 1312121**** |
CallTagNameList | string | 否 | 按号码标签名称列表过滤,非必填,默认为空,表示不过滤。格式为 JSON 数组的字符串,数组元素是号码标签名称。 | ["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 | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Parameter.Blank | The parameter %s must not be null or empty. | 该参数不能为null值。 |
400 | Parameter.Maximum | The parameter %s must be less than or equal to %s. | 参数必须小于或等于系统规定的最大值。 |
400 | Parameter.Minimum | The parameter %s must be greater than or equal to %s. | 参数必须大于或等于系统规定的最小值。 |
404 | NotExists.InstanceId | The specified instance %s does not exist. | 指定的呼叫中心实例不存在。 |
500 | InternalService.DB | An internal DB service error occurred. %s | 内部数据服务错误。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2022-02-24 | 新增 OpenAPI | 查看变更详情 |