You need to enable JavaScript to run this app.
导航
NumberPoolList - 查询号码池列表
最近更新时间:2025.07.11 17:27:22首次发布时间:2025.07.11 17:27:22
我的收藏
有用
有用
无用
无用

查询平台上号码池,如不设置服务类型&服务子类型,则查询全部号码池;

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

参数
类型
是否必填
示例值
描述
Action
String

NumberPoolList

要执行的操作,取值:NumberPoolList。

Version
String

2022-01-01

API的版本,取值:2022-01-01。

NumberPoolNo
String

NP1234

号码池编号

ServiceType
Integer

100

服务类型

SubServiceType
Integer

101

子服务类型

Offset
Integer

0

偏移量

NumberPoolName
String

营销号码池

号码池名称

Limit
Integer

10

Limit

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
Total
Integer

2

总数量

Limit
Integer

10

每页大小

Offset
Integer

10

偏移量

Records
Array of Object

号码池信息

请求示例

POST /?Action=NumberPoolList&Version=2022-01-01 HTTP/1.1
Host: https://cloud-vms.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250605T073515Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250605/cn-beijing/vms/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "ServiceType": 100,
  "SubServiceType": 101,
  "Limit": 10,
  "Offset": "FsJqx1Iszb"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2025060515352016120516416522C618",
    "Action": "NumberPoolList",
    "Version": "2022-01-01",
    "Service": "vms",
    "Region": "cn-beijing"
  },
  "Result": {
    "Total": 2,
    "Limit": 10,
    "Offset": 10,
    "Records": [
      {
        "NumberPoolName": "4lzghnuh3",
        "NumberPoolNo": "5",
        "ServiceType": 377,
        "ServiceTypeName": "Q",
        "SubServiceType": 550,
        "SubServiceTypeName": "NuYSfQjL",
        "NumberCount": 639
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
MissingParameter

The required parameter %s is missing.

400
InvalidParameter

The specified parameter %s is invalid.

400
OperationDenied

Operation is denied because the specified resource is in use.

400
QuotaExceeded

%s has exceeded the quota. example: The memory size of the specified disk has exceeded the quota.

400
IdempotentParameterMismatch

Parameters mismatch the previous request with a same ClientToken.

400
DryRunOperation

The request is validated by a dryrun operation.

400
MissingAction

The request is missing an action.

400
InvalidAction

The specified action is invalid.

500
InternalError

The request has failed due to an unknown error.

503
ServiceUnavailable

The request has failed due to a temporary failure of the server.