Moderation Tools

React

Client SDKs

Backend SDKs

Flag

Confused about "Flag "?

Let us know how we can improve our documentation:

Any user is allowed to flag a message.

1
const flag = await client.flagMessage(messageResponse.message.id);

1
$flag = $client->flagMessage('message-id', ['user_id' => 'user-id']);

1
await client.flagMessage("messageID");

1
2
3
4
5
6
7
8
9
10
11
12
let message = Message(text: "bad bad sentence") 
message.flag { (result) in 
    // handle result 
} 
 
// and unflag 
message.unflag { (result) in /**/ } 
 
let john = User(id: "john") 
User.current.flag(user: john) { (result) in /**/ } 
 
User.current.unflag(user: john) { (result) in /**/ }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
client.flagMessage("message-id").enqueue(result -> { 
    if (result.isSuccess()) { 
        // Message was flagged 
        Flag flag = result.data(); 
    } else { 
        // Handle result.error() 
     } 
}); 
 
client.flagUser("user-id").enqueue(result -> { 
    if (result.isSuccess()) { 
        // User was flagged 
        Flag flag = result.data(); 
    } else { 
        // Handle result.error() 
    } 
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
client.flagMessage("message-id").enqueue { result -> 
    if (result.isSuccess) { 
        // Message was flagged 
        val flag: Flag = result.data() 
    } else { 
        // Handle result.error() 
    } 
} 
 
client.flagUser("user-id").enqueue { result -> 
    if (result.isSuccess) { 
        // User was flagged 
        val flag: Flag = result.data() 
    } else { 
        // Handle result.error() 
    } 
}

Mutes

Confused about "Mutes"?

Let us know how we can improve our documentation:

Any user is allowed to mute another user. Mutes are stored at user level and returned with the rest of the user information when connectUser is called. A user will be be muted until the user is unmuted or the mute is expired.

name	type	description	default	optional
timeout	number	The timeout in minutes until the mute is expired.	no limit	✓

1
2
3
4
5
6
7
8
9
10
// client-side mute 
const mute = await client.muteUser('eviluser'); 
 
// client-side mute for 60 minutes 
const mute = await client.muteUser('eviluser', null, { 
    timeout: 60 
}); 
 
// server-side mute requires the id of the user creating the mute as well 
const mute = await client.muteUser('eviluser', 'user_id');

1
2
// server-side mute requires the id of the user creating the mute as well 
$mute = $client->muteUser('evil-user', 'user-id');

1
2
3
await client.muteUser("eviluser"); 
 
await client.unmuteUser("eviluser");

1
2
3
let john = User(id: "john") 
john.mute { (result) in /**/ } 
john.unmute { (result) in /**/ }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
client.muteUser("user-id").enqueue(result -> { 
    if (result.isSuccess()) { 
        // User was muted 
        Mute mute = result.data(); 
    } else { 
        // Handle result.error() 
    } 
}); 
 
client.unmuteUser("user-id").enqueue(result -> { 
    if (result.isSuccess()) { 
        // User was unmuted 
    } else { 
        // Handle result.error() 
    } 
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
client.muteUser("user-id").enqueue { result -> 
    if (result.isSuccess) { 
        // User was muted 
        val mute: Mute = result.data() 
    } else { 
        // Handle result.error() 
    } 
} 
 
client.unmuteUser("user-id").enqueue { result -> 
    if (result.isSuccess) { 
        // User was unmuted 
    } else { 
        // Handle result.error() 
    } 
}

After muting a user messages will still be delivered via web-socket. Implementing business logic such as hiding messages from muted users or display them differently is left to the developer to implement.

Messages from muted users are not delivered via push (APN/Firebase)

Ban

Confused about "Ban"?

Let us know how we can improve our documentation:

Users can be banned from an app entirely or from a channel. When a user is banned, it will not be allowed to post messages until the ban is removed or expired but it will be able to connect to Chat and to channels as before.

It is also possible to ban the user's last known IP address to prevent creation of new "throw-away" accounts. This type of ban is only applicable on the app level. We do not recommend applying IP ban without reasonable timeout, however this is not restricted. The IP address will be unbanned either after reaching a timeout or with explicit user unban.

In most cases only admins or moderators are allowed to ban other users from a channel.

name	type	description	default	optional
timeout	number	The timeout in minutes until the ban is automatically expired.	no limit	✓
reason	string	The reason that the ban was created.		✓
ip_ban	boolean	Whether or not to apply IP address ban	false	✓
banned_by_id	string	The ID of the user who is performing the ban. This is required only when using API from the server-side		✓

Banning a user from all channels can only be done using server-side auth.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
// ban a user for 60 minutes from all channel 
let data = await client.banUser('eviluser', { 
    banned_by_id: userID, // ID of the user who is performing the ban (Server-side auth) 
    timeout: 60, 
    reason: 'Banned for one hour', 
}); 
 
// ban a user and their IP address for 24 hours 
let data = await client.banUser('eviluser', { 
   banned_by_id: userID, 
   timeout: 24*60, 
   ip_ban:  true, 
   reason: 'Please come back tomorrow', 
}); 
 
// ban a user from the livestream:fortnite channel 
data = await channel.banUser('eviluser', { 
    banned_by_id: userID, 
    reason: 'Profanity is not allowed here', 
}); 
 
// remove ban from channel 
data = await channel.unbanUser('eviluser'); 
 
// remove global ban 
data = await authClient.unbanUser('eviluser');

1
2
3
4
5
6
7
8
9
10
11
12
13
14
# ban a user for 60 minutes from all channel 
client.ban_user("eviluser", banned_by_id=admin_id, timeout=60, reason="Banned for one hour") 
 
# ban a user and their IP address for 24 hours 
client.ban_user("eviluser", banned_by_id=admin_id, timeout=24*60, ip_ban=true, reason="Please come back tomorrow") 
 
# ban a user from the livestream:fortnite channel 
channel.ban_user("eviluser", banned_by_id=admin_id, reason="Profanity is not allowed here") 
 
# remove ban from channel 
channel.unban_user("eviluser") 
 
# remove global ban 
client.unban_user("eviluser")

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Ban user for 60 minutes from a channel 
channelClient.banUser("user-id", "Bad words", 60).enqueue(result -> { 
    if (result.isSuccess()) { 
        // User was banned 
    } else { 
        // Handle result.error() 
    } 
}); 
 
channelClient.unBanUser("user-id").enqueue(result -> { 
    if (result.isSuccess()) { 
        // User was unbanned 
    } else { 
        // Handle result.error() 
    } 
 });

1
2
3
4
5
6
let channel = Client.shared.channel(type: .messaging, id: "general") 
let john = User(id: "john") 
 
channel.ban(user: john) 
// or 
channel.ban(user: user, timeoutInMinutes: 10, reason: "Bad words!") { result in /* Handle Result */ }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Ban user for 60 minutes from a channel 
channelClient.banUser(targetId = "user-id", reason = "Bad words", timeout = 60).enqueue { result -> 
    if (result.isSuccess) { 
        // User was banned 
    } else { 
        // Handle result.error() 
    } 
} 
 
channelClient.unBanUser(targetId = "user-id").enqueue { result -> 
    if (result.isSuccess) { 
        // User was unbanned 
    } else { 
        // Handle result.error() 
    } 
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
// ban a user for 60 minutes from all channel 
$ban = $client->banUser('evil-user', [ 
    'timeout' => 60, 
    'reason' => 'Banned for one hour', 
    'banned_by_id' => 'user-id' 
]); 
 
// ban a user and their IP address for 24 hours 
$ban = $channel->banUser('evil-user', [ 
    'banned_by_id' => 'user-id' 
    'timeout' => 24*60, 
    'ip_ban' => true, 
    'reason' => 'Please come back tomorrow', 
]); 
 
// ban a user from the livestream:fortnite channel 
$ban = $channel->banUser('evil-user', [ 
    'reason' => 'Banned for one hour', 
    'banned_by_id' => 'user-id' 
]); 
 
// remove ban from channel 
$unban = $channel->unbanUser('evil-user'); 
 
// remove global ban 
$unban = $client->unbanUser('evil-user');

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
// ban a user for 60 minutes from all channel 
await client.banUser('eviluser', { 
    'banned_by_id': userID, // ID of the user who is performing the ban (Server-side auth) 
    'timeout': 60, 
    'reason': 'Banned for one hour', 
}); 
 
// ban a user and their IP address for 24 hours 
 await client.banUser('eviluser', { 
   'banned_by_id': userID, 
   'timeout': 24*60, 
   'ip_ban':  true, 
   'reason': 'Please come back tomorrow', 
}); 
 
// ban a user from the livestream:fortnite channel 
await channel.banUser('eviluser', { 
   'banned_by_id': userID, 
    'reason': 'Profanity is not allowed here', 
}); 
 
// remove ban from channel 
await channel.unbanUser('eviluser'); 
 
// remove global ban 
await authClient.unbanUser('eviluser');

Query Banned Users

Confused about "Query Banned Users"?

Let us know how we can improve our documentation:

Banned users can be retrieved in different ways:

Using the dedicated query bans endpoint
User Search: you can add the banned:true condition to your search. Please note that this will only return users that were banned at the app-level and not the ones that were banned only on channels.

1
2
3
4
5
// retrieve the list of banned users 
const response = await client.queryUsers({banned:true}, {}, {limit:10, offset:0}); 
 
// query for banned members from one channel 
const results = await client.queryBannedUsers({channel_cid: "livestream:123"});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
// retrieve the list of banned users 
client.queryUsers( 
    QueryUsersRequest( 
        filter = Filters.eq("banned", true), 
        offset = 0, 
        limit = 10, 
    ) 
).enqueue { result -> 
    if (result.isSuccess) { 
       val users: List<User> = result.data() 
   } else { 
       // Handle result.error() 
   } 
}

1
2
3
4
5
// retrieve the list of banned users 
await client.queryUsers(filter: { 
'banned': true, 
},  
PaginationParams(limit:10, offset:0));

1
2
3
4
5
6
7
8
9
10
11
FilterObject filter = Filters.eq("banned", true); 
 
// retrieve the list of banned users 
QueryUsersRequest request = new QueryUsersRequest(filter, 0, 10); 
client.queryUsers(request).enqueue(result -> { 
    if (result.isSuccess()) { 
        List<User> users = result.data(); 
    } else { 
        // Handle result.error() 
    } 
});

Query Bans Endpoint

Confused about "Query Bans Endpoint"?

Let us know how we can improve our documentation:

The query bans endpoint allows you to list bans for your application. Similar to other query endpoints, you can filter bans by different fields and control the ordering of results.

Globally banned users can only be retrieved using server-side auth

Available fields

Confused about "Available fields"?

Let us know how we can improve our documentation:

Name	Description	Example	Operators
channel_cid	The channel CID for the ban. When this parameter is not provided, both global and channel bans will be returned.	{ channel_cid :{$in:["livestream:1","livestream:2"]}}	$eq, $in
user_id	The ID of the banned user	{ user_id: "evil_user" }	$eq, $in, $neq, $nin
expired	The date (RFC339) of the ban expiration	{ expired: {$gt: "2020-10-02T15:00:00Z"} }	$eq, $gt, $gte, $lt, $lte
created_at	The date (RFC339) of the ban creation	{ created_at: {$gt: "2020-10-02T15:00:00Z"} }	$eq, $gt, $gte, $lt, $lte
banned_by_id	The ID of the user that created the ban	{ banned_by_id: "42"}	$eq, $in, $neq, $nin

Pagination for bans can be done in two ways: using offset/limit or using the "created_at" field. Bans are returned in ascending order by default so to get the second page you need to request bans with "created_at" less than the created_at of the last ban in the first page. Ordering can be reversed using the sort option.

1
2
3
4
5
6
7
8
// get the bans for channel livestream:123 in descending order 
const response = await client.queryBannedUsers({channel_cid: "livestream:123"}, {created_at: -1}); 
 
// get the next page of bans for the same channel 
await client.queryBannedUsers( 
   { channel_cid: "livestream:123", created_at_before_or_equal: createdAt }, 
   { created_at: -1 } 
);

Shadow Ban

Confused about "Shadow Ban"?

Let us know how we can improve our documentation:

Users can be shadow banned from an app entirely or from a channel. When a user is shadow banned, it will still be allowed to post messages, but any message sent during, will have shadowed: true field. However, this will be invisible from the author of the message.

It's up to the client-side implementation to hide or otherwise handle these messages appropriately.

1
2
3
4
5
6
7
8
9
10
11
// shadow ban a user from all channels 
let data = await client.shadowBan('eviluser'); 
 
// shadow ban a user from a channel 
data = await channel.shadowBan('eviluser'); 
 
// remove shadow ban from channel 
data = await channel.removeShadowBan('eviluser'); 
 
// remove global shadow ban 
data = await client.removeShadowBan('eviluser');

1
2
3
4
5
6
7
8
9
10
11
// shadow ban a user from all channels 
await client.shadowBan('eviluser'); 
 
// shadow ban a user from a channel 
await channel.shadowBan('eviluser'); 
 
// remove shadow ban from channel 
await channel.removeShadowBan('eviluser'); 
 
// remove global shadow ban 
await client.removeShadowBan('eviluser');

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Shadow ban user for 60 minutes from a channel 
channelClient.shadowBanUser("user-id", "Bad words", 60).enqueue(result -> { 
    if (result.isSuccess()) { 
        // User was shadow banned 
    } else { 
        // Handle result.error() 
    } 
}); 
 
channelClient.removeShadowBan("user-id").enqueue(result -> { 
    if (result.isSuccess()) { 
         // Shadow ban was removed 
    } else { 
         // Handle result.error() 
    } 
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Shadow ban user for 60 minutes from a channel 
channelClient.shadowBanUser(targetId = "user-id", reason = "Bad words", timeout = 60).enqueue { result -> 
     if (result.isSuccess) { 
         // User was shadow banned 
     } else { 
         // Handle result.error() 
     } 
} 
 
channelClient.removeShadowBan("user-id").enqueue { result -> 
    if (result.isSuccess) { 
        // Shadow ban was removed 
    } else { 
        // Handle result.error() 
    } 
}

Administrators can view shadow banned user status in queryChannels(), queryMembers() and queryUsers().

Automod

Confused about "Automod"?

Let us know how we can improve our documentation:

For livestream and gaming channel types Automod is enabled by default. There are three options for moderation:

disabled
simple (blocks messages that contain a list of profane words)
ai (uses an AI-based classification system to detect various types of bad content)

AI-based moderation is a premium feature. Please contact sales to discuss your options.

Client SDKs

Backend SDKs

Confused about "Moderation Tools"?

Flag

Confused about "Flag "?

Mutes

Confused about "Mutes"?

Ban

Confused about "Ban"?

Query Banned Users

Confused about "Query Banned Users"?

Query Bans Endpoint

Confused about "Query Bans Endpoint"?

Available fields

Confused about "Available fields"?

Shadow Ban

Confused about "Shadow Ban"?

Automod

Confused about "Automod"?

Moderation Tools Feedback