调用ListUnassignedNumbers获取账号下可分配的号码

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListUnassignedNumbers

系统规定参数。取值:ListUnassignedNumbers。

PageNumber Integer 1

分页序号,范围1-100。

PageSize Integer 20

分页大小,范围1-100。

SearchPattern String 010

号码查找pattern,可以基于此参数模糊查找。

InstanceId String ccc-test

呼叫中心实例ID。

返回数据

名称 类型 示例值 描述
Code String OK

响应码。

Data Struct

数据。

List Array of PhoneNumber

号码列表。

Active Boolean true

号码是否可用。

City String 乐山

号码归属地市。

Number String 083xxxx0011

号码。

Province String 四川

号码归属地省。

Usage Boolean true

号码用途。

PageNumber Integer 1

分页序号。

PageSize Integer 20

分页大小。

TotalCount Integer 1

总条目数。

HttpStatusCode Integer 200

HTTP状态码。

Message String

响应信息。

RequestId String BA03159C-E808-4FF1-B27E-A61B6E888D7F

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ListUnassignedNumbers
&InstanceId=ccc-test
&PageNumber=1
&PageSize=20
&SearchPattern=010
&<公共请求参数>

正常返回示例

XML格式

<RequestId>BA03159C-E808-4FF1-B27E-A61B6E888D7F	</RequestId>
<Message>无</Message>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <TotalCount>1</TotalCount>
    <PageSize>20</PageSize>
    <PageNumber>1</PageNumber>
    <List>
        <Usage>true</Usage>
        <Active>true</Active>
        <Number>083xxxx0011	</Number>
        <City>乐山</City>
        <Province>四川</Province>
    </List>
</Data>
<Code>OK</Code>

JSON格式

{
    "RequestId": "BA03159C-E808-4FF1-B27E-A61B6E888D7F",
    "Message": "无",
    "HttpStatusCode": 200,
    "Data": {
        "TotalCount": 1,
        "PageSize": 20,
        "PageNumber": 1,
        "List": {
            "Usage": true,
            "Active": true,
            "Number": "083xxxx0011",
            "City": "乐山",
            "Province": "四川"
        }
    },
    "Code": "OK"
}

错误码

HttpCode 错误码 错误信息 描述
404 NotExists.InstanceId The specified instance %s does not exist. 指定的呼叫中心实例不存在。
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.ResourcePlatform An internal ResourcePlatform service error occurred. %s 内部ResourcePlatform服务错误。
400 Parameter.Blank The parameter %s must not be null or empty. 该参数不能为null值。
400 Parameter.Null The parameter %s may not be null. 该参数不能为null值.

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