号码隐私保护 AXN绑定接口

AXN绑定接口(Axnbind)



步骤 1 创建阿里云账号


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

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

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


为了使用AXN隐私号绑定API-JAVA SDK，您必须申请阿里云的访问密钥。
阿里云访问秘钥是阿里云为用户使用 API（非控制台）来访问其云资源设计的“安全口令”。您可以用它来签名 API 请求内容以通过服务端的安全验证。
该访问秘钥成对（AccessKeyId 与 AccessKeySecret）生成和使用。每个阿里云用户可以创建多对访问秘钥，且可随时启用（Active）、禁用（Inactive）或者删除已经生成的访问秘钥对。
您可以通过阿里云控制台的 秘钥管理页面 创建、管理所有的访问秘钥对，且保证它处于“启用”状态。由于访问秘钥是阿里云对 API 请求进行安全验证的关键因子，请妥善保管你的访问秘钥。如果某些秘钥对出现泄漏风险，建议及时删除该秘钥对并生成新的替代秘钥对。

步骤 3 明确您业务场景中的AXN三元组中A和N分别对应的业务角色


AXN三元组中 A号码如果是客户的话，X号码就是为A客户分配的隐私号码，其他的任何号码拨打X号码都会转接到A号码，在创建AXN绑定关系时可以设定一个默认的B号码，假如A拨打X就会转接到这个B号码，如果B号码没有设置A就会被提示拨打的X号码是空号。

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


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

参数



入参列表

参数名称	参数类型	必填与否	样例取值	参数说明
phoneNoA	String	必须	15000000000	AXN中的A号码
phoneNoB	String	可选	15800000000	AXN中的默认的B号码
noType	String	必须	需要使用的号码类型	目前支持2种号码类型,NO_95代表95接入号,NO_170代表170中间号
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

技术对接步骤



1:下载SDK工具包


SDK工具包中一共包含了2个类库，一个aliyun-java-sdk-core包，另外一个是alicom-dypls-api包，将这两个包执行mvn package命令或者mvn deploy命令打包出相应的jar包，添加到工程类库中依赖使用。
SDK&DEMO【下载地址】

2: 编写样例程序

