接口功能:AX 号码的自动绑定接口,需要传入 a 号码,会自动从号码库中选取虚拟小号并进行绑定
请求方向:第三方应用平台 → 小号平台(服务端)。
请求方法:POST
请求 URI:{BaseUrl}/virtual/axAutoBind
请求消息体:
参数名 | 类型 | 最大长度 | 是否可选 | 解 释 |
---|---|---|---|---|
aparty | String | 15 | 必选 | A 号码,可以是手机号码,也可以是固定电话,固定电话需要加区号,区号前面无需加 0 |
maxduration | Int | 11 | 可选 | 最大通话时长,单位为分钟,到达指定的通话时长会挂断通话,0 代表不限制通话时长,最大值为 1440 |
region_code | String | 4 | 可选 | 规定虚拟小号的所属区域 |
display_call | String | 1 | 可选 | 是否显示虚拟号, 默认显示虚拟号,可选值 0 或者 1,1 代表显示真实号码,0 代表显示虚拟号。开启显示真实号码可能会存在无法接通的问题,透传号码的方式也是被禁止的。如非必要,请勿开启。 |
recording | String | 1 | 可选 | 可选值 0 或 1, 1 代表录音,0 代表不录音 |
recordhinttone | String | 32 | 可选 | 录音前播放的提示音 |
callerhinttone | String | 32 | 可选 | A 拨通 X 通话前等待音(可使用foralice.wav, 或者自己提供文件审核) |
calleehinttone | String | 32 | 可选 | B 拨通 X 通话前等待音(可使用foralice.wav, 或者自己提供文件审核) |
enddate | String | 10 | 可选 | 绑定关系解除的时间,格式为 unix 时间戳, 如1651819022 |
userdata | String | 200 | 可选 | 用户自定义的数据 |
time | String | 10 | 必选 | Unix 时间戳,用来限制接口连接的有效期,有效期为 10 分钟 |
appkey | String | 32 | 必选 | 应用的 appkey |
sign | String | 32 | 必选 | 生成的加密校验码 |
响应消息:
{
"success": true,
"code": 200,
"msg": "",
"data": {
"number": "86171903200xx",
"bindid": "",
"region_code": "0755"
}
}
// number:代表虚拟小号
// bindid:表示绑定的id
// region_code:代表区号
错误码说明:
错误码 | 描述 |
---|---|
E301101 | A 号码格式错误,固话请加区号(区号去掉前面的 0) |
E301102 | enddate 的时间请大于现在 |
E301103 | 未获取到可用的号码 |
E301104 | 检测到为重复请求,已过滤 |
E301105 | 号码绑定成功, 但数据处理失败 |
E301106 | 该虚拟号已存在其他绑定关系,请解绑后再重新绑定 |
E301107 | 未知错误, AX 绑定号码失败 |
文档更新时间: 2022-12-08 08:27 作者:admin