Fuselage
Rooms Info
REST API Rooms Info Methods
Retrieves the information about the room. It supports Fields Query Parameters only.
URL
Requires Auth
HTTP Method
/api/v1/rooms.info
yes
GET

Query Parameters

Argument
Example
Required
Description
roomId
ByehQjC44FwMeiLbX
Required (if no roomName)
The rooms's id
roomName
general
Required (if no roomId)
The rooms's name

Example Call

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

Example Result

1
{
2
"room": {
3
"_id": "ByehQjC44FwMeiLbX",
4
"name": "testing",
5
"fname": "testing",
6
"t": "c",
7
"msgs": 0,
8
"usersCount": 2,
9
"u": {
10
"_id": "HKKPmF8rZh45GMHWH",
11
"username": "marcos.defendi"
12
},
13
"customFields": {},
14
"broadcast": false,
15
"encrypted": false,
16
"ts": "2020-05-21T13:14:07.070Z",
17
"ro": false,
18
"default": false,
19
"sysMes": true,
20
"_updatedAt": "2020-05-21T13:14:07.096Z"
21
},
22
"success": true
23
}
Copied!

Example Call with fields query parameters

1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
http://localhost:3000/api/v1/rooms.info?roomId=ByehQjC44FwMeiLbX&fields={"name": 1}
Copied!

Example Result

1
{
2
"room": {
3
"_id": "ByehQjC44FwMeiLbX",
4
"name": "testing"
5
},
6
"success": true
7
}
Copied!

Change Log

Version
Description
0.72.0
Added
Last modified 8mo ago