700AXB中间号-号码绑定

更新时间:
复制为 MD 格式

700AXB中间号,是将拨打关系限定在一对一关系中,用户A可以通过700开头的中间号码X联系到用户B,用户B也可以通过700开头的中间号码X联系到用户A。

接口说明

在调用此接口前,请确保您已在控制台购买隐私号。 您可以使用此接口给 700AXB 中间号绑定号码,也可以在控制台号码管理页面给 700AXB 中间号绑定 A、B 号码。 700AXB 中间号,绑定号码前建议您先明确业务场景中的 A 角色和 B 角色。例如:在打车应用场景中,A 是乘客角色,B 是司机角色。

700AXB 中间号主要应用在 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代码示例。

调试

请求参数

请求参数

名称

类型

必填

描述

示例值

PoolKey

string

号码池 Key。

FC2258****

Expiration

string

号码绑定的过期时间。

说明
  • 必须晚于当前绑定时间 1 分钟以上,时间精确到秒。

  • 号码绑定过期时间内,您可随时进行手动解绑。

  • 若您对正在通话中的号码进行解绑,不会影响本次通话。

2021-09-05 12:00:00

TelA

string

用户 A 号码

139****0000

TelB

string

用户 B 号码

136****0000

TelX

string

可选中间号 X。

说明

业务使用方未指定 X 号码时,由应用平台从号码池中指定一个号码作为 X 号码。

700********0000

NeedRecord

boolean

用于表示业务使用方是否需要该号码绑定关系产生的所有通话媒体文件

取值:

  • true:录音。

  • false:不录音(默认值)。

true

RecType

string

录音类型,mp3、wav。

mp3

CallRestrict

string

单通呼叫限制逻辑

取值:

  • CONTROL_AX_DISABLE:A 号码无法呼叫 X 号码。

  • CONTROL_BX_DISABLE:B 号码无法呼叫 X 号码。

CONTROL_AX_DISABLE

Audio

string

放音编码。

  • ACallX_Apre A 呼叫 X 号码时,呼叫接通前,向 A 播放的语音提示放音编码。

  • ACallX_Ain A 呼叫 X 号码时,呼叫接通后,向 A 播放的语音提示放音编码。

  • ACallX_Bin A 呼叫 X 号码时,呼叫接通后,向 B 播放的语音提示放音编码。

  • BCallX_Bpre B 呼叫 X 号码时,呼叫接通前,向 B 播放的语音提示放音编码。

  • BCallX_Ain B 呼叫 X 号码时,呼叫接通后,向 A 播放的语音提示放音编码。

  • BCallX_Bin B 呼叫 X 号码时,呼叫接通后,向 B 播放的语音提示放音编码。

{

"ACallX_Apre":"185"

}

OrderId

string

业务订单编码。

  • 该编码与真实业务订单是一一对应关系,且不可重复

  • 编码支持“.”、“/”等字符分割编码域,编码中不得含有不可显示类字符,如空格符、换行符等。

  • 当业务使用方提交业务订单编码,由应用平台生成工业互联网标识编码时,该字段必选。

说明

OrderId 与 IndustrialId 两个字段按业务情况必选其一

12345678

IndustrialId

string

工业互联网标识编码,与 OrderID 保持一一对应关系。

编码支持“.”、“/”等字符分割编码域,编码中不得含有不可显示类字符,如空格符、换行符等。

当业务使用方自行生成工业互联网标识编码时,该字段必选。

说明

OrderId 与 IndustrialId 两个字段按业务情况必选其一

700.100.1/12345678

OutId

string

外部业务扩展字段,通话记录回执消息中会回传此参数。

abcdef

OutOrderId

string

外部业务 ID。

abcdefgh

NeedAsr

boolean

是否开启 ASR 服务功能。取值:

  • false:关闭(默认值)。

  • true:开启。

false

AsrModelId

string

可选 ASR 模型 ID。取值:

  • 通用-电话-中文普通话模型 ID:7ee372834d2f4cc7ac0d0ab2d0ae1aac

  • 通用-电话-中文粤语模型 ID:9b4afe3d224e4fa3bf963697113e2f77

  • 通用-电话-地方口音模型 ID:3655a6cb94764145a1f9a38a3c3b3b4b

7ee372834d2f4cc7ac0d0ab2d0ae1aac

CallTimeout

long

顺振时长。单位:秒。取值范围为 5~20。

10

DtmfConfig

string

可选 dtmf 按键配置,设置 AXB 中间号-号码绑定时使用,可配置内容如下:

  • endCallIvrPhoneNo:放音对象 A 或 B。

  • waitingDtmfTime:放完第一段音后的最大等待时长,最大时长为 30 秒。

  • maxLoop dtmf:按键不匹配,循环播放第一个放音文件的最大次数,最大循环次数为 5 次。

  • step1File:第一个放音文件名称。

  • step2File:第二个放音文件名称。

  • validKey:合法按键值定义,如:1,2 只允许配置两个有效键值,用","分隔。

  • waitingEndCall:运营商挂机等待时长,最大等待时长为 10 秒。

{

"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

AccessDeniedDetail

string

访问被拒绝详细信息。

0

RequestId

string

请求 ID。

9297B722-A016-43FB-B51A-E54050******

Message

string

描述信息。

OK

Data

object

返回数据。

SecretNo

string

已购买的 700 隐私号码,即 X 号码。

700********0001

SubsId

long

号码绑定 ID。

123*******

Code

string

返回状态码,取值:

  • OK:表示成功。 其他表示失败。

OK

Success

boolean

接口调用是否成功。取值:

  • true:成功。

  • false:失败。

true

错误码

访问错误中心查看更多错误码。