添加AXG号码的绑定关系。AXG产品是针对有用户分级需求、限制呼叫范围、限制抢单等场景的客户需求提供的号码隐私保护解决方案,其中G代表一个号码组,可以根据需要添加号码。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dypls:BindAxg |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PoolKey |
string |
否 |
号码池 Key。 在号码隐私保护控制台,号码池管理页面获取号码池 Key。 |
FC10000012345**** |
| PhoneNoA |
string |
是 |
AXG 隐私号的 A 号码。 A 号码可设置为手机号码或固定电话,固定电话需要加区号,区号和号码中间不需要加连字符。 |
139****0000 |
| GroupId |
string |
是 |
AXG 中的 G 组 ID,即 GID。 在号码隐私保护控制台,号码池管理页面筛选出 AXG 隐私号,并单击G 号码组管理即可查看所有 G 号码组的 GID。 说明
G 号码组中必须有一个及以上的电话号码。 |
200001234**** |
| PhoneNoB |
string |
否 |
AXG 隐私号的 B 号码。 B 号码可设置为手机号码或固定电话,固定电话需要加区号,区号和号码中间不需要加连字符。 说明
|
138****0000 |
| PhoneNoX |
string |
否 |
AXG 隐私号的 X 号码。 X 号码是您在控制台已购买的隐私号。 说明
如果未指定 X 号码时,将根据参数 ExpectCity 从指定号码池中随机指定一个号码作为 X 号码。 |
139****1111 |
| Expiration |
string |
是 |
绑定关系的过期时间,时间单位精确到秒。 说明
必须晚于当前时间 1 分钟以上。 |
2019-09-05 12:00:00 |
| ExpectCity |
string |
否 |
指定城市进行 X 号码的选号。 说明
|
北京 |
| IsRecordingEnabled |
boolean |
否 |
是否需要针对该绑定关系产生的所有通话录制通话录音。 |
true |
| OutId |
string |
否 |
外部业务扩展字段,通话记录回执消息中会回传此参数。 |
abcdef |
| OutOrderId |
string |
否 |
外部业务 ID。 |
abcdef |
| CallDisplayType |
integer |
否 |
重置绑定关系中的号码显示逻辑。固定取值: 1(主被叫显示中间号码 X)。 说明
由于运营商监管限制,呼叫时显示真实号码的设置不生效。 |
1 |
| RingConfig |
string |
否 |
设置 AXG 隐私号在号码绑定后,拨打 X 号码的企业彩铃。 此参数请填写铃音字段和彩铃编码。 铃音字段取值:
彩铃编码: 在号码隐私保护控制台企业彩铃管理页面获取企业彩铃编码。 填写示例: 如设置 G 组号码打 X 的铃音,填写:"AXGRing_G": "1000****1"。 说明
企业彩铃优先使用绑定级别设置的彩铃,如果未设置或设置未生效,则会使用号码池级别的彩铃音。 |
{"AXGRing_AB":"1000****1","AXGRing_A":"1000****2","AXGRing_G":"1000****3"} |
| ASRStatus |
boolean |
否 |
ASR 状态。取值:
|
false |
| ASRModelId |
string |
否 |
ASR 模型 ID。取值:
|
9b4afe3d224e4fa3bf963697113e2f77 |
| CallRestrict |
string |
否 |
通话呼叫限制的状态。取值:
|
CONTROL_AX_DISABLE |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据。 |
||
| Code |
string |
请求状态码。
|
OK |
| Message |
string |
状态码的描述。 |
OK |
| RequestId |
string |
请求 ID。 |
F655A8D5-B967-440B-8683-DAD6FF8DE990 |
| SecretBindDTO |
object |
绑定成功后返回的结构体。 |
|
| Extension |
string |
分机号码。 说明
接口 BindAxg 不涉及分机号码,请忽略该返回参数。 |
130 |
| SubsId |
string |
绑定关系 ID。 |
1************3 |
| SecretNo |
string |
隐私号码,即 X 号码。 |
139****1111 |
示例
正常返回示例
JSON格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990",
"SecretBindDTO": {
"Extension": "130",
"SubsId": "1************3",
"SecretNo": "139****1111"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。