查询号码池列表--语音服务-火山引擎

文档中心

立即注册

导航

查询号码池列表

最近更新时间：2023.08.17 22:03:00首次发布时间：2023.02.28 20:31:39

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

请求方式：POST
接口地址：https://cloud-vms.volcengineapi.com

1. 请求参数

Header

参数	数据类型	是否必填	示例值	描述
X-Date	String	是	20201103T104027Z	鉴权字段。请参考文档中心-火山引擎。
Authorization	String	是	HMAC-SHA256 Credential***	鉴权字段。请参考文档中心-火山引擎。
ServiceName	String	是	vms	服务名称。语音服务的服务名称为`vms`。
Region	String	是	cn-north-1	区域名称。
Content-Type	String	是	application/x-www-form-urlencoded	指定请求消息体的结构化格式。

Query

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

Body

名称	类型	是否必选	示例值	描述
ServiceType	Integer	否	100	服务类型，详见枚举-服务类型
SubServiceType	Integer	否	101	子服务类型，详见枚举-子服务类型
Limit	Integer	否	20	页大小，默认值20
Offset	Integer	否	0	偏移量

2. 返回参数

参数	数据类型	描述
ResponseMetadata	ResponseMetadata	响应公共参数。包含的参数说明请参见 ResponseMetadata。
Result	Result	响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

参数	数据类型	描述
RequestId	String	请求 ID。
Action	String	请求的接口名称。
Version	String	请求的版本号。
Service	String	请求的服务名称。
Region	String	请求的区域。
Error	Error	错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error。

Result

名称	类型	示例值	描述
NumberPoolName	String	我的号码池	号码池名称
NumberPoolNo	String	NP160723630208105344	号码池编号
ServiceType	Integer	100	服务类型，参考枚举-服务类型
ServiceTypeName	String	普通号码	服务类型描述
SubServiceType	Integer	101	子服务类型，参考枚举-子服务类型
SubServiceTypeName	String	语音SIP	子服务类型描述
NumberCount	Integer	0	号码池号码数量
Limit	Integer	1	页大小，默认值20
Offset	Integer	0	偏移量
Total	Integer	32	结果总数

Error

参数	数据类型	描述
Code	String	错误码。
Message	String	错误信息。

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
    }
}