直拨获取中间号

最近更新时间:2019-09-05 11:50:49

接口描述

功能:直拨获取中间号(App 使用方发起)
接口地址: https://HOST/201511v3/getVirtualNum?id=xxx
请求方式:POST

注意:

上述接口地址的 ID 值测试时由腾讯统一分配。
所有参数类型都是字符串类型(string)。

参数说明

参数名 要求 备注
appId 必选 xxx,appId 值测试时由腾讯统一分配
requestId 可选 session buffer,字符串最大长度不超过42字节,该 requestId 在后面直拨请求响应和回调中都会原样返回
src 可选 主叫号码(号码前加 0086,如 008613631686024),xb 模式下是不用填写,axb 模式下是必选
dst 必选 被叫号码(号码前加 0086,如 008613631686024)
accreditList 可选 {“accreditList”:[“008613631686024”,”008612345678910”]},主要用于 N-1 场景,号码绑定非共享是独占型,指定了 dst 独占中间号绑定,accreditList 表示这个列表成员可以拨打 dst 绑 定的中间号,默认值为空,表示所有号码都可以拨打独占型中间号绑定,最大集合不允许超过 30 个,仅适用于xb模式
assignVirtualNum 可选 指定中间号(格式:008617013541251),如果该中间号已被使用则返回绑定失败。如果不带该字段则由腾讯侧从号码池里自动分配
record 可选 是否录音,0表示不录音,1表示录音。默认为不录音,注意如果需要录音回调,通话完成后需要等待一段时间,收到录音回调之后,再解绑中间号。
cityId 可选 主被叫显号号码归属地,指定该参数说明显号归属该城市,如果没有该城市号码会随机选取一个城市或者后台配置返回107,返回码详见 《腾讯-中间号-城市id.xlsx》
bizId 可选 应用二级业务 ID,bizId 需保证在该 appId 下全局唯一,最大长度不超过 16 个字节。
maxAssignTime 可选 号码最大绑定时间,不填默认为 24 小时,最长绑定时间是168小时,单位秒
statusFlag 可选 主叫发起呼叫状态:1
被叫发起呼叫状态:256
主叫响铃状态:2
被叫响铃状态:512
主叫接听状态:4
被叫接听状态:1024
主叫拒绝接听状态:8
被叫拒绝接听状态:2048
主叫正常挂机状态:16
被叫正常挂机状态:4096
主叫呼叫异常:32
被叫呼叫异常:8192

例如:
值为 0:表示所有状态不需要推送
值为 4:表示只要推送主叫接听状态
值为 16191:表示所有状态都需要推送(上面所有值和)
statusUrl 可选 请填写statusFlag并设置值,状态回调通知地址,正式环境可以配置默认推送地址
hangupUrl 可选 话单回调通知地址,正式环境可以配置默认推送地址
recordUrl 可选 录单 URL 回调通知地址,正式环境可以配置默认推送地址

返回结果

参考值 描述
0 成功
-1 版本不支持
-2 参数异常
-101 参数 src 或 dst 号码不符合规则
-102 参数 displayNum 号码不符合规则
-103 参数 statusUrl 或 hangupUrl 或 recordUrl 不符合 URL 规范
-106 指定中间号已绑定,指定绑定失败
-107 分配中间号失败,中间号号码资源不足
-108 复用 bindId 及中间号绑定超过最大允许绑定次数
-109 分配中间号失败,主被叫号码绑定太频繁,如 1 小时内号码绑定超过 30 次
-111 accreditList 错误
-401 appId 非法
-402 URL 不匹配
-403 IP 不在白名单
-423 服务器屏蔽此调用(调用方被入侵或者异常操作)
-501 平台处理请求异常(业务做容灾处理)
变量名 类型 说明
virtualNum String 分配的虚拟号
bindId String 双方号码 + 中间号绑定 ID,该 ID 全局唯一
refNum String 分配绑定中间号引用计数
requestId String requestId 原样返回

示例

请求示例

{
    "appId":"65500",
    "requestId":"requessstid",
    "src":"0086135xxxxxxxx",
    "dst":"0086135yyyyyyyy",
    "record":"1",
    "maxAllowTime":"31",
    "statusFlag":"16191",
    "statusUrl":"http://test1111111",
    "hangupUrl":"http://test2222222",
    "recordUrl":"http://test3333333",
    "cityId":"0086"
}

成功:

{
    "errorCode": "0", 
    "virtualNum": "01012345678", 
    "requestId": "vultureli123456", 
    "bindId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

失败:

{
    "errorCode": "-1", 
    "msg": "version not supported"
}