| getSubscCtrl API功能描述 |
| 此接口方法以实现Isv查询订阅记录的信息。 |
| getSubscCtrl API调用级别 |
| apiType=1,需要签名校验(不需用户绑定) |
| getSubscCtrl API调用参数 |
| 系统级参数 |
| 名称 | 类型 | 是否必须 | 描述 |
| sip_appkey | String | 必须 | ISV应用的appkey为软件互联平台分配给ISV应用的唯一编号。 |
| sip_apiname | String | 必须 | 服务名。 |
| sip_timestamp | String | 必须 | 服务请求时间戳(yyyy-mm-dd hh:mi:ss)。 |
| sip_sign | String | 必须 | 请求签名(包括了对前面三个必选参数和所有业务参数按签名规则做签名)。 |
| sip_sessionid | String | 可选 | 在ISV应用中用户会话唯一标识。 |
| sip_format | String | 可选 | 规定返回值的类型。支持两种格式json与xml。默认为xml数据格式。 |
| 应用级参数 |
| 名称 | 类型 | 是否必须 | 描述 |
| appId | String | 必须 | 应用ID,在注册应用时,分配的应用唯一标识。 |
| appInstanceId | String | 必须 | 应用实例ID,一般与应用中的公司ID一一对应,可以在软件应用中心跳转到ISV App时的URL参数中取得。 |
| 正常返回格式1 |
| XML数据格式 | JSON数据格式 |
| <?xml version="1.0" encoding="utf-8" ?> <AppSubscControl> <appId>22</appId> <appInstanceId>paninstance001</appInstanceId> <userCount>115</userCount> <gmtStart>2007-11-01 00:00:00.0 CST</gmtStart> <gmtEnd>2007-11-11 00:00:00.0 CST</gmtEnd> <ctrlParams>m=1&t=df</ctrlParams> </AppSubscControl> |
{"appId":22,"appInstanceId":paninstance001 ,"userCount":115,"gmtStart":2007-11-01 00:00:00.0 CST,"gmtEnd":2007-11-11 00:00:00.0 CST,"ctrlParams":m=1&t=df} |
| 返回信息 | 返回信息说明 |
| appId | 应用ID,在注册应用时,分配的应用唯一标识 |
| appInstanceId | 应用实例的ID,某个用户以某个公司的身份订购的服务 |
| userCount | 可以使用的人数 |
| gmtStart | 开始时间 |
| gmEnd | 结束时间 |
| ctrlPrams | 控制参数 |
| 正常返回格式2 |
| XML数据格式 | JSON数据格式 |
| <?xml version="1.0" encoding="utf-8" ?> <null/> |
{"response":null} |
| 返回信息 | 返回信息说明 |
| null | 不存在该订阅 |
| 异常返回格式 |
| XML数据格式 | JSON数据格式 |
| <?xml version="1.0" encoding="utf-8" ?> <error>error_message</error> |
{"error":"error_message"} |
| 错误码 | 错误描述 | 原因及处理方法 |
| 1001 | 签名无效 | 原因:参数的sip_appkey、sip_appsecret错误或者不匹配。 解决:检查参数正确性,或到ASSP中检查或重新申请。 |
| 1002 | 请求已过期 | 原因:访问时间过期。 解决:检查sip_timestamp参数,检查网络延迟。 |
| 1003 | 用户绑定失败 | 原因:在调用此API时 |
| 1004 | 需要绑定用户 | 原因:在调用此API时,ISP要求用户验证并绑定(登录)。在请求中没有带sip_usertoken参数,无法进行绑定 解决:1、引导用户登录,处理流程见:5.4.5.4 用户身份验证 2、下次调用时,带上用户最新的sip_usertoken参数 |
| 1005 | 需要提供appid | 原因:缺少sip_appkey参数 |
| 1006 | 需要提供服务名 | 原因:缺少sip_apiname参数 |
| 1007 | 需要提供签名 | 原因:缺少sip_sign参数 |
| 1008 | 需要提供时间戳 | 原因:缺少sip_timestamp参数 |
| 1009 | 用户认证失败 | 原因:访问时间过期 |
| 1010 | 无权访问服务 | 原因:此服务API没有被订购、订购过期、账户余额不足等。 解决:到ISV Portal订购此API。 |
| 1011 | 服务不存在 | 原因:ISP无此服务 |
| 0000 | 未知异常 | 原因:不确定原因导演API调用失败。如: 1.SIP访问ISP时网络故障 2.ISP提供的API因故停用 3.其它未知原因 |
| 9999 | 调用成功 |
| 范例 |
getSubscCtrl接口调用实例 http://sipdev.alisoft.com/sip/rest?sip_appkey=a001&sip_apiname=alisoft.getSubscCtrl&sip_timestamp=2008-03-11 20:00:00&sip_sign=23ed99f1a0a1eac5f3787d522afde1c4&userId=111&appId=111&appInstanceId=1111&token=1111 |
| 历史版本 |
| 版本号 | 说明 |
| 1.0 | 初始版本 |