号码申请接口--语音服务-火山引擎

文档中心

导航

号码申请接口

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

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

1. 请求参数

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

Query

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

Body

名称	类型	是否必须	示例值	备注
QualificationNo	String	是	25425	资质编号
NumberPoolNo	String	是	sdufdhsj	号码池编号
NumberApplicationCityItemList	NumberApplicationCityItem	是		各个城市号码申请列表
NumberPurpose	Integer	是	1	号码用途，即使用场景（企业服务&普通营销 1）（当前只有这一个枚举值）
NumberType	Integer	是	0	号码类型 (手机号 0，固话 1 )
SubServiceType	Integer	是	101 201	子服务类型
Remark	String	否		备注

NumberApplicationCityItem

名称	类型	是否必须	示例值	备注
NumberCount	Integer	是	1	号码数量
CountryIsoCode	String	是	CN	国家（CN：中国）
ProvinceCode	String	否		省份
CityCode	String	是	010	城市Code，详见 https://www.volcengine.com/docs/6358/67668

2. 返回参数

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

ResponseMetadata

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

Result

名称	类型	示例值	描述
ApplyBillId	String	NA0612859102	申请单号

Error

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

3. 示例

请求示例

{
    "NumberPoolNo": "NPxxxxxxxxxx", 
    "QualificationId": 111,
    "NumberApplicationCityItemList": [
        {
            "NumberCount": 10,
            "CountryIsoCode": "CN",
            "ProvinceCode": "010",
            "CityCode": "010"
        },
        {
            "NumberCount": 10,
            "CountryIsoCode": "CN",
            "ProvinceCode": "010",
            "CityCode": "0755"
        }
    ],
    "NumberPurpose": 1,
    "NumberType": 1,
    "SubServiceType": 101,
    "Remark": "xxxx"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2020090912530501022506808000002750",
        "Action": "CreateNumberApplication",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": {
        "ApplyBillId": "NA0612859102"
    }
}

语音服务

Header

Query

Body

ResponseMetadata

Result

Error

请求示例

返回示例