文档

BindAxg - AXG隐私号-号码绑定

添加AXG号码的绑定关系。AXG产品是针对有用户分级需求、限制呼叫范围、限制抢单等场景的客户需求提供的号码隐私保护解决方案,其中G代表一个号码组,可以根据需要添加号码。

接口说明

  • 在调用此接口前,请确保您已在控制台购买隐私号

  • 您可以使用此接口给 AXG 隐私号绑定号码,也可以在控制台号码管理页面给 AXG 隐私号绑定号码。

  • AXG 隐私号,绑定号码前建议您先明确业务场景中的 A 角色、G 角色。例如:在招聘平台中,A 是应聘者,G 是招聘团队。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

号码池 Key。

在号码隐私保护控制台,号码池管理页面获取号码池 Key

FC10000012345****
PhoneNoAstring

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

139****0000
GroupIdstring

AXG 中的 G 组 ID,即 GID。

在号码隐私保护控制台,号码池管理页面筛选出 AXG 隐私号,并单击G 号码组管理即可查看所有 G 号码组的 GID。

说明 G 号码组中必须有一个及以上的电话号码。
200001234****
PhoneNoBstring

AXG 隐私号的 B 号码。

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

说明
  • A 号码拨打 X 号码时,默认会转接到 B 号码,如 B 号码未设置,则无法接通。
  • A 号码拨打 X 号码时,A 号码回拨模式默认模式时,才会转接到 B 号码,若不是默认模式,则无法接通。
  • 如需修改 A 号码回拨模式,在号码池管理>筛选AXG 隐私号>号池管理>A 号码回拨模式>调整配置修改。
  • 如需更新 B 号码,请调用 UpdateSubscription 接口更新。
  • 138****0000
    PhoneNoXstring

    AXG 隐私号的 X 号码。

    X 号码是您在控制台已购买的隐私号

    说明 如果未指定 X 号码时,将根据参数 ExpectCity 从指定号码池中随机指定一个号码作为 X 号码。
    139****1111
    Expirationstring

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

    说明 必须晚于当前时间 1 分钟以上。
    2019-09-05 12:00:00
    ExpectCitystring

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

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

    是否需要针对该绑定关系产生的所有通话录制通话录音。

    true
    OutIdstring

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

    abcdef
    OutOrderIdstring

    外部业务 ID。

    abcdef
    CallDisplayTypeinteger

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

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

    设置 AXG 隐私号在号码绑定后,拨打 X 号码的企业彩铃。

    此参数请填写铃音字段彩铃编码

    铃音字段取值:

    • AXG 中,A 号码打 X 的铃音设置(有回拨号码):AXGRing_AB
    • AXG 中,A 号码打 X 的铃音设置(无回拨号码):AXGRing_A
    • AXG 中,G 组号码打 X 的铃音设置:AXGRing_G

    彩铃编码

    在号码隐私保护控制台企业彩铃管理页面获取企业彩铃编码。

    填写示例

    如设置 G 组号码打 X 的铃音,填写:"AXGRing_G": "1000****1"。

    说明 企业彩铃优先使用绑定级别设置的彩铃,如果未设置或设置未生效,则会使用号码池级别的彩铃音。
    {"AXGRing_AB":"1000****1","AXGRing_A":"1000****2","AXGRing_G":"1000****3"}
    ASRStatusboolean

    ASR 状态。取值:

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

    ASR 模型 ID。取值:

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

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

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

    9b4afe3d224e4fa3bf963697113e2f77
    CallRestrictstring

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

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

    返回参数

    名称类型描述示例值
    object

    返回数据。

    Codestring

    请求状态码。

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

    状态码的描述。

    OK
    RequestIdstring

    请求 ID。

    F655A8D5-B967-440B-8683-DAD6FF8DE990
    SecretBindDTOobject

    绑定成功后返回的结构体。

    Extensionstring

    分机号码。

    说明 接口 BindAxg 不涉及分机号码,请忽略该返回参数。
    130
    SubsIdstring

    绑定关系 ID。

    1************3
    SecretNostring

    隐私号码,即 X 号码。

    139****1111

    示例

    正常返回示例

    JSON格式

    {
      "Code": "OK",
      "Message": "OK",
      "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990",
      "SecretBindDTO": {
        "Extension": "130",
        "SubsId": "1************3",
        "SecretNo": "139****1111"
      }
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-03-16API 内部配置变更,不影响调用看变更集
    变更项变更内容
    API 内部配置变更,不影响调用
    • 本页导读 (1)