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

号码申请接口

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

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

我的收藏

  • 请求方式：POST

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

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

Authorization

String

是

HMAC-SHA256 Credential***

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

ServiceNameString是vms服务名称。该接口是vms。
RegionString是cn-north-1区域名称，固定值cn-north-1。

Content-Type

String

是

application/x-www-form-urlencoded

指定请求消息体的结构化格式。语音服务的 Content-Type 为application/x-www-form-urlencoded。

Query

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

Body

名称类型是否必须示例值备注
QualificationNoString是25425资质编号
NumberPoolNoString是sdufdhsj号码池编号
NumberApplicationCityItemListNumberApplicationCityItem是各个城市号码申请列表
NumberPurposeInteger是1号码用途，即使用场景（企业服务&普通营销 1）（当前只有这一个枚举值）
NumberTypeInteger是0号码类型 (手机号 0， 固话 1 )

SubServiceType

Integer

是

101
201

子服务类型

RemarkString否备注

NumberApplicationCityItem

名称类型是否必须示例值备注
NumberCountInteger是1号码数量
CountryIsoCodeString是CN国家（CN：中国）
ProvinceCodeString否省份
CityCodeString是010城市Code，详见 https://www.volcengine.com/docs/6358/67668
2. 返回参数
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。包含的参数说明请参见 ResponseMetadata。
ResultResult响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

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

Result

名称类型示例值描述
ApplyBillIdStringNA0612859102申请单号

Error

参数数据类型描述
CodeString错误码。
MessageString错误信息。
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"
    }
}