You can invoke ListCustomCallTagging to obtain the list of inbound number marks under a specified instance.
This API has been deprecated. We recommend migrating to CCC(2020-07-01) - ListCustomCallTaggings for enhanced functionality and continued support. While the deprecated API remains temporarily accessible, no further updates or bug fixes will be provided.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
Instance ID. |
ccc-test |
| PageNumber |
integer |
Yes |
Page number, ranging from 1 to 100. |
1 |
| PageSize |
integer |
Yes |
Page size, ranging from 1 to 100. |
10 |
| SearchPattern |
string |
No |
Perform fuzzy matching based on number or description. This parameter is optional and defaults to empty. An empty value indicates no filtering. |
1312121**** |
| CallTagNameList |
string |
No |
Filter by a list of number tag names. This parameter is optional and defaults to empty, which means no filtering is applied. The format is a JSON array string, where each array element is a number tag name. |
["TagA"] |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
BA03159C-E808-4FF1-B27E-A61B6E888D7F |
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| Code |
string |
Response code. |
OK |
| Message |
string |
The response message. |
无 |
| Data |
object |
The data. |
|
| PageNumber |
integer |
The page number, ranging from 1 to 100. |
1 |
| PageSize |
integer |
The page size, ranging from 1 to 100. |
10 |
| TotalCount |
integer |
The total count. |
10 |
| List |
array<object> |
The list of inbound number marks. |
|
|
array<object> |
The inbound number mark information. |
||
| InstanceId |
string |
The instance ID. |
ccc-test |
| Number |
string |
The number of the inbound number mark. |
1312121**** |
| Description |
string |
The description of the inbound number mark. |
王先生 |
| Creator |
string |
Creator. |
agent |
| UpdateTime |
string |
Last update time. |
2020-07-05 00:00:00.0 |
| CallTagList |
array<object> |
List of number tags. |
|
|
object |
Number tag information. |
||
| InstanceId |
string |
Instance ID. |
ccc-test |
| TagName |
string |
Number tag name. |
TagA |
Examples
Success response
JSON format
{
"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"
}
]
}
]
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | Parameter.Blank | The parameter %s must not be null or empty. | |
| 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. | |
| 500 | InternalService.DB | An internal DB service error occurred. %s | |
| 404 | NotExists.InstanceId | The specified instance %s does not exist. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.