接口描述:

  • 用户获取消息列表。

请求 URL:

  • http|https://host/api/v1/message/method/get.message.user.list/

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
type integer between:0,9 0 消息类型(自定义)
is_read integer in:0,1 0 是否已读 0=否 1=是
page_no integer gt:0 1 1 页码
page_size integer between:1,40 15 15 每页数量
order_type string in:asc,desc desc asc 排序方式
order_field string 见附属 A message_id status 排序字段

附属 A:
in:message_id,type,page_views,is_top,status,create_time,update_time

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
items array [] 列表项
total_result integer 3 合计计数
items 类型 是否返回 示例值 描述
message_id integer 8 消息编号
title string 活动公告 消息标题
url string http://careyshop.cn 外部链接
target string _blank 打开方式
page_views integer 5 游览量
is_read integer 1 是否已读 0=否 1=是
create_time datetime 2018-06-06 22:49:59 创建时间

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "items": [
  6. {
  7. "message_id": 8,
  8. "title": "活动公告",
  9. "url": "http://careyshop.cn",
  10. "target": "_blank",
  11. "page_views": 5,
  12. "is_read": 1,
  13. "create_time": "2018-06-06 22:49:59"
  14. },
  15. {
  16. "message_id": 5,
  17. "title": "title-5",
  18. "url": "",
  19. "target": "_self",
  20. "page_views": 15,
  21. "is_read": 1,
  22. "create_time": "2017-11-27 14:16:52"
  23. },
  24. {
  25. "message_id": 4,
  26. "title": "title-4",
  27. "url": "",
  28. "target": "_self",
  29. "page_views": 4,
  30. "is_read": 0,
  31. "create_time": "2017-11-27 14:16:52"
  32. }
  33. ],
  34. "total_result": 3
  35. }
  36. }

备注:

  1. 该接口支持条件搜索,如果不带入业务参数则使用默认值。
文档更新时间: 2018-06-07 00:34