Get
/api/v1/channels.online
List all online users in a particular channel.
Changelog
| Version | Description |
|---|---|
| 0.52.0 | Added |
| 7.0.0 | Replaced query parameter with _id parameter |
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
_id
stringRequired
The channel's id.
Example5HmCfpoB7jp2uibTC
Responses
200
OK
Example
{
"online": [
{
"_id": "47cRd58HnWwpqxhaZ",
"username": "test"
},
{
"_id": "BsxzC22xQ43taWdff",
"username": "uniqueusername"
}
],
"success": true
}object
online
Array of object
object
_id
string
username
string
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string