Welcome

Channel Roles

Lists all user’s roles in the channel.

URL Requires Auth HTTP Method
/api/v1/channels.roles yes GET

Query Parameters

Argument Example Required Description
roomId ByehQjC44FwMeiLbX Required(if no roomName) The channel’s id
roomName general Required(if no roomId) The channel’s name

Example Call

curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     http://localhost:3000/api/v1/channels.roles?roomId=ByehQjC44FwMeiLbX

Example Result

{
    "roles": [
        {
            "rid": "BaE62jfDLXK3Xo6BA",
            "u": {
               "_id": "BkNkw3iKgNyhMbPyW",
               "username": "ronnie.dio",
               "name": "Ronnie James Dio"
            },
            "roles": [
               "moderator"
            ],
            "_id": "ehPuGyZBedznJsQHp"
        }
    ],
    "success": true
}

Change Log

Version Description
0.65.0 Added

Table of contents