查询消息

更新时间：2022-01-24 10:16:27

本文介绍查询消息的 API。

接口描述

分页查询消息

接口地址

GET: /v1.0/sdf/notifications/messages

请求参数

参数名	类型	参数位置	是否必填	说明
recipient_id	String	query	true	接收人 ID
message_type	String	query	false	消息类型。 1：设备消息 3：系统通知 4：业务消息如果查询所有消息类型数据，该字段传空值。
message_sub_type	String	query	false	消息子类型。 40：设备告警 41：设备离线 50：用户角色变更如果查询所有消息子类型数据，该字段传空值。
read_flag	String	query	false	是否已读标记。 0：未读 1：已读如果查询所有已读和未读消息，该字段传空值。
page_no	Integer	query	false	分页页码
page_size	Integer	query	false	分页页面大小

返回参数

参数名	类型	说明
result	PageRes

result 说明

参数名	类型	说明
total	Integer	总记录数
list	List	数据列表
has_more	Boolean	是否有下一页

list 说明

参数名	类型	说明
message_id	String	通知消息 ID
message_category	String	消息种类
message_category_description	String	消息种类描述
message_type	String	消息类型
message_type_description	String	消息类型描述
message_sub_type	String	消息子类型
message_title	String	消息标题
message_content	String	消息内容
create_time	String	创建时间
read_status	String	已读/未读状态。 1：已读 0：未读

请求示例

GET: /v1.0/sdf/notifications/messages?recipient_id=bay163****&message_type=1&message_sub_type=41&read_flag=0&page_no=1&page_size=10

返回示例

{
    "result": {
        "list": [
            {
                "create_time": "2021-11-22 06:15",
                "message_title": "设备离线",
                "message_category": "PLATFORM",
                "read_status": "0",
                "message_id": "6162****",
                "message_type": "1",
                "message_type_description": "设备消息",
                "message_content": "真实00(6c027****)已离线",
                "message_category_description": "平台",
                "message_sub_type": "41"
            },
            {
                "create_time": "2021-11-21 21:03",
                "message_title": "设备离线",
                "message_category": "PLATFORM",
                "read_status": "0",
                "message_id": "6110****",
                "message_type": "1",
                "message_type_description": "设备消息",
                "message_content": "香薰机(33071012****)已离线",
                "message_category_description": "平台",
                "message_sub_type": "41"
            }
        ],
        "total": 2,
        "has_more": true
    },
    "t": 1637564235282,
    "success": true
}

错误码

参考错误码。