Get Snippeted Messages
- Print
- DarkLight
- PDF
Get Snippeted Messages
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/chat.getSnippetedMessages
Retrieve snippeted messages.
Changelog
Version | Description |
---|---|
2.3.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
roomId
stringRequired
The room ID.
Example6GFJ3tbmHiyHbahmC
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 }
Responses
200
OK
Example
{
"messages": [
{
"_id": "string",
"rid": "string",
"msg": "string",
"ts": "string",
"u": {
"_id": "string",
"username": "string",
"name": "string"
},
"_updatedAt": "string",
"mentions": [
{}
],
"channels": [
{}
],
"snippetName": "string",
"snippeted": true,
"snippetedBy": {
"_id": "string",
"username": "string"
}
}
],
"count": 0,
"offset": 0,
"total": 0,
"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
mentions
Array of object
object
channels
Array of object
object
snippetName
string
snippeted
boolean
snippetedBy
object
_id
string
username
string
count
integer
offset
integer
total
integer
success
boolean
Was this article helpful?