Get Personal Message List

POST

/msg/list

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://app.workzappy.com/openapi/api/msg/list' \
--header 'accessToken: {{accessToken}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "read": true,
    "pageNumber": 1,
    "pageSize": 10,
    "category": [
        "comment"
    ]
}'

Response Example

{
    "code": "0",
    "data": {
        "total": 1,
        "list": [
            {
                "receiverId": 1,
                "triggerName": "xxx",
                "createTime": 1646301600000,
                "reminderReceiveId": 1,
                "subject": "xxx",
                "receiverName": "xxx",
                "msgId": 1,
                "action": "at",
                "hasRead": 1,
                "plainReceiverName": "xxx",
                "content": "xxx"
            }
        ]
    }
}

Request

Header Params

Content-Type

string

required

Example:

application/json

accessToken

string

required

Example:

{{accessToken}}

Body Params application/json

read

boolean

optional

Message Read Flag

pageNumber

integer <int32>

optional

Page Number

pageSize

integer <int32>

optional

Page Size

category

array [object]

optional

Message Category,comment(@Me)/follow(Watching)/responsible(Direct)/automation_station_msg(Automation)/sys(System Notification)

Examples

Responses

🟢200OK

application/json

Body

receiverId

integer <int64>

optional

Message Receiver ID

triggerName

string

optional

Message Trigger User Name

createTime

string <date>

optional

Creation Time

reminderReceiveId

integer <int64>

optional

Reminder Receive ID

subject

string

optional

Message Subject

receiverName

string

optional

Receiver User Name

msgId

integer <int64>

optional

Message ID

action

string

optional

Message Action

hasRead

string <byte>

optional

Read Flag (1:Yes 0:No)

<= 4 characters

plainReceiverName

string

optional

纯文本

content

string

optional

Message Content

Modified at 2025-03-20 02:41:15