調用ListPhoneNumbers獲取指定實例下的號碼列表。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 實例 ID。 | ccc-test |
SearchPattern | string | 否 | 根據(jù)號碼進行模糊匹配,非必填,默認為空,為空表示不過濾。 | 0833 |
Usage | string | 否 | 號碼的用途,非必填,默認為空,為空表示不過濾。 枚舉值:
| Bidirection |
Active | boolean | 否 | 號碼是否可用,非必填,默認為空,為空表示不過濾。 | true |
PageNumber | integer | 是 | 分頁序號,范圍 1-100。 | 1 |
PageSize | integer | 是 | 分頁大小,范圍 1-100。 | 20 |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"HttpStatusCode": 200,
"RequestId": "BA03159C-E808-4FF1-B27E-A61B6E888D7F",
"Code": "OK",
"Message": "無",
"Data": {
"PageNumber": 1,
"PageSize": 20,
"TotalCount": 1,
"List": [
{
"Active": true,
"CreateTime": "1617958538000",
"UserId": "agent@ccc-test",
"Tags": "M1",
"City": "樂山",
"InstanceId": "ccc-test",
"Usage": "Bidirection",
"ContactFlowName": "默認聯(lián)系流",
"Provider": "alicom",
"Number": "08330011****",
"ContactFlowId": "a3fb6c62-9b49-4942-ae5b-cf2abd4123ek",
"Province": "四川",
"SkillGroups": [
{
"DisplayName": "測試技能組",
"InstanceId": "ccc-test",
"Name": "skillgroup",
"SkillGroupId": "skillgroup@ccc-test"
}
]
}
]
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | Parameter.Enumeration | The parameter %s must be one of the value of enumeration %s. | 該參數(shù)必須為系統(tǒng)限定的枚舉值之一。 |
400 | Parameter.Maximum | The parameter %s must be less than or equal to %s. | 參數(shù)必須小于或等于系統(tǒng)規(guī)定的最大值。 |
400 | Parameter.Minimum | The parameter %s must be greater than or equal to %s. | 參數(shù)必須大于或等于系統(tǒng)規(guī)定的最小值。 |
400 | Parameter.Empty | The parameter %s may not be null or empty. | 該參數(shù)不能為null值或為空字符串。 |
400 | Parameter.Null | The parameter %s may not be null. | 該參數(shù)不能為null值. |
404 | NotExists.InstanceId | The specified instance %s does not exist. | 指定的呼叫中心實例不存在。 |
訪問錯誤中心查看更多錯誤碼。