全部产品
云市场

更新绑定关系API

更新时间:2018-12-28 14:01:30

更新绑定关系接口(UpdateSubscription)

步骤 1 创建阿里云账号

为了访问隐私号服务,您需要有一个阿里云账号。如果没有,可首先按照如下步骤创建阿里云账号:

  1. 访问阿里云 官方网站,单击页面上的 免费注册 按钮。
  2. 按照屏幕提示完成注册流程并进行实名认证,AXN隐私号只支持实名认证用户使用。为了更好地使用阿里云服务,建议尽快完成实名认证,否则部分阿里云服务将无法使用。具体实名认证流程,请参考 这里

步骤 2 获取阿里云访问密钥

为了使用隐私号API-Node.js SDK,您必须申请阿里云的访问密钥。

阿里云访问秘钥是阿里云为用户使用 API(非控制台)来访问其云资源设计的“安全口令”。您可以用它来签名 API 请求内容以通过服务端的安全验证。

该访问秘钥成对(AccessKeyId 与 AccessKeySecret)生成和使用。每个阿里云用户可以创建多对访问秘钥,且可随时启用(Active)、禁用(Inactive)或者删除已经生成的访问秘钥对。

您可以通过阿里云控制台的 秘钥管理页面 创建、管理所有的访问秘钥对,且保证它处于“启用”状态。由于访问秘钥是阿里云对 API 请求进行安全验证的关键因子,请妥善保管你的访问秘钥。如果某些秘钥对出现泄漏风险,建议及时删除该秘钥对并生成新的替代秘钥对。

步骤 3 下载对应的SDK和DEMO样例程序编写代码

请到SDK&DEMO下载页面获取相应的SDK和DEMO程序,参照代码样例进行接口开发和调试。

参数

入参列表
参数名称 参数类型 必填与否 样例取值 参数说明
PoolKey String 必须 FC12345 号池Key
SubsId String 必须 12345 创建绑定关系API接口所返回的订购关系ID
PhoneNoX String 必须 17000000000 创建绑定关系API接口所返回的X号码
OperateType String 必须 updateNoA 操作类型(目前支持三种类型):updateNoA(修改A号码)、updateNoB(修改B号码)、updateExpire(更新绑定关系有效期)、updateCallRestrict(更新单通呼叫限制 1:CONTROL_AX_DISABLE 控制A侧无法呼叫X CONTROL_BX_DISABLE 控制B侧无法呼叫X CONTROL_CLEAR_DISABLE 清除呼叫控制限制)
PhoneNoA String 可选 150000000 将该绑定关系中的A号码替换成所传递的值,OperateType=updateNoA时必填
PhoneNoB String 可选 150000000 将该绑定关系中的B号码替换成所传递的值,OperateType=updateNoB时必填
Expiration Date 可选 2017-09-05 12:00:00 将该绑定关系的过期时间替换成所传递的值,OperateType=updateExpire时必填
出参列表
出参名称 出参类型 样例取值 参数说明
RequestId String 8906582E-6722 请求ID
Code String OK 状态码-返回OK代表请求成功,其他错误码详见错误码列表
Message String 请求成功 状态码的描述

技术对接步骤

1:使用方法

安装@alicloud/pls-sdk,请需要根据官方文档做一些配置

产品文档: https://help.aliyun.com/document_detail/59773.html

号码隐私保护控制台: https://dypls.console.aliyun.com/dypls.htm

Node.js版本 >= v4.6.0

不支持在浏览器上使用

点击下载SDK&DEMO

2: 编写样例程序
  1. /**
  2. * 云通信基础能力业务-号码隐私保护示例,仅供参考。
  3. * Created on 2018-07-27
  4. */
  5. const PLSClient = require('@alicloud/pls-sdk')
  6. // ACCESS_KEY_ID/ACCESS_KEY_SECRET 根据实际申请的账号信息进行替换
  7. const accessKeyId = 'yourAccessKeyId'
  8. const secretAccessKey = 'yourAccessKeySecret'
  9. //在云通信页面开通相应业务消息后,就能在页面上获得对应的queueName,不用填最后面一段
  10. const queueName = 'Alicom-Queue-13635054xxxxxx-'
  11. //初始化sms_client
  12. const plsClient = new PLSClient({ accessKeyId, secretAccessKey })
  13. const PoolKey = 'FC100000xxxxxx'
  14. // 更新绑定关系
  15. plsClient.updateSubscription({
  16. PoolKey,
  17. SubsId,
  18. PhoneNoX: SecretNo,
  19. OperateType: 'updateExpire',
  20. Expiration: '2018-08-06 12:00:00'
  21. }).then(function (res) {
  22. console.log('更新绑定关系', res)
  23. }, function (err) {
  24. console.log('更新绑定关系失败', err)
  25. })

错误码列表

Code 描述
OK 请求成功
isp.RAM_PERMISSION_DENY RAM权限DENY
isv.OUT_OF_SERVICE 业务停机
isv.PRODUCT_UN_SUBSCRIPT 未开通云通信产品的阿里云客户
isv.PRODUCT_UNSUBSCRIBE 产品未开通
isv.ACCOUNT_NOT_EXISTS 账户不存在
isv.ACCOUNT_ABNORMAL 账户异常
isp.SYSTEM_ERROR 系统错误
isp.UNKNOWN_ERR_CODE 运营商未知错误
isv.PARTNER_NOT_EXIST 未知合作伙伴
isv.NO_NOT_EXIST 号码不存在
isv.ILLEGAL_ARGUMENT 参数非法
isp.DAO_EXCEPTION 数据库异常
isv.NO_AVAILABLE_NUMBER 无可用号码
isp.VENDOR_UNAVAILABLE 运营商降级
isv.FLOW_LIMIT 业务流控
isv.PARTNER_IS_CLOSED partner被关停
isv.FORBIDDEN_ACTION 无权操作
isv.NO_USED_BY_OTHERS 码被其他业务方占用
isv.VENDOR_BIND_FAILED 运营商绑定失败
isv.EXPIRE_DATE_ILLEGAL 过期时间非法
isv.MOBILE_NUMBER_ILLEGAL 号码格式非法
isv.BIND_CONFLICT 绑定冲突