|
5 | 5 | Name | Type | Description | Notes |
6 | 6 | ------------ | ------------- | ------------- | ------------- |
7 | 7 | **user_ids** | **[str]** | Specifies an array of one or more IDs of users to invite to the channel. The maximum number of users to be invited at once is 100. The users below and this property can be used interchangeably. | |
8 | | -**users** | **[str]** | Specifies an array of one or more IDs of users to invite to the channel. The maximum number of users to be invited at once is 100. The user_ids above and this property can be used interchangeably. | |
9 | | -**name** | **str** | Specifies the name of the channel, or the channel topic. The length is limited to 191 characters. (Default: group channel) | |
10 | | -**channel_url** | **str** | Specifies the URL of the channel. Only numbers, characters, and underscores are allowed. The length is 4 to 100 characters, inclusive. If not specified, a URL is automatically generated. | |
11 | | -**cover_url** | **str** | Specifies the URL of the cover image for the channel. The length is limited to 2,048 characters. | |
12 | | -**cover_file** | **file_type** | Uploads the cover image file for the channel. | |
13 | | -**custom_type** | **str** | Specifies the custom channel type which is used for channel grouping. The length is limited to 128 characters.<br /><br /> Custom types are also used within Sendbird's [Advanced analytics](/docs/chat/v3/platform-api/guides/advanced-analytics) to segment metrics, which enables the sub-classification of data views. | |
14 | | -**data** | **str** | Specifies additional channel information such as a long description of the channel or `JSON` formatted string. | |
15 | | -**is_distinct** | **bool** | Determines whether to reuse an existing channel or create a new channel. If set to true, returns a channel with the same users in the user_ids or users property or creates a new channel if no match is found. Sendbird server can also use the custom channel type in the custom_type property if specified along with the users to return the corresponding channel. If set to false, Sendbird server always creates a new channel with a combination of the users as well as the channel custom type if specified. (Default: false)<br /><br /> Under this property, Sendbird server does not distinguish channels based on other properties such as channel URL or channel name. | |
16 | | -**is_public** | **bool** | Determines whether to allow a user to join the channel without an invitation. (Default: false) | |
17 | | -**is_super** | **bool** | Determines whether to allow the channel to accommodate more than 2,000 members. (Default: false) <br/><br/> Supergroup channels are not supported with the is_distinct property and the property is false by default. | |
18 | | -**is_ephemeral** | **bool** | Determines whether to preserve the messages in the channel for the purpose of retrieving chat history. (Default: false) | |
19 | | -**access_code** | **str** | This parameter can only be used when the channel operator creates a public group channel. They can set an access code for the corresponding type of channel. The channel then requires the specified access code to a user who attempts to join. If specified, the is_access_code_required property of the channel resource is set to true. | |
20 | | -**inviter_id** | **str** | Specifies the ID of the user who has invited other users as members of the channel. The inviter is not automatically registered to the channel as a member, so you should specify the ID of the inviter in the user_ids property below if needed. | |
21 | | -**strict** | **bool** | Determines whether to receive a `400111` error and cease channel creation when there is at least one non-existing user in the specified user_ids or users property above. If set to false, the channel will be created excluding the non-existing users without receiving the mentioned error. (Default: false) | |
22 | | -**invitation_status** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Specifies one or more key-value pair items which set the invitation status of each user invited to the channel. The key should be a user_id and the value should be their joining status. Acceptable values are joined, invited_by_friend, and invited_by_non_friend. (Default: joined) | |
23 | | -**hidden_status** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Specifies one or more key-value pair items which set the channel's hidden status for each user. The key should be a user_id and the value should be their hidden status. Acceptable values are limited to the following:<br />- unhidden (default): the channel is included in when retrieving a list of group channels.<br />- hidden_allow_auto_unhide: the channel automatically gets unhidden when receiving a new message.<br />- hidden_prevent_auto_unhide: the channel keeps hidden though receiving a new message. | |
24 | | -**operator_ids** | **[str]** | Specifies an array of one or more IDs of users to register as operators of the channel. You should also include these IDs in the user_ids property to invite them to the channel as members. They can delete any messages in the channel, and also view all messages without any filtering or throttling. The maximum allowed number of operators per channel is 100. | |
25 | | -**block_sdk_user_channel_join** | **bool** | Determines whether to block users from joining the channel through the Chat SDK. This parameter can be used in order to restrict the ways for users to join the channel, and only using the [join a channel](#2-join-a-channel) action can add a user to the channel. (Default: false) | |
| 8 | +**users** | **[str]** | Specifies an array of one or more IDs of users to invite to the channel. The maximum number of users to be invited at once is 100. The user_ids above and this property can be used interchangeably. | [optional] |
| 9 | +**name** | **str** | Specifies the name of the channel, or the channel topic. The length is limited to 191 characters. (Default: group channel) | [optional] |
| 10 | +**channel_url** | **str** | Specifies the URL of the channel. Only numbers, characters, and underscores are allowed. The length is 4 to 100 characters, inclusive. If not specified, a URL is automatically generated. | [optional] |
| 11 | +**cover_url** | **str** | Specifies the URL of the cover image for the channel. The length is limited to 2,048 characters. | [optional] |
| 12 | +**cover_file** | **file_type** | Uploads the cover image file for the channel. | [optional] |
| 13 | +**custom_type** | **str** | Specifies the custom channel type which is used for channel grouping. The length is limited to 128 characters.<br /><br /> Custom types are also used within Sendbird's [Advanced analytics](/docs/chat/v3/platform-api/guides/advanced-analytics) to segment metrics, which enables the sub-classification of data views. | [optional] |
| 14 | +**data** | **str** | Specifies additional channel information such as a long description of the channel or `JSON` formatted string. | [optional] |
| 15 | +**is_distinct** | **bool** | Determines whether to reuse an existing channel or create a new channel. If set to true, returns a channel with the same users in the user_ids or users property or creates a new channel if no match is found. Sendbird server can also use the custom channel type in the custom_type property if specified along with the users to return the corresponding channel. If set to false, Sendbird server always creates a new channel with a combination of the users as well as the channel custom type if specified. (Default: false)<br /><br /> Under this property, Sendbird server does not distinguish channels based on other properties such as channel URL or channel name. | [optional] |
| 16 | +**is_public** | **bool** | Determines whether to allow a user to join the channel without an invitation. (Default: false) | [optional] |
| 17 | +**is_super** | **bool** | Determines whether to allow the channel to accommodate more than 2,000 members. (Default: false) <br/><br/> Supergroup channels are not supported with the is_distinct property and the property is false by default. | [optional] |
| 18 | +**is_ephemeral** | **bool** | Determines whether to preserve the messages in the channel for the purpose of retrieving chat history. (Default: false) | [optional] |
| 19 | +**access_code** | **str** | This parameter can only be used when the channel operator creates a public group channel. They can set an access code for the corresponding type of channel. The channel then requires the specified access code to a user who attempts to join. If specified, the is_access_code_required property of the channel resource is set to true. | [optional] |
| 20 | +**inviter_id** | **str** | Specifies the ID of the user who has invited other users as members of the channel. The inviter is not automatically registered to the channel as a member, so you should specify the ID of the inviter in the user_ids property below if needed. | [optional] |
| 21 | +**strict** | **bool** | Determines whether to receive a `400111` error and cease channel creation when there is at least one non-existing user in the specified user_ids or users property above. If set to false, the channel will be created excluding the non-existing users without receiving the mentioned error. (Default: false) | [optional] |
| 22 | +**invitation_status** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Specifies one or more key-value pair items which set the invitation status of each user invited to the channel. The key should be a user_id and the value should be their joining status. Acceptable values are joined, invited_by_friend, and invited_by_non_friend. (Default: joined) | [optional] |
| 23 | +**hidden_status** | **{str: (bool, date, datetime, dict, float, int, list, str, none_type)}** | Specifies one or more key-value pair items which set the channel's hidden status for each user. The key should be a user_id and the value should be their hidden status. Acceptable values are limited to the following:<br />- unhidden (default): the channel is included in when retrieving a list of group channels.<br />- hidden_allow_auto_unhide: the channel automatically gets unhidden when receiving a new message.<br />- hidden_prevent_auto_unhide: the channel keeps hidden though receiving a new message. | [optional] |
| 24 | +**operator_ids** | **[str]** | Specifies an array of one or more IDs of users to register as operators of the channel. You should also include these IDs in the user_ids property to invite them to the channel as members. They can delete any messages in the channel, and also view all messages without any filtering or throttling. The maximum allowed number of operators per channel is 100. | [optional] |
| 25 | +**block_sdk_user_channel_join** | **bool** | Determines whether to block users from joining the channel through the Chat SDK. This parameter can be used in order to restrict the ways for users to join the channel, and only using the [join a channel](#2-join-a-channel) action can add a user to the channel. (Default: false) | [optional] |
26 | 26 | **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] |
27 | 27 |
|
28 | 28 | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) |
|
0 commit comments