消息中心.md 7.91 KB

1.## 获取用户的消息列表##

获取用户的消息列表(method=app.social.getInboxList)

公共请求参数

参数名称 参数类型 长度 可否为空 示例 默认值 备注
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 (手机尺寸)

请求参数

参数名称 参数类型 长度 可否为空 示例 默认值 备注
uid String 1-11 80 帖子id
type String 1 1 消息类型 1系统消息 2点赞 3帖子被回复
lastedTime String 13 1467343834000 10 时间戳
limit String 1-11 10 一页展示条数

接口说明

接口说明
请求域名 http://api.yoho.cn
接口名 app.social.getInboxList
接口说明 获取用户的消息列表
http请求方式 POST/GET

返回错误

错误code 错误提示
400 uid is null
400 消息类型不能为空

注意,通用的头部没有列出。
请求示例 http://192.168.102.206:8095/social/?method=app.social.getInboxList&uid=8050426&debug=XYZ&type=3&limit=10

响应

code为200即为成功,否则是失败。 响应参数,data部分
响应成功JSON格式如下所示:

{
  "code": 200,
  "message": "获取消息列表成功",
  "md5": "dc53b520e812622f4a91df1e49013a3c",
  "alg": "SALT_MD5",
  "data": {
    "total": 1,
    "pageSize": 30,
    "lastedTime": 1468912451102,
    "list": [
      {
        "id": 16,
        "uid": 10863703,
        "title": "帖子被首页置顶",
        "type": "1",
        "isRead": "N",
        "createTime": 1469605696673,
        "content": {
          "subTitle": "您发布的帖子太棒啦!已被管理员在首页置顶",
          "postInfo": {
            "forumName": "复古市集会",
            "forumCode": "10001",
            "postId": "1728",
            "content": "%E5%9B%9E%E5%A4%8D%E6%B5%8B%E8%AF%95"
          },
          "type": "1"
        }
      },
      {
        "id": 2,
        "uid": 10863703,
        "title": "您已被禁言",
        "type": "1",
        "isRead": "Y",
        "createTime": 1469598967658,
        "content": {
          "subTitle": "因为违反社区相关规定,您已被禁言,如有疑问请咨询客服人员。",
          "type": "2"
        }
      }
    ]
  }
}
{
  "code": 200,
  "message": "获取消息列表成功",
  "md5": "90c4a07cfc3ac66ea5287c722f4ea434",
  "alg": "SALT_MD5",
  "data": {
    "total": 8,
    "pageSize": 1,
    "lastedTime": 1468931593743,
    "list": [
      {
        "id": 42,
        "uid": 8050426,
        "title": "赞了你的帖子",
        "type": "2",
        "isRead": "Y",
        "createTime": 1468931593743,
        "content": {
          "userInfo": {
            "nickName": "Tan",
            "headIcon": "http://head.static.yhbimg.com/yhb-head/2016/07/22/20/0235791f1dce33feeb5b00660b8f9f505e.jpg?imageView/{mode}/w/{width}/h/{height}",
            "uid": 9599513,
            "signature": null,
            "bgPic": "?imageView/{mode}/w/{width}/h/{height}"
          },
          "postInfo": {
            "forumCode": "10001",
            "postId": "1026",
            "content": "http://img12.static.yhbimg.com/yhb-img01/2015/09/22/04/02bc6de346770f9b71a4519488185dc5e9.jpg"
          }
        }
      }
    ]
  }
}
{
  "code": 200,
  "message": "获取消息列表成功",
  "md5": "7f1df192e33d3494d4676e2114885341",
  "alg": "SALT_MD5",
  "data": {
    "total": 19,
    "pageSize": 1,
    "lastedTime": 1469424935420,
    "list": [
      {
        "id": 70,
        "uid": 8050426,
        "title": "8050429 只回复文字",
        "type": "3",
        "isRead": "Y",
        "createTime": 1469424935420,
        "content": {
          "userInfo": {
            "nickName": "心灰意冷",
            "headIcon": "http://img02.res.yohoshow.com/headimg/2014/01/11/18/026d2fe3184b54e3ed1d633806cbe94b1d.jpg?imageView/{mode}/w/{width}/h/{height}",
            "uid": 8050429,
            "signature": "陈光荣-头文字D",
            "bgPic": "http://img03.res.yohoshow.com/headimg/2014/08/11/08/01701f83b911bc874fb9435d311db0aaf2.jpg?imageView/{mode}/w/{width}/h/{height}"
          },
          "subTitle": "回复我的帖子:戴帽时刘海不知道往哪分!?几条tips帮助你!",
          "postInfo": {
            "forumName": "复古市集会",
            "forumCode": "10001",
            "postId": "1026"
          }
        }
      }
    ]
  }
}

