Get Room Roles (Realtime)

Prev Next

This method has been deprecated from version 7.11.0 and will be removed in version 8.0.0. Use the rooms.roles endpoint instead.

Get a collection of users and their roles per room. You can send a collection of room IDs (at least one).

The user roles per room object is defined as:

  • rid: The room ID this user and role belong to.

  • u: A simple user object with the user ID and username.

  • roles: The collection of roles of the user in the room.

  • _id: the ID of this object.

Example call

{
    "msg": "method",
    "method": "getRoomRoles",
    "id": "42",
    "params": [ "room-id" ]
}

Example response

{
    "msg": "result",
    "id": "42",
    "result": [
        {
            "rid": "room-id",
            "u": { "_id": "user-id", "username": "username" },
            "roles": [ "role-name" ],
            "_id": "id"
        }
    ]
}