messages.query
Description
List messages by specified filter criteria.
Params
- token
- string
-
Access token.
- filterOptions
- struct
- optional
-
- userNames
- array
- optional
-
Show only messages between you and specified user(s).
- userName
- string
-
Name of one user who use for filter.
- showUnread
- bool
- optional
- default: true
-
Show unread messages
- showRead
- bool
- optional
- default: true
-
Show read messages
- showSent
- bool
- optional
- default: true
-
Show sent messages
- showReceived
- bool
- optional
- default: true
-
Show received messages
- displayOptions
- struct
- optional
-
Display options
Response
- response
- struct
-
- status
- int
- enum
-
Status code
Value Description 200OK
400Bad params
404One of users specified in
filterOptions.userNameswas not found.500Server error
- statusMessage
- string
-
Status code description
- messages
- array
-
List of returned messages
- message
- struct
-
- id
- int
-
Message ID
- direction
- string
- enum
-
Direction of message
Value Description incommingMessage is incomming
outgoingMessage is outgoing
- otherUser
- string
-
Name of user who sent or to who is the message targeted
- date
- datetime
-
Date and time when the message was sent
- isRead
- bool
-
True if message is readed.
- subject
- string
-
Subject of message
- text
- string
-
Message text
- totalCount
- int
-
Total number of messages regardless limit and offset.
Call example
messages.query("exercitation", {"userNames": ["veniam quis"], "showUnread": false, "showRead": false, "showSent": false, "showReceived": false}, {"limit": 1165135048, "offset": 108304030})