Fuselage
Get Starred Messages
Retrieve starred messages. It supports the Offset, Count, and Sort Query Parameters.
URL
Requires Auth
HTTP Method
/api/v1/chat.getStarredMessages
yes
GET

Query Parameters

Argument
Example
Required
Description
roomId
ByehQjC44FwMeiLbX
Required
The room id

Example Call

1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
http://localhost:3000/api/v1/chat.getStarredMessages?roomId=ByehQjC44FwMeiLbX
Copied!

Example Result

1
{
2
"messages": [
3
{
4
"_id": "ePeoiJQ3Qfc4556TW",
5
"rid": "GENERAL",
6
"msg": "fsdfs",
7
"ts": "2019-10-09T19:17:21.883Z",
8
"u": {
9
"_id": "rocketchat.internal.admin.test",
10
"username": "rocketchat.internal.admin.test",
11
"name": "RocketChat Internal Admin Test"
12
},
13
"_updatedAt": "2019-10-09T19:17:25.196Z",
14
"mentions": [],
15
"channels": [],
16
"starred": [
17
{
18
"_id": "rocketchat.internal.admin.test"
19
}
20
]
21
}
22
],
23
"count": 2,
24
"offset": 0,
25
"total": 2,
26
"success": true
27
}
Copied!

Change Log

Version
Description
2.2.0
Added
Export as PDF
Copy link
Edit on GitHub