Authored by zhang.lipeng

站内信改版接口文档

1 -123  
  1 +## 1、获取站内信列表 ##
  2 +
  3 +1、获取站内信列表(method=app.inbox.getlistnew)
  4 +#### 公共请求参数
  5 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  6 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  7 +|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
  8 +|app_version|float|10|否|1||APP版本|
  9 +|os_version|string|20|否|Android4.4||系统版本+机器型号|
  10 +|client_type|string|20|否|iphone/android/ipad||手机型号(不区分大小写)|
  11 +|screen_size|string|20|否|800x900||(手机尺寸)|
  12 +
  13 +#### 请求参数 参数对象 GetListReqBO.java
  14 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  15 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  16 +|uid|int|否|1-11|3566164||用户id|
  17 +|size|int|是|1-11|10||每页查询数量|
  18 +|displayTab|String|是||0||前端展示分类(1:* 1-会员信息,2-我的资产,3-客户服务,4-其他为空时查询全部)|
  19 +
  20 +
  21 +#### 接口说明
  22 +| 接口说明||
  23 +|:-------| -----:|
  24 +|请求域名|http://api.yoho.cn|
  25 +|接口名|app.inbox.getlistnew|
  26 +|获取用户地址信息|
  27 +|http请求方式|POST/GET|
  28 +#### 返回错误
  29 +|错误code|错误提示|
  30 +|:-------| -----:|
  31 +|500|User ID Is Null.|
  32 +
  33 +注意,通用的头部没有列出。
  34 +请求示例
  35 +http://192.168.102.205:8080/gateway?method=app.inbox.getlistnew&uid=8040080......
  36 +
  37 +
  38 +### 响应
  39 +code为200即为成功,否则是失败。
  40 +响应参数,data部分
  41 +响应成功JSON格式如下所示:
  42 +```json
  43 +{
  44 + "alg":"SALT_MD5",
  45 + "code":200,
  46 + "data":[
  47 + "list":[{
  48 + "id":1,
  49 + "uid":"3566164,
  50 + "from":"有货",
  51 + "title":"您的会员级别即将到期",
  52 + "body":"320111",
  53 + "type":"1",
  54 + "is_read":"true",
  55 + "create_time":"1315577222",
  56 + "create_date":"2016-1-1 18:52:52",
  57 + "content":"您的**等级会员有效期即将到期!还需消费**元可继续保持您的**等级会员哦!快来选购吧!",
  58 + "businessType":"102",
  59 + "pcLink":"",
  60 + "appLink":""
  61 + }]
  62 + "page_total":1
  63 + "page":1
  64 + "total":1
  65 + ],
  66 + "md5":"fd4ad5fcsa0de589af23234ks1923ks",
  67 + "message":"inbox list"
  68 +}
  69 +```
  70 +响应失败JSON格式如下所示:
  71 +```json
  72 +
  73 +```
  74 +
  75 +## 2、获取站内信所有分类信息、最新未读消息预览及未读数量 ##
  76 +
  77 +获取站内信所有分类信息、最新未读消息预览及未读数量(method=app.inbox.getAllInboxCatInfo)
  78 +#### 公共请求参数
  79 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  80 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  81 +|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
  82 +|app_version|float|10|否|1||APP版本|
  83 +|os_version|string|20|否|Android4.4||系统版本+机器型号|
  84 +|client_type|string|20|否|iphone/android/ipad||手机型号(不区分大小写)|
  85 +|screen_size|string|20|否|800x900||(手机尺寸)|
  86 +
  87 +#### 请求参数 参数对象 GetListReqBO.java
  88 +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
  89 +|:-------| -----:|-----:|-----:|-----:|-----:|----:|
  90 +|uid|int|否|1-11|5088610||用户id|
  91 +
  92 +#### 接口说明
  93 +| 接口说明||
  94 +|:-------| -----:|
  95 +|请求域名|http://api.yoho.cn|
  96 +|接口名|app.inbox.getAllInboxCatInfo|
  97 +|获取用户地址信息|
  98 +|http请求方式|POST|
  99 +#### 返回错误
  100 +|错误code|错误提示|
  101 +|:-------| -----:|
  102 +|500|User ID Is Null.|
  103 +
  104 +注意,通用的头部没有列出。
  105 +请求示例
  106 +http://192.168.102.205:8080/gateway?method=app.inbox.getAllInboxCatInfo&uid=5088610
  107 +
  108 +
  109 +### 响应
  110 +code为200即为成功,否则是失败。
  111 +响应参数,data部分
  112 +响应成功JSON格式如下所示:
  113 +```json
  114 +{
  115 + "code":"200",
  116 + "data":[{
  117 + "createTime":"1970-01-18 11:55:19",
  118 + "id":1,
  119 + "inboxCatName":"会员信息",
  120 + "unReadCount":3,
  121 + "content":"预览最新未读消息测试"
  122 + },
  123 + {
  124 + "createTime":"1970-01-18 11:55:19",
  125 + "id":2,
  126 + "inboxCatName":"我的资产",
  127 + "unReadCount":3,
  128 + "content":"预览最新未读消息测试"
  129 + },
  130 + {
  131 + "createTime":"1970-01-18 11:55:19",
  132 + "id":3,
  133 + "inboxCatName":"客户服务",
  134 + "unReadCount":3,
  135 + "content":"预览最新未读消息测试"
  136 + },
  137 + {
  138 + "createTime":"1970-01-18 11:55:19",
  139 + "id":4,
  140 + "inboxCatName":"其他",
  141 + "unReadCount":3,
  142 + "content":"预览最新未读消息测试"
  143 + }],
  144 + "message":"success"
  145 +}
  146 +```
  147 +响应失败JSON格式如下所示:
  148 +```json
  149 +{"message":"uid is null","code":600001010}
  150 +```