全部产品
阿里云办公

查询绑定关系详情API

更新时间:2018-10-24 10:14:31

查询绑定关系详情接口(QuerySubscriptionDetail)

步骤 1 创建阿里云账号

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

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

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

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

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

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

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

步骤 3 明确您所使用的产品类型

目前支持三款产品,AXB_170,AXN_170,AXN_95。

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

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

参数

入参列表
参数名称 参数类型 必填与否 样例取值 参数说明
PoolKey String 必须 FC12345 号池Key
SubsId String 必须 12345 创建绑定关系API接口所返回的订购关系ID
PhoneNoX String 必须 17000000000 创建绑定关系API接口所返回的X号码
出参列表
出参名称 出参类型 样例取值 参数说明
RequestId String 8906582E-6722 请求ID
Code String OK 状态码-返回OK代表请求成功,其他错误码详见错误码列表
Message String 请求成功 状态码的描述
SecretBindDetailDTO Object 结构体 结构体包含字段说明:subsId(订购关系ID),phoneNoA、phoneNoX、phoneNoB(AXB三元组),gmtCreate、expireDate(创建时间和失效时间),needRecord(是否需要录音),status(绑定状态1-生效 0-失效)

技术对接步骤

1:下载SDK工具包

SDK工具包中一共包含了2个类库,一个aliyun-.net-sdk-core包,另外一个是alicom-dypls-api包,将这两个包执行mvn package命令或者mvn deploy命令打包出相应的jar包,添加到工程类库中依赖使用。

SDK&DEMO【下载地址】

2: 编写样例程序
  1. public static QuerySubscriptionDetailResponse querySubscriptionDetail()
  2. {
  3. IClientProfile profile = DefaultProfile.GetProfile("cn-hangzhou", accessKeyId, accessKeySecret);
  4. DefaultProfile.AddEndpoint("cn-hangzhou", "cn-hangzhou", product, domain);
  5. IAcsClient client = new DefaultAcsClient(profile);
  6. QuerySubscriptionDetailRequest request = new QuerySubscriptionDetailRequest();
  7. //必填:对应的号池Key
  8. request.setPoolKey("FC12345");
  9. //必填:绑定关系ID
  10. request.SubsId = "123456";
  11. //必填:绑定关系对应的X号码
  12. request.PhoneNoX = "170000000";
  13. QuerySubscriptionDetailResponse response = null;
  14. try
  15. {
  16. response = client.GetAcsResponse(request);
  17. if (response.Code != null && response.Code == "OK")
  18. {
  19. //请求成功
  20. }
  21. }
  22. catch (ServerException e)
  23. {
  24. }
  25. catch (ClientException e)
  26. {
  27. }
  28. return response;
  29. }

错误码列表

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