Message Module

Project: Pet Feeder | page_id: 1730

Message Authentication Interface Documentation

Overview

• Base path: /api
• Documentation scope: message module interfaces in the authenticated routes
• Authentication method: request header X-Token
• Content-Type: application/json

Authentication Header

Unified Response Format

{
  "code": 200,
  "msg": "Operation successful",
  "data": {}
}

Message Object Field Description

1. Get the Message List

• Path: /api/message/list
• Method: POST
• Authentication required: Yes

Request Body Parameters

Request Example

{
  "type": "feed",
  "page": 1,
  "pageSize": 20
}

Success Response Example

{
  "code": 200,
  "msg": "Operation successful",
  "data": {
    "list": [
      {
        "userId": 1,
        "type": "feed",
        "title": "Feeding successful",
        "content": "Device dev_001 has completed feeding",
        "read": false,
        "createdAt": "2026-05-09T10:00:00Z"
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 20
  }
}

Failure Response Example

{
  "code": 400,
  "msg": "Incorrect page parameter",
  "data": null
}

{
  "code": 400,
  "msg": "Incorrect pageSize parameter",
  "data": null
}

{
  "code": 500,
  "msg": "Failed to get the message list",
  "data": null
}

2. Mark a Message as Read

• Path: /api/message/markRead
• Method: POST
• Authentication required: Yes

Request Body Parameters

Request Example

{
  "id": 123
}

Mark all as read:

{}

Success Response Example

{
  "code": 200,
  "msg": "Marked as read",
  "data": null
}

{
  "code": 200,
  "msg": "All marked as read",
  "data": null
}

Failure Response Example

{
  "code": 400,
  "msg": "Parameter error",
  "data": null
}

{
  "code": 400,
  "msg": "Marking failed",
  "data": null
}

{
  "code": 500,
  "msg": "Operation failed",
  "data": null
}

3. Clear Messages

• Path: /api/message/clear
• Method: POST
• Authentication required: Yes

Request Body

No business parameters; an empty object can be passed:

{}

Success Response Example

{
  "code": 200,
  "msg": "Messages cleared",
  "data": null
}

Failure Response Example

{
  "code": 500,
  "msg": "Failed to clear messages",
  "data": null
}