当用户使用语音SIP服务时,如没有自研选择哪些号码进行呼叫的能力;可调用按城市选择号码接口,选择号码。
当指定城市选号失败时,支持指定降级城市进行降级选号。
城市code详见:链接
例如:
指定山东的号码,降级城市为:北京、上海、广州、深圳;
当号码池中没有可用的山东号码时,会按降级规则筛选北京是否有可用的号码,如北京仍没有可用号码继续进行降级,如降级到深圳仍无可用号码,选号失败
请求方式:GET
接口地址:https://cloud-vms.volcengineapi.com
参数 | 数据类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
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 为 |
参数 | 数据类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | SelectNumber | 接口名称。该接口固定值为SelectNumber。 |
Version | String | 是 | 2022-01-01 | 接口版本。该接口版本为2022-01-01 |
NumberPoolNo | String | 是 | NP160102116501911493 | 号码池编号 |
CityCode | String | 否 | 010 | 城市Code,详见链接 |
NumberType | Integer | 否 | 1 | 号码类型 |
DegradeCityList | List | 否 | ['021','022','023','024','025','026'] | 降级城市列表,最多支持设置5个降级城市。城市code详见:链接 |
NumberCount | Integer | 否 | 选号数量 | |
BindNumberList | List | 否 | 有绑定关系的号码 | |
SelectType | Integer | 否 | 选号方式枚举 | |
CandidateNumberList | List | 否 | 候选号码队列 |
参数 | 数据类型 | 描述 |
---|---|---|
ResponseMetadata | ResponseMetadata | 响应公共参数。包含的参数说明请参见 ResponseMetadata。 |
Result | Result | 响应业务参数。包含的参数说明请参见 Result。 |
参数 | 数据类型 | 描述 |
---|---|---|
RequestId | String | 请求 ID。 |
Action | String | 请求的接口名称。 |
Version | String | 请求的版本号。 |
Service | String | 请求的服务名称。 |
Region | String | 请求的区域。 |
Error | Error | 错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error。 |
号码列表
参数 | 数据类型 | 描述 |
---|---|---|
Code | String | 错误码。 |
Message | String | 错误信息。 |
curl --location --request GET '[地址]' \ --header 'ServiceName: vms' \ --header 'Region: cn-north-1' \ --header 'X-Date: 20201103T104027Z' \ --header 'Authorization: HMAC-SHA256 Credential=***' \ --form 'Action="SelectNumber"' \ --form 'Version="2022-01-01"' \ --form 'numberPoolNo="NP160102116501911493"' \ --form 'cityCode="010"' \ --form 'numberType="0"' \ --form 'degradeCityList="['\''021'\'','\''022'\'','\''023'\'','\''024'\'','\''025'\'']"'
{ "ResponseMetadata": { "RequestId": "2021011918400501022510703413004E18", "Action": "SelectNumber", "Version": "2022-01-01", "Service": "vms", "Region": "cn-north-1" }, "Result": [ "13718578304" ] }