接口功能:绑定 axe 模式的号码

请求方向:第三方应用平台 → 小号平台(服务端)。

请求方法:请设置成 POST

请求 URI:{BaseUrl}/virtual/axeAutoBind

请求消息体:

参数名 类型 最大长度 是否可选 解 释
number String 11 可选 指定虚拟号码用于 axe 绑定, 如果没有则会根据区号自动获取号码
extennum String 4 可选 4位数的分机号,如果为空,则随机选项
aparty String 13 必选 A 方号码,为隐私保护的受益方
region_code String 4 可选 根据区号获取指定区域的虚拟小号
display_call String 1 可选 是否显示虚拟号, 默认显示虚拟号,可选值 0 或者 1,1 代表显示真实号码,0 代表显示虚拟号。开启显示真实号码可能会存在无法接通的问题,透传号码的方式也是被禁止的。如非必要,请勿开启。
recording String 1 可选 可选值 0 或 1, 1 代表录音,0 代表不录音
recordhinttone String 32 可选 录音前播放的提示音
callbacktone String 64 可选 A 拨打 x 号码时,如果不存在回呼记录,则播放该提示音。当存在 callbacknum 时,此参数无效
callbacknum String 13 可选 A 拨打 x 号码时,如果不存在回呼记录,则转到指定的号码
enddate String 10 可选 绑定关系解除的时间,格式为 unix 时间戳, 如1651819022
time String 10 必选 Unix 时间戳,用来限制接口连接的有效期,有效期为 10 分钟
appkey String 32 必选 应用的 appkey
sign String 32 必选 生成的加密校验码

响应消息:

{
    "success": true,
    "code": 200,
    "msg": "",
    "data": {
        "number": "86171903200xx",
        "bindid": "",
        "region_code": "0755",
        "extendnum": "0001"
    }
}

// number:代表虚拟小号
// bindid:表示绑定的id
// region_code:代表区号

错误码说明:

错误码 描述
E302001 虚拟小号格式错误
E302002 A 号码格式错误,固话请加区号
E302003 enddate 的时间请大于现在
E302004 检测到为重复请求,已过滤
E302005 未获取到可用的号码
E302006 该绑定关系已存在, 无需绑定
E302007 号码绑定成功, 但数据处理失败
E302008 未知错误, AXE 绑定号码失败
文档更新时间: 2023-02-01 09:07   作者:admin