Get Channel Counters
- Print
- DarkLight
- PDF
Get Channel Counters
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/channels.counters
Gets channel information related to a user.
Permission required: view-room-administration
Changelog
| Version | Description |
|---|---|
| 0.65.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
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
userId
string
The user ID.
ExampleRtycPC29hqLJfT9xj
Responses
200
OK
Note
joinedboolean flag whether the user has joined the room or not.membersis the count of current room members.unreadsis the count of unread messages for the specified user (for the calling user or the provided user ID).unreadsFromis the start date-time of unread interval for the specified user.msgsis the count of messages in the room.latestis the end date-time of unread interval for the specified user (or date-time of last posted message).userMentionsis the count of user mentions in messages.
Example 1
{
"joined": true,
"members": 23,
"unreads": 2,
"unreadsFrom": "2023-09-12T16:33:11.644Z",
"msgs": 7345,
"latest": "2023-09-25T22:50:07.979Z",
"userMentions": 0,
"success": true
}object
joined
boolean
members
integer
unreads
integer
unreadsFrom
string
msgs
integer
latest
string
userMentions
integer
success
boolean
Was this article helpful?