直拨获取中间号

最近更新时间:2020-04-08 09:45:12

1. 接口描述

接口请求域名: npp.tencentcloudapi.com 。

直拨获取中间号(App 使用方发起)

默认接口请求频率限制:1000次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetVirtualNum。
Version String 公共参数,本接口取值:2019-08-23。
Region String 公共参数,本接口不需要传递此参数。
BizAppId String 业务appid
Dst String 被叫号码(号码前加 0086,如 008613631686024)
Src String 主叫号码(号码前加 0086,如 008613631686024),xb 模式下是不用填写,axb 模式下是必选
AccreditList.N Array of String {“accreditList”:[“008613631686024”,”008612345678910”]},主要用于 N-1 场景,号码绑定非共享是独占型,指定了 dst 独占中间号绑定,accreditList 表示这个列表成员可以拨打 dst 绑 定的中间号,默认值为空,表示所有号码都可以拨打独占型中间号绑定,最大集合不允许超过 30 个,仅适用于xb模式
AssignVirtualNum String 指定中间号(格式:008617013541251),如果该中间号已被使用则返回绑定失败。如果不带该字段则由腾讯侧从号码池里自动分配
Record String 是否录音,0表示不录音,1表示录音。默认为不录音,注意如果需要录音回调,通话完成后需要等待一段时间,收到录音回调之后,再解绑中间号。
CityId String 主被叫显号号码归属地,指定该参数说明显号归属该城市,如果没有该城市号码会随机选取一个城市或者后台配置返回107,返回码详见 《腾讯-中间号-城市id.xlsx》
BizId String 应用二级业务 ID,bizId 需保证在该 appId 下全局唯一,最大长度不超过 16 个字节。
MaxAssignTime String 号码最大绑定时间,不填默认为 24 小时,最长绑定时间是168小时,单位秒
StatusFlag String 主叫发起呼叫状态:1
被叫发起呼叫状态:256
主叫响铃状态:2
被叫响铃状态:512
主叫接听状态:4
被叫接听状态:1024
主叫拒绝接听状态:8
被叫拒绝接听状态:2048
主叫正常挂机状态:16
被叫正常挂机状态:4096
主叫呼叫异常:32
被叫呼叫异常:8192

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

3. 输出参数

参数名称 类型 描述
ErrorCode String 错误码
BindId String 绑定 ID,该 ID 全局唯一
注意:此字段可能返回 null,表示取不到有效值。
RefNum String 中间号还剩引用计数,如果计数为 0 会解绑
注意:此字段可能返回 null,表示取不到有效值。
VirtualNum String 中间号
注意:此字段可能返回 null,表示取不到有效值。
Msg String 错误原因
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例1

输入示例

https://xxx.tencentcloudapi.com/?Action=GetVirtualNum
&<公共请求参数>
&BizAppId=xxx
&Src=xxx
&Dst=xxx

输出示例

{
  "Response": {
    "BindId": "xxxx",
    "RefNum": "xxx",
    "ErrorCode": "0",
    "Msg": "",
    "RequestId": "xxx",
    "VirtualNum": "xxx"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码