AX&AXB绑定(指定X号码)接口,支持进行AX绑定、AXB绑定;
当需要进行AX绑定时,不设置B号码;
当需要进行AXB绑定时,需设置B号码;
请求方式:POST
接口地址: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 | 是 | BindAXB | 接口名称。该接口固定值为BindAXB 。 |
Version | String | 是 | 2022-01-01 | 接口版本。语音服务默认接口版本为2022-01-01 。 |
参数 | 数据类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
PhoneNoA | String | 是 | 13700000000 | A号码,可设置为手机号码或固定电话。固定电话需要加区号,区号和号码中间不需要加连字符,例如:02131075869 |
PhoneNoB | String | 否 | 13700000001 | B号码,可设置为手机号码或固定电话。固定电话需要加区号,区号和号码中间不需要加连字符,例如:02131075869 |
PhoneNoX | String | 是 | 13700000002 | X号码 |
NumberPoolNo | String | 是 | NP160084061100694433 | X号码所在的号码池编号 |
ExpireTime | Long | 是 | 1608209071 | 过期时间(以秒为单位的时间戳,必须晚于当前时间1分钟以上且早于2038-01-01 00:00:00) |
AudioRecordFlag | Integer | 否 | 1 | 是否需要录音 0:关闭,1 : 开启(默认开启) |
UserData | String | 否 | 用户拓展参数,最大长度为2048 | |
OutId | String | 否 | 45354657 | 外部业务id,最大长度128位 |
VerifyFlag | Integer | 否 | 0 | 是否需要语音验证 0:关闭(默认关闭),1 : 开启 |
CallDisplayType | Integer | 否 | 1 | 是否透传 1:不透传,2:A看见B的真实号码,3:B看见A的真实号码,4:看见对方真实号码 |
VoiceCode | String | 否 | {"axCallerVoiceCode":"aaa","axCalleeVoiceCode":"ccc","bxCallerVoiceCode":"ddd"} | 放音code,JSON格式,放音code值联系火山引擎运营获取。 axCallerVoiceCode:A呼叫X主叫放音,axCalleeVoiceCode:A呼叫X被叫放音,bxCallerVoiceCode:B呼叫X主叫放音,bxCalleeVoiceCode:B呼叫X被叫放音。 |
参数 | 数据类型 | 描述 |
---|---|---|
ResponseMetadata | ResponseMetadata | 响应公共参数。包含的参数说明请参见 ResponseMetadata。 |
Result | Result | 响应业务参数。包含的参数说明请参见 Result。 |
参数 | 数据类型 | 描述 |
---|---|---|
RequestId | String | 请求 ID。 |
Action | String | 请求的接口名称。 |
Version | String | 请求的版本号。 |
Service | String | 请求的服务名称。 |
Region | String | 请求的区域。 |
Error | Error | 错误信息。如果请求没有异常则不会返回错误信息。包含的参数说明请参见 Error。 |
参数 | 数据类型 | 示例值 | 描述 |
---|---|---|---|
SubId | String | S160817372431596661 | 绑定关系ID |
PhoneNoX | String | 17000000000 | X号码 |
Status | Integer | 1 | 绑定关系状态(0 已解绑,1 已绑定,2 绑定异常) |
PhoneNoXCityCode | String | 010 | X号码城市code |
PhoneNoA | String | 17000000000 | A号码 |
PhoneNoACityCode | String | 010 | A号码城市code |
PhoneNoB | String | 17000000001 | B号码 |
PhoneNoBCityCode | String | 010 | B号码城市code |
参数 | 数据类型 | 描述 |
---|---|---|
Code | String | 错误码。 |
Message | String | 错误信息。 |
curl --location --request POST 'https://cloud-vms.volcengineapi.com?Action=BindAXB&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=NP161975111110905039' \ --data-urlencode 'PhoneNoA=17000000002' \ --data-urlencode 'PhoneNoB=17000000001' \ --data-urlencode 'PhoneNoX=17000000000' \ --data-urlencode 'ExpireTime=1669712964' \ --data-urlencode 'AudioRecordFlag=1' \ --data-urlencode 'UserData=test user data' \ --data-urlencode 'CallDisplayType=3'
{ "ResponseMetadata": { "RequestId": "20221227160815C4D8D042BFB030697339", "Action": "BindAXB", "Version": "2022-01-01", "Service": "vms", "Region": "cn-north-1" }, "Result": { "PhoneNoX": "13200000000", "SubId": "S1672128495980xxxx", "Status": 1, "PhoneNoXCityCode": "010", "PhoneNoA": "13904390126", "PhoneNoACityCode": "0431", "PhoneNoB": "17600386056", "PhoneNoBCityCode": "010" } }
{ "ResponseMetadata": { "RequestId": "20221227160730E53860D6B5B123B33749", "Action": "BindAXB", "Version": "2022-01-01", "Service": "vms", "Region": "cn-north-1", "Error": { "Code": "IllegalArgument", "Message": "ExpireTime must be 1 minute later" } } }