接口功能:AXB 号码绑定接口
请求方向:第三方应用平台 → 小号平台(服务端)。
请求方法:POST
请求 URI:{BaseUrl}/virtual/axbBind
请求消息体:
参数名 | 类型 | 最大长度 | 是否可选 | 解 释 |
---|---|---|---|---|
number | String | 11 | 必选 | 虚拟小号, 长度为 11 位的手机号码 |
aparty | String | 15 | 必选 | A 号码,可以是手机号码,也可以是固定电话,固定电话需要加区号,区号前面无需加 0 |
bparty | String | 15 | 必选 | B 号码,可以是手机号码,也可以是固定电话,固定电话需要加区号,区号前面无需加 0 |
maxduration | Int | 11 | 可选 | 最大通话时长,单位为分钟,到达指定的通话时长会挂断通话,0 代表不限制通话时长,最大值为 1440 |
lastminvoice | String | 32 | 可选 | 通话最后一分钟的提示音,传提示音的名称(该文件需要先上传审核) |
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 | 可选 | 用户自定义的数据 |
dicrection | Int | 2 | 可选 | 可选值 0, 1, 2,默认为 0, 0 表示可以双向呼叫,1 表示只允许 A 拨打 B, 2 表示只允许 B 拨打 A |
time | String | 10 | 必选 | Unix 时间戳,用来限制接口连接的有效期,有效期为 10 分钟 |
appkey | String | 32 | 必选 | 应用的 appkey |
sign | String | 32 | 必选 | 生成的加密校验码 |
响应消息:
{
"success": true,
"code": 200,
"msg": "绑定成功",
"data": {}
}
错误码说明:
错误码 | 描述 |
---|---|
E300201 | 虚拟小号格式错误,只能是 11 位手机号码 |
E300202 | A 号码格式错误,固话请加区号(区号去掉前面的 0) |
E300203 | 号码格式错误,固话请加区号(区号去掉前面的 0) |
E300204 | 允许的最大通话时长为 1440 分钟 |
E300205 | AXB 绑定, A 号码不能和 B 号码相同 |
E300206 | AXB 绑定, A 号码不能和虚拟号相同 |
E300207 | AXB 绑定, B 号码不能和虚拟号相同 |
E300208 | 保留 |
E300209 | enddate 的时间请大于现在 |
E300210 | 未在您的号码库中查询到该虚拟小号 |
E300211 | 该号码状态为暂停中, 无法使用 |
E300212 | AX 模式号码请勿使用 AXB 绑定接口 |
E300213 | 该号码绑定数量已达 200 组上限 |
E300214 | A 号码或 B 号码与 X 号码的绑定关系已存在 |
E300215 | 检测到为重复请求,已过滤 |
E300216 | 号码绑定成功, 但是绑定关系写入失败 |
E300217 | 该组绑定关系已存在, 请更换 a 号码或者 b 号码 |
E300218 | 未知错误 |
文档更新时间: 2022-08-04 08:52 作者:admin