Reference
Fuselage
Channel Online
Lists all online users of a channel if the channel's id is provided, otherwise it gets all online users of all channels. It supports the Query Parameters only.
URL
Requires Auth
HTTP Method
/api/v1/channels.online
yes
GET

Query Parameters

Argument
Example
Required
Description
query
{"_id":"5HmCfpoB7jp2uibTC"}
Optional

Example Call

1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
http://localhost:3000/api/v1/channels.online
Copied!

Example Result

1
{
2
"online": [
3
{
4
"_id": "47cRd58HnWwpqxhaZ",
5
"username": "test"
6
},
7
{
8
"_id": "BsxzC22xQ43taWdff",
9
"username": "uniqueusername"
10
}
11
],
12
"success": true
13
}
Copied!

Query Example Call

This example shows how to filter using channel's id.
1
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
2
-H "X-User-Id: aobEdbYhXfu5hkeqG" \
3
http://localhost:3000/api/v1/channels.online?query={"_id": "5HmCfpoB7jp2uibTC"}
Copied!

Query Example Result

1
{
2
"online": [
3
{
4
"_id": "47cRd58HnWwpqxhaZ",
5
"username": "test"
6
}
7
],
8
"success": true
9
}
Copied!

Change Log

Version
Description
0.52.0
Added
Last modified 8mo ago