响应失败JSON格式如下所示:

{
  "code": 400,
  "message": "uid is null",
  "md5": "6d729d4b35f10fc73531210bd7ecff91",
  "alg": "SALT_MD5",
  "data": []
}
{
  "code": 400,
  "message": "消息类型不能为空",
  "md5": "6d729d4b35f10fc73531210bd7ecff91",
  "alg": "SALT_MD5",
  "data": []
}

2.## 根据用户id以及消息id列表批量删除消息##

根据用户id以及消息id列表批量删除消息(method=app.social.delmessage)

公共请求参数

参数名称 参数类型 长度 可否为空 示例 默认值 备注
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 (手机尺寸)

请求参数

参数名称 参数类型 长度 可否为空 示例 默认值 备注
uid String 1-11 5451281 ssouid
ids String 1-11 10,11,12 消息id集合

接口说明

接口说明
请求域名 http://api.yoho.cn
接口名 app.social.delmessage
接口说明 根据用户id以及消息id列表批量删除消息
http请求方式 POST/GET

返回错误

错误code 错误提示
400 uid is null

注意,通用的头部没有列出。
请求示例 http://localhost:8095/social/?method=app.social.delmessage&uid=8050426&debug=XYZ&ids=16,18

响应

code为200即为成功,否则是失败。 响应参数,data部分
响应成功JSON格式如下所示:

{
  "code": 200,
  "message": "删除成功.",
  "md5": "6d729d4b35f10fc73531210bd7ecff91",
  "alg": "SALT_MD5",
  "data": []
}

响应失败JSON格式如下所示:

{
  "code": 400,
  "message": "uid is null",
  "md5": "6d729d4b35f10fc73531210bd7ecff91",
  "alg": "SALT_MD5",
  "data": []
}

3.## 获取消息首页信息##

获取消息首页信息(method=app.social.getInboxIndexInfo)

公共请求参数

参数名称 参数类型 长度 可否为空 示例 默认值 备注
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 (手机尺寸)

请求参数

参数名称 参数类型 长度 可否为空 示例 默认值 备注
uid String 1-11 5451281 ssouid

接口说明

接口说明
请求域名 http://api.yoho.cn
接口名 app.social.delmessage
接口说明 根据用户id以及消息id列表批量删除消息
http请求方式 POST/GET

返回错误

错误code 错误提示
400 uid is null

注意,通用的头部没有列出。
请求示例 http://localhost:8095/social/?method=app.social.getInboxIndexInfo&uid=8050426&debug=XYZ&limit=1

响应

code为200即为成功,否则是失败。 响应参数,data部分
响应成功JSON格式如下所示:

{
  "code": 200,
  "message": "获取消息中心信息成功.",
  "md5": "4fcc158f2e090f1814f36ac5c88888aa",
  "alg": "SALT_MD5",
  "data": {
    "praiseMsg": {
      "id": 42,
      "title": "小明赞了你的帖子",
      "isRead": "Y",
      "createTime": 1468931593743
    },
    "systemMsg": {
      "id": 43,
      "title": "帖子被设为热门",
      "isRead": "Y",
      "createTime": 1468931593743
    },
    "praiseNoReadMsgCount": 124,
    "systemNoReadMsgCount": 0
  }
}

响应失败JSON格式如下所示:

{
  "code": 400,
  "message": "uid is null",
  "md5": "6d729d4b35f10fc73531210bd7ecff91",
  "alg": "SALT_MD5",
  "data": []
}