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

AXYB中YB绑定

最近更新时间：2023.11.08 18:12:50

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

我的收藏

通过该接口创建AXYB中的YB绑定关系。

1. 接口说明

  • 请求方式：POST

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

2. 请求参数
参数数据类型是否必填示例值描述
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

参数数据类型是否必填示例值描述

Action

String

是

BindYBForAXYB

接口名称。该接口固定值为BindYBForAXYB。

VersionString是2022-01-01接口版本。语音服务默认接口版本为2022-01-01。

Body

参数数据类型是否必填示例值描述
ParentSubIdString是S160817372431596661父级关系绑定ID
PhoneNoBString是13700000001B号码，可设置为手机号码或固定电话。固定电话需要加区号，区号和号码中间不需要加连字符，例如：02131075869
PhoneNoYString否13700000002Y号码
NumberPoolNoString是NP160084061100694433Y号码所在的号码池编号
EnableDurationInteger是180有效时长（单位秒）
AudioRecordFlagInteger否1是否需要录音 0：关闭，1 : 开启（默认开启）

CityCode

String

否

010

选号指定城市；
选号优先级：
CityCode > CityCodeByPhoneNo（如果传B号码，则按B号码所在城市选号，如果不传B号码，则按A号码所在城市选号）> DegradeCityList 降级城市（城市Code详见链接）选号指定城市；

CityCodeByPhoneNo

String

否

A

根据哪个号码所在的城市选号（A：A号码所在城市，B：B号码所在城市）（默认A）

DegradeCityList

List

否

010,0531

降级城市列表，当指定城市选不到号时将会按降级城市进行选号；若希望按照省会城市降级，需要在降级列表中加入"PNPC"代表省会城市降级。例: ("PNPC","010","021")。
最多支持设置5个降级城市；
城市Code详见链接

UserDataString否用户拓展参数，最大长度为2048
RandomFlagInteger否1是否使用随机选号 0：关闭（默认关闭），1 : 开启。

注：PhoneNoY不传或为空时，系统会根据CityCode，CityCodByPhoneNo，DegradeCityList等参数进行选号。

3. 返回参数
参数数据类型描述
ResponseMetadataResponseMetadata响应公共参数。包含的参数说明请参见 ResponseMetadata。
ResultResult响应业务参数。包含的参数说明请参见 Result。

ResponseMetadata

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

Result

参数数据类型示例值描述
SubIdStringS160817372431596661绑定关系ID
PhoneNoYString17000000000Y号码
StatusInteger1绑定关系状态（0 已解绑，1 已绑定，2 绑定异常）

Error

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

请求示例

curl --location --request POST 'https://cloud-vms.volcengineapi.com/?Action=BindYBForAXYB&Version=2022-01-01' \
--header 'ServiceName: vms' \
--header 'Region: cn-north-1' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'X-Date: 20201103T104027Z' \
--header 'Authorization: HMAC-SHA256 Credential=***' \
--data-urlencode 'NumberPoolNo=NP16619143800000' \
--data-urlencode 'ParentSubId=S16722126795817210000' \
--data-urlencode 'PhoneNoB=1879000000' \
--data-urlencode 'EnableDuration=360' \
--data-urlencode 'AudioRecordFlag=1' \
--data-urlencode 'CityCode=010'

返回示例

  • 正确返回示例
{
    "ResponseMetadata": {
        "RequestId": "20221228153901ED22B876F8C8F148BCC8",
        "Action": "BindYBForAXYB",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1"
    },
    "Result": {
        "SubId": "S16722126795817211a93e00007624",
        "Status": 1,
        "PhoneNoY": "18700000000"
    }
}
  • 错误返回示例
{
    "ResponseMetadata": {
        "RequestId": "202212281541242D62843DA26CF61A64A0",
        "Action": "BindYBForAXYB",
        "Version": "2022-01-01",
        "Service": "vms",
        "Region": "cn-north-1",
        "Error": {
            "Code": "IllegalArgument",
            "Message": "EnableDuration must greater than 1min"
        }
    }
}