Get Starred Messages
- Print
- DarkLight
- PDF
Get Starred Messages
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/chat.getStarredMessages
Header parameters
X-User-Id
stringRequired
The userId of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
X-Auth-Token
stringRequired
The authToken of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
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 1
{
"messages": [
{
"_id": "652dc4dda2f73c7460e18df8",
"t": "discussion-created",
"rid": "6GFJ3tbmHiyHbahmC",
"ts": "2023-10-16T23:18:53.926Z",
"msg": "test discuss",
"u": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie",
"name": "test test"
},
"groupable": false,
"drid": "652dc4dda2f73c7460e18df6",
"_updatedAt": "2023-10-17T12:51:07.826Z",
"dcount": 3,
"dlm": "2023-10-16T23:25:58.375Z",
"starred": [
{
"_id": "5fRTXMt7DMJbpPJfh"
}
]
}
],
"count": 1,
"offset": 0,
"total": 1,
"success": true
}object
messages
Array of object
object
_id
string
t
string
rid
string
ts
string
msg
string
u
object
_id
string
username
string
name
string
groupable
boolean
drid
string
_updatedAt
string
dcount
integer
dlm
string
starred
Array of object
object
_id
string
count
integer
offset
integer
total
integer
success
boolean
400
Bad Request
Example 1
{
"success": false,
"error": "The required \"roomId\" query param is missing. [error-invalid-params]",
"errorType": "error-invalid-params"
}Incorrect room ID
{
"success": false,
"error": "error-not-allowed"
}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?