You need to enable JavaScript to run this app.
导航
语音服务
  • 文档首页
    • /
  • 语音服务

查询号码池列表

最近更新时间：2023.08.17 22:03:00

首次发布时间：2023.02.28 20:31:39

我的收藏

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

  • 请求方式：POST

  • 接口地址：https://cloud-vms.volcengineapi.com

1. 请求参数

Header

参数数据类型是否必填示例值描述
X-DateString是20201103T104027Z鉴权字段。请参考文档中心-火山引擎。

Authorization

String

是

HMAC-SHA256 Credential***

鉴权字段。请参考文档中心-火山引擎。

ServiceNameString是vms服务名称。语音服务的服务名称为vms。
RegionString是cn-north-1区域名称。

Content-Type

String

是

application/x-www-form-urlencoded

指定请求消息体的结构化格式。

Query

参数数据类型是否必填示例值描述
ActionString是NumberPoolList接口名称。该接口固定值为NumberPoolList。
VersionString是2022-01-01接口版本。该接口版本为2022-01-01

Body

名称类型是否必选示例值描述
ServiceTypeInteger否100服务类型，详见 枚举-服务类型

SubServiceType

Integer

否

101

子服务类型，详见 枚举-子服务类型

LimitInteger否20页大小，默认值20
OffsetInteger否0偏移量
2. 返回参数
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。包含的参数说明请参见 ResponseMetadata。
ResultResult响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

参数数据类型描述
RequestIdString请求 ID。
ActionString请求的接口名称。
VersionString请求的版本号。
ServiceString请求的服务名称。
RegionString请求的区域。
ErrorError错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error。

Result

名称类型示例值描述
NumberPoolNameString我的号码池号码池名称
NumberPoolNoStringNP160723630208105344号码池编号
ServiceTypeInteger100服务类型，参考 枚举-服务类型
ServiceTypeNameString普通号码服务类型描述
SubServiceTypeInteger101子服务类型，参考 枚举-子服务类型
SubServiceTypeNameString语音SIP子服务类型描述
NumberCountInteger0号码池号码数量
LimitInteger1页大小，默认值20
OffsetInteger0偏移量
TotalInteger32结果总数

Error

参数数据类型描述
CodeString错误码。
MessageString错误信息。
3. 示例

请求示例

curl --location --request POST 'https://cloud-vms.volcengineapi.com' \
--header 'ServiceName: vms' \
--header 'Region: cn-north-1' \
--header 'X-Date: 20201103T104027Z' \
--header 'Authorization: HMAC-SHA256 Credential=***' \
--form 'Action="NumberPoolList"' \
--form 'Version="2022-01-01"' \
--form 'ServiceType="100"' \
--form 'SubServiceType="101"'

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2021052617154601022524310003BB3AFF",
        "Action": "NumberPoolList",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": {
        "Records": [
            {
                "NumberPoolName": "NP001",
                "NumberPoolNo": "NP160646236108104895",
                "ServiceType": 100,
                "ServiceTypeName": "普通号码",
                "SubServiceType": 101,
                "SubServiceTypeName": "语音SIP",
                "NumberCount": 0
            }
        ],
        "Limit": 20,
        "Offset": 0,
        "Total": 1
    }
}