The profanity filter is designed to detect and filter out profanity words or regular expressions contained in text and file messages according to your policies and criteria. By default, the profanity filter is only applied to the messages. If you'd like to apply profanity filter for nicknames, contact our sales team.
The following table lists a parameter that this action supports.
Specifies the custom channel type to apply a set of settings to a channel.
The following table lists the properties of an HTTP request that this action supports.
Specifies a profanity filter configuration to filter out certain words and patterns that match the character combinations specified in
array of strings
Specifies an array of words to detect. A keyword that starts with an asterisk filters all words that end with the keyword including the keyword itself. A keyword that ends with an asterisk filters all words that start with the keyword including the keyword itself.
array of objects
Specifies an array of regular expressions to detect. Each item in the array should be specified in
Determines which filtering method to apply to messages and nicknames that contain the specified keywords or regular expressions. Acceptable values are the following:
Determines whether to apply the profanity filter of the application settings in addition to
If you want to turn off the profanity filter, send a
PUT request with a blank
keywords property and
regex_filters property as shown below:
In the case of an error, an error object is returned. A detailed list of error codes is available here.