You need to enable JavaScript to run this app.
导航

按城市选择号码

最近更新时间2023.08.17 22:03:30

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

当用户使用语音SIP服务时,如没有自研选择哪些号码进行呼叫的能力;可调用按城市选择号码接口,选择号码。
当指定城市选号失败时,支持指定降级城市进行降级选号。
城市code详见:链接

例如:
指定山东的号码,降级城市为:北京、上海、广州、深圳;
当号码池中没有可用的山东号码时,会按降级规则筛选北京是否有可用的号码,如北京仍没有可用号码继续进行降级,如降级到深圳仍无可用号码,选号失败

  • 请求方式:GET

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

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

Authorization

String

HMAC-SHA256 Credential***

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

ServiceNameStringvms服务名称。语音服务是vms
RegionStringcn-north-1区域名称,固定值cn-north-1

Content-Type

String

application/x-www-form-urlencoded

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

Query

参数数据类型是否必填示例值描述
ActionStringSelectNumber接口名称。该接口固定值为SelectNumber。
VersionString2022-01-01接口版本。该接口版本为2022-01-01
NumberPoolNoStringNP160102116501911493号码池编号
CityCodeString010城市Code,详见链接

NumberType

Integer

1

号码类型
0 固话,1手机

DegradeCityList

List

['021','022','023','024','025','026']

降级城市列表,最多支持设置5个降级城市。城市code详见:链接

NumberCountInteger选号数量
BindNumberListList有绑定关系的号码
SelectTypeInteger选号方式枚举
CandidateNumberListList候选号码队列
2. 返回参数
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。包含的参数说明请参见 ResponseMetadata。
ResultResult响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

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

Result

号码列表

Error

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

请求示例

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