Create channel settings by a custom channel type
You can create the settings for channels with the specified custom channel type using this API. If a custom type isn't specified for a channel, global application settings are applied to all channels by default.
The following table lists the properties of an HTTP request that this action supports.
Specifies the custom channel type.
Determines whether to display past messages to new members of a group channel. If set to
Determines whether to allow clickable links in a message within the application. (Default:
Specifies the maximum character length of a message allowed to be sent within the application. Acceptable values are
Specifies the maximum number of messages which a user is allowed to send in a channel during the time duration set in
Specifies the time duration in seconds in which a user can send the set number of messages in a channel. This property works in conjunction with
Specifies the length of time in hours that the messages are retained for. The maximum message retention period is six months, or 4,380 hours. (Default:
A domain filter configuration to filter out text and file messages with URLs that contain the domain set.
array of strings
Specifies an array of domains to detect. Each item of the array should be specified in a combination of domain name and TLD (top level domain) like
Determines which filter to apply to messages with URLs that contain any of the domain set. Acceptable values are the following.
A filter configuration on certain words and patterns for matching character combinations in strings, which are not allowed to be used within the application.
array of strings
Specifies an array of words to detect.
array of strings
Specifies an array of regular expressions used for detecting. Each item of the list should be specified in
Determines which filtering method to apply to messages that contain the specified keywords or regular expressions. Acceptable values are the following.
A moderation configuration on which penalty is automatically imposed on users who reach the profanity violation limit within a channel.
Specifies the number of profanity violation limit before a penalty is imposed on a user.
Specifies the duration of the time window in seconds which counts the number of a user’s violations within a channel. For example, if the
Determines the type of moderation penalty within a channel which is permanently imposed on users until canceled. Acceptable values are
A moderation configuration on inappropriate images in the application. Google Cloud Vision API is used for image moderation and supports many types of images.
Determines the moderation method to apply to the images and image URLs in the text and file messages. Acceptable values are the following.
If set to
A set of values returned after an image has been moderated. These limit numbers range from one to five and specify the likelihood of the image passing the moderation standard. Acceptable likelihood values are
Specifies the likelihood of the image containing an adult content.
Specifies spoof likelihood which is the likelihood that a modification was made to the image to make it appear funny or offensive.
Specifies the likelihood of the image being a medical image.
Specifies the likelihood of the image containing violent content.
Specifies the likelihood of the image containing racy content.
Determines whether to check if the image URLs in the text and file messages are appropriate.
A configuration of a push notification template for the specified custom channel type.
Specifies the message content to be displayed in the push notifications for user messages sent in the specified custom channel type. You can customize the message with variables like
Specifies the message content to be displayed in the push notification for file messages sent in the specified custom channel type. You can customize the message with variables like
Specifies the message content to be displayed in the push notification for admin messages sent in the specified custom channel type. You can customize the message with variables like
If successful, this action returns the settings for channels with the custom type in the response body.
In the case of an error, an error object like below is returned. See the error codes section for more details.