You can create an open channel that facilitates conversations for millions of users. Open channels allow a seamless chat experience possible for all participants by using dynamic partitioning which creates subchannels that each handle up to tens of thousands of participants.
Because users don't need invitations to join open channels, short-lived live events like concerts or live streams that don't require a sustained membership are good use cases for open channels.
The following table lists the properties of an HTTP request that this action supports.
Specifies the channel topic, or the name of the channel. The length is limited to 191 characters. (Default:
Specifies the URL of the channel. Only numbers, letters, underscores, and hyphens are allowed. The allowed length is 4 to 100 characters, inclusive. If not specified, a URL is automatically generated.
Specifies the URL of the channel's cover image. The length is limited to 2,048 characters.
Uploads a file for the channel's cover image.
Specifies the custom channel type which is used for channel grouping. The length is limited to 128 characters.
Specifies additional channel information such as a long description of the channel or
Determines whether to preserve messages in the channel to later retrieve the chat history. If set to
Determines whether the channel to be created is an open channel based on a dynamic partitioning structure. The value of
array of strings
Specifies an array of user IDs to register as operators of the channel. The maximum number of operators allowed per channel is 100. Operators can delete any messages in the channel and receives all messages that have been throttled.
array of strings
(Deprecated) Specifies the string IDs of the users registered as channel operators. Operators can delete any messages in the channel and even receive all messages that have been throttled.
Note: If you want to upload a profile picture by passing an image
fileinstead of a URL, see Multipart requests.
If successful, this action returns an open channel resource 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.