1. [backcolor=transparent]//设置超时时间-可自行调整
2. [backcolor=transparent]System[backcolor=transparent].[backcolor=transparent]setProperty[backcolor=transparent]([backcolor=transparent]"sun.net.client.defaultConnectTimeout"[backcolor=transparent],[backcolor=transparent] [backcolor=transparent]"10000"[backcolor=transparent]);
3. [backcolor=transparent]System[backcolor=transparent].[backcolor=transparent]setProperty[backcolor=transparent]([backcolor=transparent]"sun.net.client.defaultReadTimeout"[backcolor=transparent],[backcolor=transparent] [backcolor=transparent]"10000"[backcolor=transparent]);
4. [backcolor=transparent]//初始化ascClient需要的几个参数
5. [backcolor=transparent]final[backcolor=transparent] [backcolor=transparent]String[backcolor=transparent] product [backcolor=transparent]=[backcolor=transparent] [backcolor=transparent]"Dyplsapi"[backcolor=transparent];[backcolor=transparent]//隐私号码产品名称（产品名称固定，无需修改）
6. [backcolor=transparent]final[backcolor=transparent] [backcolor=transparent]String[backcolor=transparent] domain [backcolor=transparent]=[backcolor=transparent] [backcolor=transparent]"dyplsapi.aliyuncs.com"[backcolor=transparent];[backcolor=transparent]//隐私号码产品域名（产品域名固定，无需修改）
7. [backcolor=transparent]//替换成你的AK
8. [backcolor=transparent]final[backcolor=transparent] [backcolor=transparent]String[backcolor=transparent] accessKeyId [backcolor=transparent]=[backcolor=transparent] [backcolor=transparent]"yourAccessKeyId"[backcolor=transparent];[backcolor=transparent]//你的accessKeyId,参考本文档步骤2
9. [backcolor=transparent]final[backcolor=transparent] [backcolor=transparent]String[backcolor=transparent] accessKeySecret [backcolor=transparent]=[backcolor=transparent] [backcolor=transparent]"yourAccessKeySecret"[backcolor=transparent];[backcolor=transparent]//你的accessKeySecret，参考本文档步骤2
10. [backcolor=transparent]//初始化ascClient,暂时不支持多region
11. [backcolor=transparent]IClientProfile[backcolor=transparent] profile [backcolor=transparent]=[backcolor=transparent] [backcolor=transparent]DefaultProfile[backcolor=transparent].[backcolor=transparent]getProfile[backcolor=transparent]([backcolor=transparent]"cn-hangzhou"[backcolor=transparent],[backcolor=transparent] accessKeyId[backcolor=transparent],
12. [backcolor=transparent]accessKeySecret[backcolor=transparent]);
13. [backcolor=transparent]DefaultProfile[backcolor=transparent].[backcolor=transparent]addEndpoint[backcolor=transparent]([backcolor=transparent]"cn-hangzhou"[backcolor=transparent],[backcolor=transparent] [backcolor=transparent]"cn-hangzhou"[backcolor=transparent],[backcolor=transparent] product[backcolor=transparent],[backcolor=transparent] domain[backcolor=transparent]);
14. [backcolor=transparent]IAcsClient[backcolor=transparent] acsClient [backcolor=transparent]=[backcolor=transparent] [backcolor=transparent]new[backcolor=transparent] [backcolor=transparent]DefaultAcsClient[backcolor=transparent]([backcolor=transparent]profile[backcolor=transparent]);
16. [backcolor=transparent] [backcolor=transparent]//组装请求对象-具体描述见控制台-文档部分内容
17. [backcolor=transparent] [backcolor=transparent]BindAxnRequest[backcolor=transparent] request [backcolor=transparent]=[backcolor=transparent] [backcolor=transparent]new[backcolor=transparent] [backcolor=transparent]BindAxnRequest[backcolor=transparent]();
18. [backcolor=transparent] [backcolor=transparent]//必填:AXN关系中的A号码
19. [backcolor=transparent] request[backcolor=transparent].[backcolor=transparent]setPhoneNoA[backcolor=transparent]([backcolor=transparent]"15010101010"[backcolor=transparent]);
20. [backcolor=transparent] [backcolor=transparent]//可选:AXN中A拨打X的时候转接到的默认的B号码,如果不需要则不设置
21. [backcolor=transparent] request[backcolor=transparent].[backcolor=transparent]setPhoneNoB[backcolor=transparent]([backcolor=transparent]"15020202020"[backcolor=transparent]);
22. [backcolor=transparent] [backcolor=transparent]//95中间号,NO_170代表选择使用170号码资源
23. [backcolor=transparent] request[backcolor=transparent].[backcolor=transparent]setNoType[backcolor=transparent]([backcolor=transparent]"NO_95"[backcolor=transparent]);
24. [backcolor=transparent] [backcolor=transparent]//必填:绑定关系对应的失效时间-不能早于当前系统时间
25. [backcolor=transparent] request[backcolor=transparent].[backcolor=transparent]setExpiration[backcolor=transparent]([backcolor=transparent]"2017-09-08 17:00:00"[backcolor=transparent]);
26. [backcolor=transparent] [backcolor=transparent]//可选:是否需要录制音频-默认是false
27. [backcolor=transparent] request[backcolor=transparent].[backcolor=transparent]setIsRecordingEnabled[backcolor=transparent]([backcolor=transparent]false[backcolor=transparent]);
28. [backcolor=transparent] [backcolor=transparent]//外部业务自定义ID属性
29. [backcolor=transparent] request[backcolor=transparent].[backcolor=transparent]setOutId[backcolor=transparent]([backcolor=transparent]"yourOutId"[backcolor=transparent]);
30. [backcolor=transparent] [backcolor=transparent]//hint 此处可能会抛出异常，注意catch
31. [backcolor=transparent] [backcolor=transparent]BindAxnResponse[backcolor=transparent] response [backcolor=transparent]=[backcolor=transparent] acsClient[backcolor=transparent].[backcolor=transparent]getAcsResponse[backcolor=transparent]([backcolor=transparent]request[backcolor=transparent]);
33. [backcolor=transparent] [backcolor=transparent]if[backcolor=transparent]([backcolor=transparent]response[backcolor=transparent].[backcolor=transparent]getCode[backcolor=transparent]()[backcolor=transparent] [backcolor=transparent]!=[backcolor=transparent] [backcolor=transparent]null[backcolor=transparent] [backcolor=transparent]&&[backcolor=transparent] response[backcolor=transparent].[backcolor=transparent]getCode[backcolor=transparent]().[backcolor=transparent]equals[backcolor=transparent]([backcolor=transparent]"OK"[backcolor=transparent]))[backcolor=transparent] [backcolor=transparent]{
34. [backcolor=transparent]          [backcolor=transparent]//请求成功
35. [backcolor=transparent]  [backcolor=transparent]}

错误码列表

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	绑定冲突