bans.md

bans Endpoint

The bans endpoint retrieves a list of active bans.

Note: You need to have sufficient permissions in the room to access this resource, otherwise you'll just be greeted with a requestError status.

Reason: The reason member is set as a single number which represent the following reasons:

1: (SPAMMING) User spammed the chat

2: (VERBAL_ABUSE) User was harsh to other community members

3: (OFFENSIVE_VIDEOS) User was playing offensive media

4: (PLAYING_INAPPROPIATE_GENRES) User was playing inappropiate media repeatedly

5: (NEGATIVE_ATTITUDE) User was having a negative attitude towards others

BanDuration: The duration member can have the following values:

f: User is banned permanently

d: User is banned for a day

h: User is banned for an hour

More ban information here.

Endpoint

bans

bans/:userID

Method

GET, DELETE

Possible error messages for GET

Insufficient permissions

{
    "data": [
        "You are not authorized to access this resource."
    ],
    "status": "notAuthorized",
}

Data returned for GET

{
    'data': [{                  // Contains the requested data
        'duration': 'x',        // See BanDuration above
        'moderator': 'xxxx',    // Name of the moderator
        'reason': 1,            // Reason why they got banned. See BanReason above
        'id': -1,               // ID of the user
        'timestamp': 'xxx',     // Date when the ban became active
        'username': 'xxxx'      // Name of the user
    }],
    'meta': {},
    'status': 'ok',
    'time': 'xx.xxxxxxxxxxx'
}

Parameters for DELETE

userID: ID of the user you want to unban

Possible error messages for DELETE

Insufficient permissions

{
    "data": [
        "You are not authorized to access this resource."
    ],
    "status": "notAuthorized",
}

Data returned for DELETE

{
    'data': [],
    'meta': {},
    'status': 'ok',
    'time': 'xx.xxxxxxxxxxx'
}