文档

UpdateSubscription - 修改绑定关系

更新时间:

修改绑定关系。

接口说明

QPS 限制

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

PoolKey 和 ProductType 限制

PoolKey 和 ProductType 参数请至少填写一个,若两个参数都不填,调用接口时会报错。 建议原大于用户填 ProductType 参数,阿里云用户填 PoolKey 参数。

调试

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

调试

授权信息

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

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

请求参数

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

号码池 Key。

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

说明 ProductType 为空时必填。
FC122356****
ProductTypestring

产品类型。取值:

  • AXB_170
  • AXN_170
  • AXN_95
  • AXN_EXTENSION_REUSE
说明
  • 适用于原阿里大于客户,阿里云用户可忽略。
  • PoolKey 为空时必填。
  • AXB_170
    SubsIdstring

    绑定关系 ID。

    请登录号码隐私保护控制台,在号码管理页,在号码详情查看绑定关系 ID,或者在调用 BindAxb 等号码绑定 API 时查看返回参数中的 SubsId

    100000076879****
    PhoneNoXstring

    号码绑定关系中的 X 号码。

    1390000****
    PhoneNoAstring

    设置绑定关系中的 A 号码。

    说明 OperateType 指定为 updateNoA 时必填。
    1390000****
    PhoneNoBstring

    设置绑定关系中的 B 号码。

    说明 OperateType 指定为 updateNoB 时必填。
    1390000****
    GroupIdstring

    设置绑定关系中的 G 号码组 ID。

    说明 OperateType 指定为 updateAxgGroup 时必填。
    1234
    CallRestrictstring

    设置单通呼叫限制。取值:

    • CONTROL_AX_DISABLE:A 号码无法呼叫 X 号码。
    • CONTROL_BX_DISABLE:B 号码无法呼叫 X 号码。
    • CONTROL_CLEAR_DISABLE:清除呼叫限制。
    说明 OperateType 指定为 updateCallRestrict 时必填。
    CONTROL_BX_DISABLE
    Expirationstring

    重新设置绑定关系的过期时间。

    说明
  • OperateTypeupdateExpire 时必填。
    • 过期时间必须晚于当前时间 1 分钟以上。
    2019-09-05 12:00:00
    CallDisplayTypeinteger

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

    说明 由于运营商监管限制,暂时关闭透传功能。呼叫时,显示真实号码的设置不生效。
    1
    OutIdstring

    重新设置绑定关系中的 OutId。

    abcdef
    IsRecordingEnabledboolean

    重新设置绑定关系中的录音状态。

    说明 该参数没有默认值,不传该参数就不更新对应字段。
    true
    OperateTypestring

    修改绑定关系的操作。取值:

    • updateNoA:修改 A 号码。
    • updateNoB:修改 B 号码。
    • updateExpire:修改绑定关系有效期。
    • updateAxgGroup:修改 G 号码组。
    • updateCallRestrict:设置单通呼叫限制。
    • updateCallDisplayType:更新呼叫显号逻辑。
    • updateOutId:更新 OutId 字段。
    • updateIsRecordingEnabled:更新绑定中录音状态。
    updateNoA
    RingConfigstring

    更新绑定关系中的企业彩铃放音编码。

    AXB 产品:

    • AXB 中,A 号码打 X 的铃音设置:AXBRing_A
    • AXB 中,B 号码打 X 的铃音设置:AXBRing_B

    AXN 产品:

    • AXN 中,A 号码打 X 的铃音设置(有回拨号码):AXNRing_AB
    • AXN 中,A 号码打 X 的铃音设置(无回拨号码):AXNRing_A
    • AXN 中,N 侧号码打 X 的铃音设置:AXNRing_N

    AXG 产品:

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

    企业彩铃编码:企业彩铃编码可以在管理控制台中查询,具体请登录号码隐私保护控制台,选择号码池管理>企业彩铃管理进行查看、管理,支持上传、删除等操作。

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

    ASR 状态。取值:

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

    ASR 模型 ID。

    980abddb908f48e8b987cb2cd303****

    返回参数

    名称类型描述示例值
    object

    返回数据。

    Codestring

    请求状态码。

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

    状态码的描述。

    OK
    RequestIdstring

    请求 ID。

    986BCB6D-C9BF-42F9-91CE-3A9901233D36

    示例

    正常返回示例

    JSON格式

    {
      "Code": "OK",
      "Message": "OK",
      "RequestId": "986BCB6D-C9BF-42F9-91CE-3A9901233D36"
    }

    错误码

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

    变更历史

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