文档

BindAxb - AXB中间号-号码绑定

更新时间:

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

接口说明

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

  • 您可以使用此接口给 AXB 中间号绑定号码,也可以在控制台号码管理页面给 AXB 中间号绑定 A、B 号码。

  • AXB 中间号,绑定号码前建议您先明确业务场景中的 A 角色和 B 角色。例如:在打车应用场景中,A 是乘客角色,B 是司机角色。

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

授权信息

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

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

请求参数

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

号码池 Key。

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

FC10000016848****
PhoneNoAstring

AXB 中间号的 A 号码。

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

说明 如果您的业务需要修改已绑定的号码,可以调用 UpdateSubscription 接口进行修改,控制台可以绑定或解绑号码,暂时不支持修改已绑定的号码。
139****0000
PhoneNoBstring

AXB 中间号的 B 号码。

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

说明 如果您的业务需要修改已绑定的号码,可以调用 UpdateSubscription 接口进行修改,控制台可以绑定或解绑号码,暂时不支持修改已绑定的号码。
136****0000
PhoneNoXstring

AXB 中间号的 X 号码。

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

说明
  • 如果您未填写 X 号码,系统会根据 ExpectCity 参数值从指定号码池中随机选择一个号码作为 X 号码。
  • 如果当前号码池中没有该城市的 X 号码,或未填写 ExpectCity 参数值,系统会从指定号码池中随机分配一个其他城市的号码作为 X 号码。
  • 如果 X 号码分配模式配置为严格匹配模式,默认分配 A 号码所属城市号码,如果该城市无号码,返回绑定号码失败。号码分配模式操作请参见配置号码池
  • 171****1893
    Expirationstring

    号码绑定的过期时间。

    说明 必须晚于当前绑定时间 1 分钟以上,时间精确到秒。
    2021-09-05 12:00:00
    ExpectCitystring

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

    说明
  • 如果当前号码池中没有该城市的 X 号码,或未填写 ExpectCity 参数值,系统会从指定号码池中随机分配一个其他城市的号码作为 X 号码。
  • 如果 X 号码分配模式配置为严格匹配模式,即默认分配 A 号码所属城市号码,如果该城市无号码,返回绑定号码失败。号码分配模式操作请参见配置号码池
  • 北京
    IsRecordingEnabledboolean

    是否开启通话录音功能。取值:

    • true:录音。
    • false:不录音(默认值)。
    说明 开启通话录音功能后,可在呼叫记录中播放和下载语音文件。录音文件按通话分钟计费 0.010 元/分钟。
    false
    OutIdstring

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

    abcdef
    OutOrderIdstring

    外部业务 ID。

    34553330****
    CallRestrictstring

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

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

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

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

    设置 AXB 中间号在号码绑定后,拨打 X 号码的企业彩铃。

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

    填写示例: 如设置 B 号码拨打 X 接通前的铃音,填写:"AXBRing_B": "1000****1"

    铃音字段如下:

    • A 号码拨打 X 接通前的铃音设置:AXBRing_A
    • B 号码拨打 X 接通前的铃音设置:AXBRing_B
    • A 号码拨打 X 接通后的铃音设置:AXBRing_A_PICKUP
    • B 号码拨打 X 接通后的铃音设置:AXBRing_B_PICKUP

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

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

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

    • false:关闭(默认值)。
    • true:开启。
    说明 开通功能后,可以将通话中的语音转为文本,获取录音文件同时可获取文本内容。可在呼叫记录中下载语音文本。 文本结果按通话分钟计费,ASR 费用 0.060 元/分钟。
    false
    ASRModelIdstring

    ASR 模型 ID。取值:

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

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

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

    7ee372834d2f4cc7ac0d0ab2d0ae1aac
    CallTimeoutinteger

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

    10秒
    DtmfConfigstring

    设置 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

    返回数据。

    Codestring

    请求状态码。

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

    状态码的描述。

    OK
    RequestIdstring

    请求 ID。

    9297B722-A016-43FB-B51A-E54050D9369D
    SecretBindDTOobject

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

    Extensionstring

    接口 BindAxb 不涉及此参数,请忽略该返回参数。

    130
    SubsIdstring

    号码绑定 ID。

    您可以用返回的号码绑定 ID,调用 QuerySubscriptionDetail 接口,查询号码绑定详情。

    100017838816****
    SecretNostring

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

    171****1893

    示例

    正常返回示例

    JSON格式

    {
      "Code": "OK",
      "Message": "OK",
      "RequestId": "9297B722-A016-43FB-B51A-E54050D9369D",
      "SecretBindDTO": {
        "Extension": "130",
        "SubsId": "100017838816****",
        "SecretNo": "171****1893"
      }
    }

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2023-03-16API 内部配置变更,不影响调用看变更集
    变更项变更内容
    API 内部配置变更,不影响调用