AXB中间号,是将拨打关系限定在一对一关系中,用户A可以通过中间号码X联系到用户B,用户B也可以通过中间号码X联系到用户A。
接口说明
-
在调用此接口前,请确保您已在控制台购买隐私号。
-
您可以使用此接口给 AXB 中间号绑定号码,也可以在控制台号码管理页面给 AXB 中间号绑定 A、B 号码。
-
AXB 中间号,绑定号码前建议您先明确业务场景中的 A 角色和 B 角色。例如:在打车应用场景中,A 是乘客角色,B 是司机角色。
-
AXB 中间号主要应用在 1 对 1 场景下的隐私保护,客户把 A 号码和 B 号码通过号码隐私服务实现绑定关系,A 拨打 X 转接到 B,B 拨打 X 转接到 A;一个 X 号码可以供 200 对绑定关系复用,如 A1XB1、A2XB2、A3XB3......,只要 A、B 用户手机号码不重复,一个 X 号码可同时绑定 200 组手机号码,通话也可以同时进行。
QPS 限制
本接口的单用户 QPS 限制为 5000 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
dypls:BindAxb |
create |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| PoolKey |
string |
否 |
号码池 Key。 说明
在号码隐私保护控制台,号码池管理页面获取号码池 Key。 |
FC10000016848**** |
| PhoneNoA |
string |
是 |
AXB 中间号的 A 号码。 说明
|
139****0000 |
| PhoneNoB |
string |
否 |
AXB 中间号的 B 号码。 说明
|
136****0000 |
| PhoneNoX |
string |
否 |
AXB 中间号的 X 号码。 X 号码是您在控制台已购买的隐私号。 说明
|
171****1893 |
| Expiration |
string |
是 |
号码绑定的过期时间。 说明
|
2021-09-05 12:00:00 |
| ExpectCity |
string |
否 |
指定城市进行 X 号码的选号。 说明
|
北京 |
| IsRecordingEnabled |
boolean |
否 |
是否开启通话录音功能。取值:
说明
开启通话录音功能后,可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费 0.010 元/分钟。 |
false |
| OutId |
string |
否 |
外部业务扩展字段,通话记录回执消息中会回传此参数。 |
abcdef |
| OutOrderId |
string |
否 |
外部业务 ID。 |
34553330**** |
| CallRestrict |
string |
否 |
单次呼叫限制的状态。取值:
|
CONTROL_AX_DISABLE |
| CallDisplayType |
integer |
否 |
重置绑定关系中的号码显示逻辑。固定取值 1,即主叫和被叫显示中间号码 X。 说明
由于运营商监管限制,呼叫时显示真实号码的设置不生效。 |
1 |
| RingConfig |
string |
否 |
彩铃配置,AXB 中间号号码绑定后,拨打 X 号码的企业彩铃;此参数请填写铃音字段和彩铃编码。 铃音字段如下:
彩铃编码:在号码隐私保护控制台企业彩铃管理页面获取企业彩铃编码。 填写示例: 如设置 B 号码拨打 X 接通前的铃音,填写:"AXBRing_B": "1000****1"。 说明
企业彩铃优先使用绑定级别设置的彩铃,如果未设置或设置未生效,则会使用号码池级别的彩铃音。 |
{ "AXBRing_B": "1000****1", "AXBRing_A": "1000****1" } |
| ASRStatus |
boolean |
否 |
是否开启 ASR 服务功能。取值:
说明
开通功能后,可以将通话中的语音转为文本,获取录音文件同时可获取文本内容。可在呼叫记录中下载语音文本。 文本结果按通话分钟计费,ASR 费用 0.060 元/分钟。 |
false |
| ASRModelId |
string |
否 |
ASR 模型 ID。取值:
|
7ee372834d2f4cc7ac0d0ab2d0ae1aac |
| CallTimeout |
integer |
否 |
顺振时长。单位:秒。取值范围为 5~20。 |
10秒 |
| DtmfConfig |
string |
否 |
dtmf 按键配置,设置 AXB 中间号号码绑定时使用,可配置内容如下:
|
{ "endCallIvrPhoneNo":"A", "waitingDtmfTime":10, "maxLoop":3, "step1File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_1.wav", "step2File":"62ab72f8-4750-4234-859e-e8d678c0cad3-flow_tts_test_2.wav", "validKey":"1,2", "waitingEndCall":2 } |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据。 |
||
| Code |
string |
请求状态码。
|
OK |
| Message |
string |
状态码的描述。 |
OK |
| RequestId |
string |
请求 ID。 |
9297B722-A016-43FB-B51A-E54050****** |
| SecretBindDTO |
object |
号码绑定成功后返回的结构体。 |
|
| Extension |
string |
接口 BindAxb 不涉及此参数,请忽略该返回参数。 |
130 |
| SubsId |
string |
号码绑定 ID。 说明
您可以用返回的号码绑定 ID,调用 QuerySubscriptionDetail 接口,查询号码绑定详情。 |
100017838816**** |
| SecretNo |
string |
已购买的隐私号码,即 X 号码。 |
171****1893 |
示例
正常返回示例
JSON格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "9297B722-A016-43FB-B51A-E54050******",
"SecretBindDTO": {
"Extension": "130",
"SubsId": "100017838816****",
"SecretNo": "171****1893"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。