List all the messages in a DM.
Changelog
| Version | Description |
|---|---|
| 7.0.0 | Added mentionIds, starredIds, pinned query parameters. |
| 0.59.0 | Added |
The authToken of the authenticated user.
The userId of the authenticated user.
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items. Refer to the official documentation to learn more.
List of fields to order by, and in which direction. This is a JSON object, with properties listed in desired order, with values of 1 for ascending, or -1 for descending. For example, { "value": -1, "_id": 1 }. Refer to the official documentation to learn more.
This parameter accepts a JSON object with properties that have a value of 1 or 0 to include or exclude them in the response. For example, to only retrieve the usernames of users: fields={ "username": 1 }. Refer to the official documentation to learn more.
This parameter allows you to use MongoDB query operators to search for specific data. For example, to query users with a name that contains the letter "g": query={ "name": { "$regex": "g" }}. Refer to the official documentation to learn more.
The room ID of the DM. It is required if username is not provided.
The username of the user in the DM. It is required if roomId is not provided.
Filter the messages where a user has been mentioned by the userId. For a set of userIds, use an array (["838ndhd79w", "dud0wu900"]).
Filter the messages a user have starred by userId. For a set of userIds, use an array (["838ndhd79w", "dud0wu900"]).
Filter pinned messages.
OK
{
"messages": [
{
"_id": "dGNzxH29pFm4Qhufh",
"rid": "5fRTXMt7DMJbpPJfhgzvcvpov9G4TxbGFS",
"msg": "DO we have any updates today?",
"ts": "2023-11-01T23:20:57.357Z",
"u": {
"_id": "5fRTXMt7DMJbpPJfh",
"username": "test.john",
"name": "Test John"
},
"_updatedAt": "2023-11-01T23:20:57.406Z",
"urls": [],
"mentions": [],
"channels": [],
"md": [
{
"type": "PARAGRAPH",
"value": [
{
"type": "PLAIN_TEXT",
"value": "DO we have any updates today?"
}
]
}
]
},
{
"_id": "aiaCSRkxPcNGHqvtC",
"rid": "5fRTXMt7DMJbpPJfhgzvcvpov9G4TxbGFS",
"msg": "Hows it going?",
"ts": "2023-11-01T23:20:51.504Z",
"u": {
"_id": "5fRTXMt7DMJbpPJfh",
"username": "test.john",
"name": "Test John"
},
"_updatedAt": "2023-11-01T23:20:51.549Z",
"urls": [],
"mentions": [],
"channels": [],
"md": [
{
"type": "PARAGRAPH",
"value": [
{
"type": "PLAIN_TEXT",
"value": "Hows it going?"
}
]
}
]
},
{
"_id": "dLjcNr8ovyeCqqJW5",
"rid": "5fRTXMt7DMJbpPJfhgzvcvpov9G4TxbGFS",
"msg": "Hi buddy",
"ts": "2023-11-01T23:20:47.991Z",
"u": {
"_id": "5fRTXMt7DMJbpPJfh",
"username": "test.john",
"name": "Test John"
},
"_updatedAt": "2023-11-01T23:20:48.085Z",
"urls": [],
"mentions": [],
"channels": [],
"md": [
{
"type": "PARAGRAPH",
"value": [
{
"type": "PLAIN_TEXT",
"value": "Hi buddy"
}
]
}
]
}
],
"count": 3,
"offset": 0,
"total": 3,
"success": true
}Bad Request
{
"success": false,
"error": "must have required property 'roomId'\n must have required property 'username'\n must match exactly one schema in oneOf [invalid-params]",
"errorType": "invalid-params"
}{
"success": false,
"error": "[invalid-channel]",
"errorType": "invalid-channel"
}Unauthorized
{
"status": "error",
"message": "You must be logged in to do this."
}