List Online Users in a Channel
- Print
- DarkLight
- PDF
List Online Users in a Channel
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/channels.online
List all online users in a channel. If the channel's id is not provided, it lists all the online users of all the channels.
Changelog
| Version | Description |
|---|---|
| 0.52.0 | Added |
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
query
Required
An object of the channel's id.
object
Example{"_id": "5HmCfpoB7jp2uibTC"}
_id
string
Example{"_id": "5HmCfpoB7jp2uibTC"}
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
Was this article helpful?