添加AXB号码的绑定关系。
接口说明
调试
您可以在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 号码的选号。
| 北京 |
IsRecordingEnabled | boolean | 否 | 是否需要针对该绑定关系产生的所有通话进行通话录音。取值:
| true |
OutId | string | 否 | 外部业务扩展字段,通话记录回执消息中会回传此参数。 | abcdef |
OutOrderId | string | 否 | 外部业务 ID。 | 34553330**** |
CallRestrict | string | 否 | 单通呼叫限制的状态。取值:
| CONTROL_AX_DISABLE |
CallDisplayType | integer | 否 | 重置绑定关系中的号码显示逻辑。固定取值:1(主被叫显示中间号码 X)。 说明
由于运营商监管限制,呼叫时显示真实号码的设置不生效。
| 1 |
RingConfig | string | 否 | 设置 AXB 绑定关系中的企业彩铃放音编码,内容如下:
企业彩铃编码:企业彩铃编码可以在管理控制台中查询,具体请登录号码隐私保护控制台,通过号码池管理>企业彩铃管理进行查看,支持上传、删除等操作。 说明
企业彩铃优先使用绑定级别设置的彩铃,如果未设置或设置未生效,则会使用号码池级别的彩铃音。
| { "AXBRing_B": "1000****1", "AXBRing_A": "1000****1" } |
ASRStatus | boolean | 否 | ASR 状态。取值:
| 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", "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": "1**************3",
"SecretNo": "139****0000"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||
---|---|---|---|---|
2023-03-16 | API 内部配置变更,不影响调用 | 看变更集 | ||
|