Showing
1 changed file
with
131 additions
and
3 deletions
1 | -## 获取用户的消息列表## | 1 | +1.## 获取用户的消息列表## |
2 | 2 | ||
3 | 获取用户的消息列表(method=app.social.getInboxList) | 3 | 获取用户的消息列表(method=app.social.getInboxList) |
4 | #### 公共请求参数 | 4 | #### 公共请求参数 |
@@ -28,8 +28,8 @@ | @@ -28,8 +28,8 @@ | ||
28 | #### 返回错误 | 28 | #### 返回错误 |
29 | |错误code|错误提示| | 29 | |错误code|错误提示| |
30 | |:-------| -----:| | 30 | |:-------| -----:| |
31 | -|500|帖子id不能为空| | ||
32 | -|500|帖子信息为空| | 31 | +|400|uid is null| |
32 | +|400|消息类型不能为空| | ||
33 | 33 | ||
34 | 注意,通用的头部没有列出。 | 34 | 注意,通用的头部没有列出。 |
35 | 请求示例 | 35 | 请求示例 |
@@ -165,4 +165,132 @@ code为200即为成功,否则是失败。 | @@ -165,4 +165,132 @@ code为200即为成功,否则是失败。 | ||
165 | "data": [] | 165 | "data": [] |
166 | } | 166 | } |
167 | ``` | 167 | ``` |
168 | +2.## 根据用户id以及消息id列表批量删除消息## | ||
168 | 169 | ||
170 | +根据用户id以及消息id列表批量删除消息(method=app.social.delmessage) | ||
171 | +#### 公共请求参数 | ||
172 | +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 | | ||
173 | +|:-------| -----:|-----:|-----:|-----:|-----:|----:| | ||
174 | +|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息| | ||
175 | +|app_version|float|10|否|1||APP版本| | ||
176 | +|os_version|string|20|否|Android4.4||系统版本+机器型号| | ||
177 | +|client_type|string|20|否|iphone/android/ipad||手机型号(不区分大小写)| | ||
178 | +|screen_size|string|20|否|800x900||(手机尺寸)| | ||
179 | + | ||
180 | +#### 请求参数 | ||
181 | +| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 | | ||
182 | +|:-------| -----:|-----:|-----:|-----:|-----:|----:| | ||
183 | +|uid|String|1-11|否|5451281||ssouid| | ||
184 | +|ids|String|1-11|否|10,11,12||消息id集合| | ||
185 | + | ||
186 | +#### 接口说明 | ||
187 | +| 接口说明|| | ||
188 | +|:-------| -----:| | ||
189 | +|请求域名|http://api.yoho.cn| | ||
190 | +|接口名|app.social.delmessage| | ||
191 | +|接口说明|根据用户id以及消息id列表批量删除消息| | ||
192 | +|http请求方式|POST/GET| | ||
193 | +#### 返回错误 | ||
194 | +|错误code|错误提示| | ||
195 | +|:-------| -----:| | ||
196 | +|400|uid is null| | ||
197 | + | ||
198 | +注意,通用的头部没有列出。 | ||
199 | +请求示例 | ||
200 | +http://localhost:8095/social/?method=app.social.delmessage&uid=8050426&debug=XYZ&ids=16,18 | ||
201 | + | ||
202 | +### 响应 | ||
203 | +code为200即为成功,否则是失败。 | ||
204 | +响应参数,data部分 | ||
205 | +响应成功JSON格式如下所示: | ||
206 | + | ||
207 | +```json | ||
208 | +{ | ||
209 | + "code": 200, | ||
210 | + "message": "删除成功.", | ||
211 | + "md5": "6d729d4b35f10fc73531210bd7ecff91", | ||
212 | + "alg": "SALT_MD5", | ||
213 | + "data": [] | ||
214 | +} | ||
215 | +``` | ||
216 | +响应失败JSON格式如下所示: | ||
217 | +```json | ||
218 | +{ | ||
219 | + "code": 400, | ||
220 | + "message": "uid is null", | ||
221 | + "md5": "6d729d4b35f10fc73531210bd7ecff91", | ||
222 | + "alg": "SALT_MD5", | ||
223 | + "data": [] | ||
224 | +} | ||
225 | +``` | ||
226 | + | ||
227 | +3.## 获取消息首页信息## | ||
228 | + | ||
229 | +获取消息首页信息(method=app.social.getInboxIndexInfo) | ||
230 | +#### 公共请求参数 | ||
231 | +| 参数名称 | 参数类型 | 长度 | 可否为空 | 示例 | 默认值 | 备注 | | ||
232 | +|:-------| -----:|-----:|-----:|-----:|-----:|----:| | ||
233 | +|client_secret|string|50|否|5ac68f20cb18efe154be||进入接口提供的参数加密信息| | ||
234 | +|app_version|float|10|否|1||APP版本| | ||
235 | +|os_version|string|20|否|Android4.4||系统版本+机器型号| | ||
236 | +|client_type|string|20|否|iphone/android/ipad||手机型号(不区分大小写)| | ||
237 | +|screen_size|string|20|否|800x900||(手机尺寸)| | ||
238 | + | ||
239 | +#### 请求参数 | ||
240 | +| 参数名称 | 参数类型 |长度| 可否为空 | 示例 | 默认值 | 备注 | | ||
241 | +|:-------| -----:|-----:|-----:|-----:|-----:|----:| | ||
242 | +|uid|String|1-11|否|5451281||ssouid| | ||
243 | + | ||
244 | +#### 接口说明 | ||
245 | +| 接口说明|| | ||
246 | +|:-------| -----:| | ||
247 | +|请求域名|http://api.yoho.cn| | ||
248 | +|接口名|app.social.delmessage| | ||
249 | +|接口说明|根据用户id以及消息id列表批量删除消息| | ||
250 | +|http请求方式|POST/GET| | ||
251 | +#### 返回错误 | ||
252 | +|错误code|错误提示| | ||
253 | +|:-------| -----:| | ||
254 | +|400|uid is null| | ||
255 | + | ||
256 | +注意,通用的头部没有列出。 | ||
257 | +请求示例 | ||
258 | +http://localhost:8095/social/?method=app.social.getInboxIndexInfo&uid=8050426&debug=XYZ&limit=1 | ||
259 | + | ||
260 | +### 响应 | ||
261 | +code为200即为成功,否则是失败。 | ||
262 | +响应参数,data部分 | ||
263 | +响应成功JSON格式如下所示: | ||
264 | + | ||
265 | +```json | ||
266 | +{ | ||
267 | + "code": 200, | ||
268 | + "message": "获取消息中心信息成功.", | ||
269 | + "md5": "4fcc158f2e090f1814f36ac5c88888aa", | ||
270 | + "alg": "SALT_MD5", | ||
271 | + "data": { | ||
272 | + "praiseMsg": { | ||
273 | + "id": 42, | ||
274 | + "title": "小明赞了你的帖子", | ||
275 | + "isRead": "Y", | ||
276 | + "createTime": 1468931593743 | ||
277 | + }, | ||
278 | + "systemMsg": { | ||
279 | + "id": 43, | ||
280 | + "title": "帖子被设为热门", | ||
281 | + "isRead": "Y", | ||
282 | + "createTime": 1468931593743 | ||
283 | + } | ||
284 | + } | ||
285 | +} | ||
286 | +``` | ||
287 | +响应失败JSON格式如下所示: | ||
288 | +```json | ||
289 | +{ | ||
290 | + "code": 400, | ||
291 | + "message": "uid is null", | ||
292 | + "md5": "6d729d4b35f10fc73531210bd7ecff91", | ||
293 | + "alg": "SALT_MD5", | ||
294 | + "data": [] | ||
295 | +} | ||
296 | +``` |
-
Please register or login to post a comment