更新时间:2019-01-08 10:40
为了访问AXB中间号服务,您需要有一个阿里云账号。如果没有,可首先按照如下步骤创建阿里云账号:
为了使用AXB中间号绑定API-Node.js SDK,您必须申请阿里云的访问密钥。
阿里云访问秘钥是阿里云为用户使用 API(非控制台)来访问其云资源设计的“安全口令”。您可以用它来签名 API 请求内容以通过服务端的安全验证。
该访问秘钥成对(AccessKeyId 与 AccessKeySecret)生成和使用。每个阿里云用户可以创建多对访问秘钥,且可随时启用(Active)、禁用(Inactive)或者删除已经生成的访问秘钥对。
您可以通过阿里云控制台的 秘钥管理页面 创建、管理所有的访问秘钥对,且保证它处于“启用”状态。由于访问秘钥是阿里云对 API 请求进行安全验证的关键因子,请妥善保管你的访问秘钥。如果某些秘钥对出现泄漏风险,建议及时删除该秘钥对并生成新的替代秘钥对。
以打车应用场景来说,A假如设定的是乘客角色,B就是司机角色。以房产类业务场景来说,A可能是用户,B是房产中介。
请到SDK&DEMO下载页面获取相应的SDK和DEMO程序,参照代码样例进行接口开发和调试。
参数名称 | 参数类型 | 必填与否 | 样例取值 | 参数说明 |
---|---|---|---|---|
PoolKey | String | 必须 | FC123456 | 号池Key |
PhoneNoA | String | 必须 | 15000000000 | AXB中的A号码,A号码支持固话(区号后面不需要连字符”-“) |
PhoneNoB | String | 必须 | 15800000000 | AXB中的B号码 , B号码支持固话(区号后面不需要连字符”-“) |
PhoneNoX | String | 可选 | 17000000000 | 指定X号码进行绑定 |
ExpectCity | String | 可选 | 北京(不需要带地市的后缀) | 指定城市进行X号码的选号,如果当前号池中没有该城市的可用号码将随机分配其他城市的号码,也可以配置成严格模式,不存在符合条件的号码时提示分配错误 |
Expiration | Date | 必须 | 2017-09-05 12:00:00 | 绑定关系的过期时间 |
IsRecordingEnabled | Boolean | 可选 | true和false | 是否需要针对该绑定关系产生的所有通话录制通话录音 |
OutId | String | 可选 | abcdef | 外部业务扩展字段 |
出参名称 | 出参类型 | 样例取值 | 参数说明 |
---|---|---|---|
RequestId | String | 8906582E-6722 | 请求ID |
Code | String | OK | 状态码-返回OK代表请求成功,其他错误码详见错误码列表 |
Message | String | 请求成功 | 状态码的描述 |
SecretBindDTO | Object | 详见结构体内容 | 绑定成功后返回的结构体,结构体的属性详见demo和SDK |
安装@alicloud/pls-sdk,请需要根据官方文档做一些配置
产品文档: https://help.aliyun.com/document_detail/59773.html
号码隐私保护控制台: https://dypls.console.aliyun.com/dypls.htmNode.js版本 >= v4.6.0
不支持在浏览器上使用
/**
* 云通信基础能力业务-号码隐私保护示例,仅供参考。
* Created on 2018-07-27
*/
const PLSClient = require('@alicloud/pls-sdk')
// ACCESS_KEY_ID/ACCESS_KEY_SECRET 根据实际申请的账号信息进行替换
const accessKeyId = 'yourAccessKeyId'
const secretAccessKey = 'yourAccessKeySecret'
//在云通信页面开通相应业务消息后,就能在页面上获得对应的queueName,不用填最后面一段
const queueName = 'Alicom-Queue-13635054xxxxxx-'
//初始化sms_client
const plsClient = new PLSClient({ accessKeyId, secretAccessKey })
const PoolKey = 'FC100000xxxxxx'
// 绑定Axb号码示例方法
plsClient.bindAxb({
PoolKey,
PhoneNoA: '18040580000',
PhoneNoB: '13871140000',
Expiration: '2018-08-05 12:00:00'
}).then(function (res) {
console.log('绑定axb成功', res)
}, function (err) {
console.log('绑定axb失败', err)
})
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 | 绑定冲突 |
在文档使用中是否遇到以下问题
更多建议
匿名提交