List DM Messages
- Print
- DarkLight
- PDF
List DM Messages
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/im.messages
List all the messages in a DM.
Changelog
| Version | Description |
|---|---|
| 0.59.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Query parameters
offset
integer
Number of items to "skip" in the query, i.e. requests return count items, skipping the first offset items.
Example50
count
integer
The number of items to return.
Example50
sort
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 }
query
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" }}
fields
string
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 }
roomId
string
The room ID of the DM. It is required if username is not provided.
username
string
The username of the user in the DM. It is required if roomId is not provided.
Responses
200
OK
Example 1
{
"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
}object
messages
Array of object
object
_id
string
rid
string
msg
string
ts
string
u
object
_id
string
username
string
name
string
_updatedAt
string
urls
Array of object
object
mentions
Array of object
object
channels
Array of object
object
md
Array of object
object
type
string
value
Array of object
object
type
string
value
string
count
integer
offset
integer
total
integer
success
boolean
400
Bad Request
Example 1
{
"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"
}Example 2
{
"success": false,
"error": "[invalid-channel]",
"errorType": "invalid-channel"
}object
success
boolean
error
string
errorType
string
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?