@wildix/xbees-conversations-client > CreateGroupChannelInput
CreateGroupChannelInput interface
Signature:
export interface CreateGroupChannelInput
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
ChannelAccess | undefined | (Optional) The access level of the channel. | ||
User | undefined | (Optional) A user that assigned to the channel if specified in the request, otherwise previously assigned user or undefined. | ||
boolean | undefined | (Optional) | ||
boolean | undefined | (Optional) Indicates if the channel is broadcast-only. Default is false. | ||
string | undefined | (Optional) The unique identifier for the new group channel. If not provided, the system will generate one. | ||
ChannelContext | undefined | (Optional) An additional information that associated with this channel. | ||
string | undefined | (Optional) The description of the channel. | ||
string | undefined | (Optional) The unique identifier of the assignee. | ||
(string)[] | undefined | (Optional) A list of user IDs to be added as members of the group channel. | ||
(UserToInvite)[] | undefined | (Optional) A list of users to invite to the group channel, identified by their email addresses or phone numbers. | ||
boolean | undefined | (Optional) Indicates if the channel supports MMS. Default is false. | ||
string | undefined | (Optional) The URL of the channel's picture. | ||
string | undefined | (Optional) The dominant color of the channel's picture, represented by a hex value. | ||
string | undefined | (Optional) | ||
boolean | undefined | (Optional) Indicates if the channel supports SMS. Default is false. | ||
string | undefined | (Optional) The subject of the channel. | ||
string | undefined | (Optional) | ||
string | undefined | (Optional) The unique identifier of the user when a service token is used. | ||
boolean | undefined | (Optional) Indicates if the channel supports WhatsApp. Default is false. | ||
ChannelWhatsAppStatus | undefined | (Optional) The WhatsApp status of the channel. |