Skip to API content
TalkLabs API Docs v3
Recipes
GET Moderate chat

List Room User Effects

Users can have effects applied such as mute, ban, and so on.

GET /api/v3/{appid}/chat/rooms/{roomid}/usereffects

Users can have effects applied such as mute, ban, and so on. This method returns a list of all users in the room that have one or more effect on them (that has not expired).

It is possible for the user to appear more than once in the list if there is more than one effect on the user.

Request

Parameters

Values in the path and query string.

appid path
string TalkLabs ID required

The TalkLabs application ID assigned to your account.

Example: your-app-id
roomid path
string TalkLabs ID required

The TalkLabs assigned room ID returned when the room was created.

Example: room-id
Response

Status codes

Every JSON response uses the API result envelope.

200 OK ApiResult
400 Bad Request ApiResult
403 Forbidden ApiResult
404 Not Found ApiResult
500 Internal Server Error ApiResult
Search all 118 endpoints Try “join room”, “moderate”, or “POST”.
Request environment

Connect your application

These values fill request examples and the API console. They stay in this browser tab and are never sent to TalkLabs until you run a request.

Credentials are stored in sessionStorage, not in cookies or analytics.