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代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
dypls:BindAxb | create | *全部资源 * |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PoolKey | string | 是 | 号码池 Key。 在号码隐私保护控制台,号码池管理页面获取号码池 Key。 | FC10000016848**** |
PhoneNoA | string | 是 | AXB 中间号的 A 号码。 A 号码可设置为手机号码或固定电话,固定电话请加区号,区号和固定电话之间不需要连字符。 说明
如果您的业务需要修改已绑定的号码,可以调用 UpdateSubscription 接口进行修改,控制台可以绑定或解绑号码,暂时不支持修改已绑定的号码。
| 139****0000 |
PhoneNoB | string | 是 | AXB 中间号的 B 号码。 B 号码可设置为手机号码或固定电话,固定电话请加区号,区号和固定电话中间不需要连字符。 说明
如果您的业务需要修改已绑定的号码,可以调用 UpdateSubscription 接口进行修改,控制台可以绑定或解绑号码,暂时不支持修改已绑定的号码。
| 136****0000 |
PhoneNoX | string | 否 | 171****1893 | |
Expiration | string | 是 | 号码绑定的过期时间。 说明
必须晚于当前绑定时间 1 分钟以上,时间精确到秒。
| 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 | 否 | 设置 AXB 中间号,号码绑定中的 dtmf 按键配置,可配置内容如下:
| { "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 } |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "OK",
"Message": "OK",
"RequestId": "9297B722-A016-43FB-B51A-E54050D9369D",
"SecretBindDTO": {
"Extension": "130",
"SubsId": "100017838816****",
"SecretNo": "171****1893"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-03-16 | API 内部配置变更,不影响调用 | 查看变更详情 |