Get Room Information
- Print
- DarkLight
- PDF
Get Room Information
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/rooms.info
Retrieves the information about the room.
Changelog
| Version | Description |
|---|---|
| 0.72.0 | Added |
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
string
The room id. It is required if the roomName is not provided.
Exampledlpfuijw7ej
roomName
string
The room name. It is required if the roomId is not provided.
Examplegeneral
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 }
Responses
200
OK
Example 1
{
"room": {
"_id": "6513afeda2f73c7460e18c86",
"fname": "messages",
"_updatedAt": "2023-09-27T21:19:59.029Z",
"customFields": {},
"topic": "",
"broadcast": false,
"encrypted": false,
"name": "messages",
"t": "c",
"msgs": 8,
"usersCount": 2,
"u": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie",
"name": "test test"
},
"ts": "2023-09-27T04:30:37.236Z",
"ro": false,
"default": false,
"sysMes": true,
"lastMessage": {
"_id": "rKspZMxspNiWf5TuY",
"rid": "6513afeda2f73c7460e18c86",
"msg": "@rocket.cat whats the way forward",
"ts": "2023-09-27T20:33:10.204Z",
"u": {
"_id": "rbAXPnMktTFbNpwtJ",
"username": "roxie",
"name": "test test"
},
"_updatedAt": "2023-09-27T20:33:10.314Z",
"urls": [],
"mentions": [
{
"_id": "rocket.cat",
"name": "Rocket.Cat",
"username": "rocket.cat",
"type": "user"
}
],
"channels": [],
"md": [
{
"type": "PARAGRAPH",
"value": [
{
"type": "MENTION_USER",
"value": {
"type": "PLAIN_TEXT",
"value": "rocket.cat"
}
},
{
"type": "PLAIN_TEXT",
"value": "whats the way forward"
}
]
}
]
},
"lm": "2023-09-27T20:33:10.204Z",
"archived": false,
"teamId": "65149c7ea2f73c7460e18cab",
"teamMain": true
},
"success": true
}object
room
object
_id
string
fname
string
_updatedAt
string
customFields
object
topic
string
broadcast
boolean
encrypted
boolean
name
string
t
string
msgs
integer
usersCount
integer
u
object
_id
string
username
string
name
string
ts
string
ro
boolean
default
boolean
sysMes
boolean
lastMessage
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
_id
string
name
string
username
string
type
string
channels
Array of object
object
md
Array of object
object
type
string
value
Array of object
object
type
string
value
string
lm
string
archived
boolean
teamId
string
teamMain
boolean
success
boolean
Was this article helpful?