调用BindAxb添加AXB号码的绑定关系_号码隐私保护(PNP)-阿里云帮助中心

添加AXB号码的绑定关系。

接口说明

绑定 AXB 号码前，建议明确您的业务场景中 AXB 设备证书（ProductKey、DeviceName、DeviceSecret）的 A 角色和 B 角色。例如，在打车应用场景中，A 可以是乘客角色，B 是司机角色。

QPS 限制

本接口的单用户 QPS 限制为 5000 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
dypls:BindAxb	Write	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
PoolKey	string	是	号码池 Key。请登录号码隐私保护控制台，在号码池管理中查看号码池 Key。	FC5526*****
PhoneNoA	string	是	AXB 中的 A 号码。 A 号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。	139****0000
PhoneNoB	string	是	AXB 中的 B 号码，A 号码拨打 X 号码时会转接到 B 号码。 B 号码可设置为手机号码或固定电话，固定电话需要加区号，区号和号码中间不需要加连字符。说明如需更新 B 号码，请调用 UpdateSubscription 接口更新。	139****0000
PhoneNoX	string	否	AXB 中的 X 号码。 X 号码是您绑定号码前在号码隐私保护控制台或通过 BuySecretNo 接口购买的电话号码，用于转接电话。如果未指定 X 号码，将根据参数 ExpectCity 从指定号码池中随机指定一个号码作为 X 号码。	139****0000
Expiration	string	是	绑定关系的过期时间。说明必须晚于当前时间 1 分钟以上。	2021-09-05 12:00:00
ExpectCity	string	否	指定城市进行 X 号码的选号。如果当前号码池中没有该城市的可用号码，或未指定此参数，将从当前号码池中随机分配一个其他城市的号码作为 X 号码。如果 X 号码分配模式配置为严格匹配模式，当符合条件的号码不存在时，系统会提示分配错误。	北京
IsRecordingEnabled	boolean	否	是否需要针对该绑定关系产生的所有通话进行通话录音。取值： true：录音。 false：不录音（默认值）。	true
OutId	string	否	外部业务扩展字段，通话记录回执消息中会回传此参数。	abcdef
OutOrderId	string	否	外部业务 ID。	34553330****
CallRestrict	string	否	单通呼叫限制的状态。取值： CONTROL_AX_DISABLE：A 号码无法呼叫 X 号码。 CONTROL_BX_DISABLE：B 号码无法呼叫 X 号码。	CONTROL_AX_DISABLE
CallDisplayType	integer	否	重置绑定关系中的号码显示逻辑。固定取值：1（主被叫显示中间号码 X）。说明由于运营商监管限制，呼叫时显示真实号码的设置不生效。	1
RingConfig	string	否	设置 AXB 绑定关系中的企业彩铃放音编码，内容如下： AXB 中，A 号码打 X 接通前的铃音设置：AXBRing_A AXB 中，B 号码打 X 接通前的铃音设置：AXBRing_B AXB 中，A 号码打 X 接通后的铃音设置：AXBRing_A_PICKUP AXB 中，B 号码打 X 接通后的铃音设置：AXBRing_B_PICKUP 企业彩铃编码：企业彩铃编码可以在管理控制台中查询，具体请登录号码隐私保护控制台，通过号码池管理>企业彩铃管理进行查看，支持上传、删除等操作。说明企业彩铃优先使用绑定级别设置的彩铃，如果未设置或设置未生效，则会使用号码池级别的彩铃音。	{ "AXBRing_B": "1000**1", "AXBRing_A": "1000**1" }
ASRStatus	boolean	否	ASR 状态。取值： false：关闭（默认值）。 true：开启。	false
ASRModelId	string	否	ASR 模型 ID。可以在 ASR 模型管理页面查看 ASR 模型 ID。	1、通用-电话-中文普通话模型7ee372834d2f4cc7ac0d0ab2d0ae1aac 。 2、通用-电话-中文粤语模型 9b4afe3d224e4fa3bf963697113e2f77。 3、通用-电话-地方口音模型 3655a6cb94764145a1f9a38a3c3b3b4b。
CallTimeout	integer	否	顺振时长。单位：秒。取值范围为 5~20。	10
DtmfConfig	string	否	设置 AXB 绑定关系中的 dtmf 按键配置，可配置内容如下： 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	返回数据。
Code	string	请求状态码。返回 OK 代表请求成功。其他错误码，请参见错误码列表。	OK
Message	string	状态码的描述。	OK
RequestId	string	请求 ID。	9297B722-A016-43FB-B51A-E54050D9369D
SecretBindDTO	object	号码绑定成功后返回的结构体。
Extension	string	分机号码。说明接口 BindAxb 不涉及分机号码，请忽略该返回参数。	130
SubsId	string	绑定关系 ID。	1**************3
SecretNo	string	隐私号码，即 X 号码。	139****0000

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": "OK",
  "RequestId": "9297B722-A016-43FB-B51A-E54050D9369D",
  "SecretBindDTO": {
    "Extension": "130",
    "SubsId": "1**************3",
    "SecretNo": "139****0000"
  }
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2023-03-16

API 内部配置变更，不影响调用

看变更集

变更项	变更内容
	API 内部配置变更，不影响调用。