Lists the users of participants of a private group. It supports the Offset, Count, and Sort Query Parameters.
Requires view-broadcast-member-list
if room is a broadcast.
URL | Requires Auth | HTTP Method |
|
|
|
Argument | Example | Required | Description |
|
| Required | The room id. The room name. |
curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \-H "X-User-Id: aobEdbYhXfu5hkeqG" \http://localhost:3000/api/v1/groups.members?roomId=ByehQjC44FwMeiLbX
{"members": [{"_id": "Q4GkX6RMepGDdQ7YJ","status": "online","name": "Marcos Defendi","utcOffset": -3,"username": "marcos.defendi"},{"_id": "rocket.cat","name": "Rocket.Cat","username": "rocket.cat","status": "online","utcOffset": 0}],"count": 2,"offset": 0,"total": 2,"success": true}
Version | Description |
0.59.0 | Added |