文档

BindBatchAxg - 批量添加AXG号码的绑定关系

更新时间:

调试

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

授权信息

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

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

请求参数

名称类型必填描述示例值
PoolKeystring

号码池 Key。请登录号码隐私保护控制台,在号码池管理中查看号码池 Key。

FC2235****
AxgBindListobject []

Axg 绑定列表

PhoneNoAstring

AXG 中的 A 号码。 A 号码可设置为手机号码或固定电话,固定电话需要加区号,区号和号码中间不需要加连字符。

13333333333
GroupIdstring

AXG 中的 G 组 ID,即 GID。 可以通过以下方式查看 GID:

  • 号码隐私保护控制台中的号码池管理页面筛选出 AXG 隐私号,并单击G 号码组管理即可查看所有 G 号码组的 GID。
  • 如果 G 号码组是通过接口 CreateAxgGroup 创建的,则接口的返回参数 GroupID 就是此处的请求参数 GroupID
说明 G 号码组中必须有一个及以上的电话号码。
1234
PhoneNoBstring

AXG 中的 B 号码,A 号码拨打 X 号码时会转接到 B 号码,可通过接口 UpdateSubscription 更新 B 号码。

B 号码可设置为手机号码或固定电话,固定电话需要加区号,区号和号码中间不需要加连字符。

13333333333
PhoneNoXstring

AXG 中的 X 号码。未指定 X 号码时,将根据参数 ExpectCity 从指定号码池中随机指定一个号码作为 X 号码。

说明 X 号码是您绑定号码前在控制台购买的电话号码,用于转接电话。
13333333333
ExpectCitystring

指定城市进行 X 号码的选号。

  • 如果当前号池中没有该城市的可用号码,或未指定此参数,将从当前号码池中随机分配一个其他城市的号码作为 X 号码。
  • 如果配置了严格模式,则不存在符合条件的号码时会提示分配错误。
北京
IsRecordingEnabledboolean

是否需要针对该绑定关系产生的所有通话进行通话录音。取值:

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

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

18223ad447910fd
Expirationstring

绑定关系的过期时间,时间单位精确到秒。

说明 必须晚于当前时间 1 分钟以上。
2022-07-11 01:05:15
OutOrderIdstring

外部业务 ID。

20220824021816883677
CallDisplayTypeinteger

重置绑定关系中的号码显示逻辑。固定取值:1(主被叫显示中间号码 X)。

说明 由于运营商监管限制,呼叫时显示真实号码的设置不生效。
1
RingConfigstring

设置 AXG 绑定级别企业彩铃放音,支持针对该绑定关系中设置,内容包括如下:

  • AXG 中,A 号码打 X 的铃音设置(有回拨号码):AXGRing_AB
  • AXG 中,A 号码打 X 的铃音设置(无回拨号码):AXGRing_A
  • AXG 中,G 组号码打 X 的铃音设置:AXGRing_G
  • 企业彩铃编码:企业彩铃编码可以在管理控制台中查询,具体通过号码隐私保护控制台>号码池管理>企业彩铃管理进行查看、管理,支持上传、删除等操作。
说明 企业彩铃优先使用绑定级别设置的彩铃,如果未设置或设置未生效,则会使用号码池级别的彩铃音。
{\"AXBRing_B\":\"100000002\",\"AXBRing_A\":\"100000001\"}
ASRStatusboolean

ASR 状态。取值:

  • false:关闭(默认值)
  • true:开启
true
ASRModelIdstring

ASR 模型 ID。可以在 ASR 模型管理页面查看 ASR 模型 ID。

7ee372834d2f4cc7ac0d0ab2d0ae1aac
CallRestrictstring

单通呼叫限制的状态。取值:

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

返回参数

名称类型描述示例值
object
Codestring

请求状态码。

  • 返回 OK 代表请求成功。
  • 其他错误码,请参见错误码列表
OK
Messagestring

状态码的描述。

OK
RequestIdstring

阿里云为该请求生成的唯一标识符。

5DCCA8CD-6C0A-50B4-A496-B1D2AB48A1C3
SecretBindListobject []

AXG 绑定结果列表

SecretNostring

隐私号码,即 X 号码。

13333333333
SubsIdstring

绑定关系 ID。

1000085060515673
Extensionstring

分机号。

说明 接口 BindBatchAxg 不涉及分机号码,请忽略。
257
GroupIdstring

AXG 中的 G 组 ID,即 GID。 可以通过以下方式查看 GID:

  • 号码隐私保护控制台中的号码池管理页面筛选出 AXG 隐私号,并单击G 号码组管理即可查看所有 G 号码组的 GID。
  • 如果 G 号码组是通过接口 CreateAxgGroup 创建的,则接口的返回参数 GroupID 就是此处的请求参数 GroupID
1234
PhoneNoAstring

AXG 中的 A 号码。

13333333333
Codestring

单条 AXG 创建绑定的请求状态码。

  • 返回 OK 代表请求成功,
  • isv.INVALID_PARAMETERS 参数非法
  • isv.SYSTEM_LIMIT_CONTROL 触发系统流控
  • isp.SYSTEM_ERROR 网元 RPC 调用异常
isv.INVALID_PARAMETERS
Messagestring

单条 AXG 创建绑定的请求状态码描述。

ringConfig invalid

示例

正常返回示例

JSON格式

{
  "Code": "OK",
  "Message": "OK",
  "RequestId": "5DCCA8CD-6C0A-50B4-A496-B1D2AB48A1C3",
  "SecretBindList": {
    "SecretBind": [
      {
        "SecretNo": "13333333333",
        "SubsId": "1000085060515673",
        "Extension": "257",
        "GroupId": "1234",
        "PhoneNoA": "13333333333",
        "Code": "isv.INVALID_PARAMETERS",
        "Message": "ringConfig invalid"
      }
    ]
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
2023-04-27新增 OpenAPI看变更集
  • 本页导读 (1)