Authored by zhang.lipeng

站内信改版接口文档

123
\ No newline at end of file
## 1、获取站内信列表 ##
1、获取站内信列表(method=app.inbox.getlistnew)
#### 公共请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
|app_version|float|10|否|1||APP版本|
|os_version|string|20|否|Android4.4||系统版本+机器型号|
|client_type|string|20|否|iphone/android/ipad||手机型号(不区分大小写)|
|screen_size|string|20|否|800x900||(手机尺寸)|
#### 请求参数 参数对象 GetListReqBO.java
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|uid|int|否|1-11|3566164||用户id|
|size|int|是|1-11|10||每页查询数量|
|displayTab|String|是||0||前端展示分类(1:* 1-会员信息,2-我的资产,3-客户服务,4-其他为空时查询全部)|
#### 接口说明
| 接口说明||
|:-------| -----:|
|请求域名|http://api.yoho.cn|
|接口名|app.inbox.getlistnew|
|获取用户地址信息|
|http请求方式|POST/GET|
#### 返回错误
|错误code|错误提示|
|:-------| -----:|
|500|User ID Is Null.|
注意,通用的头部没有列出。
请求示例
http://192.168.102.205:8080/gateway?method=app.inbox.getlistnew&uid=8040080......
### 响应
code为200即为成功,否则是失败。
响应参数,data部分
响应成功JSON格式如下所示:
```json
{
"alg":"SALT_MD5",
"code":200,
"data":[
"list":[{
"id":1,
"uid":"3566164,
"from":"有货",
"title":"您的会员级别即将到期",
"body":"320111",
"type":"1",
"is_read":"true",
"create_time":"1315577222",
"create_date":"2016-1-1 18:52:52",
"content":"您的**等级会员有效期即将到期!还需消费**元可继续保持您的**等级会员哦!快来选购吧!",
"businessType":"102",
"pcLink":"",
"appLink":""
}]
"page_total":1
"page":1
"total":1
],
"md5":"fd4ad5fcsa0de589af23234ks1923ks",
"message":"inbox list"
}
```
响应失败JSON格式如下所示:
```json
```
## 2、获取站内信所有分类信息、最新未读消息预览及未读数量 ##
获取站内信所有分类信息、最新未读消息预览及未读数量(method=app.inbox.getAllInboxCatInfo)
#### 公共请求参数
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息|
|app_version|float|10|否|1||APP版本|
|os_version|string|20|否|Android4.4||系统版本+机器型号|
|client_type|string|20|否|iphone/android/ipad||手机型号(不区分大小写)|
|screen_size|string|20|否|800x900||(手机尺寸)|
#### 请求参数 参数对象 GetListReqBO.java
| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 |
|:-------| -----:|-----:|-----:|-----:|-----:|----:|
|uid|int|否|1-11|5088610||用户id|
#### 接口说明
| 接口说明||
|:-------| -----:|
|请求域名|http://api.yoho.cn|
|接口名|app.inbox.getAllInboxCatInfo|
|获取用户地址信息|
|http请求方式|POST|
#### 返回错误
|错误code|错误提示|
|:-------| -----:|
|500|User ID Is Null.|
注意,通用的头部没有列出。
请求示例
http://192.168.102.205:8080/gateway?method=app.inbox.getAllInboxCatInfo&uid=5088610
### 响应
code为200即为成功,否则是失败。
响应参数,data部分
响应成功JSON格式如下所示:
```json
{
"code":"200",
"data":[{
"createTime":"1970-01-18 11:55:19",
"id":1,
"inboxCatName":"会员信息",
"unReadCount":3,
"content":"预览最新未读消息测试"
},
{
"createTime":"1970-01-18 11:55:19",
"id":2,
"inboxCatName":"我的资产",
"unReadCount":3,
"content":"预览最新未读消息测试"
},
{
"createTime":"1970-01-18 11:55:19",
"id":3,
"inboxCatName":"客户服务",
"unReadCount":3,
"content":"预览最新未读消息测试"
},
{
"createTime":"1970-01-18 11:55:19",
"id":4,
"inboxCatName":"其他",
"unReadCount":3,
"content":"预览最新未读消息测试"
}],
"message":"success"
}
```
响应失败JSON格式如下所示:
```json
{"message":"uid is null","code":600001010}
```
... ...