Skip to main content

@wildix/xbees-conversations-client > CreateGroupChannelInput

CreateGroupChannelInput interface

Signature:

export interface CreateGroupChannelInput 

Properties

Property

Modifiers

Type

Description

access?

ChannelAccess | undefined

(Optional) The access level of the channel.

assignee?

User | undefined

(Optional) A user that assigned to the channel if specified in the request, otherwise previously assigned user or undefined.

autoRecord?

boolean | undefined

(Optional)

broadcast?

boolean | undefined

(Optional) Indicates if the channel is broadcast-only. Default is false.

channelId?

string | undefined

(Optional) The unique identifier for the new group channel. If not provided, the system will generate one.

context?

ChannelContext | undefined

(Optional) An additional information that associated with this channel.

description?

string | undefined

(Optional) The description of the channel.

kiteAssign?

string | undefined

(Optional) The unique identifier of the assignee.

members?

(string)[] | undefined

(Optional) A list of user IDs to be added as members of the group channel.

membersToInvite?

(UserToInvite)[] | undefined

(Optional) A list of users to invite to the group channel, identified by their email addresses or phone numbers.

mms?

boolean | undefined

(Optional) Indicates if the channel supports MMS. Default is false.

picture?

string | undefined

(Optional) The URL of the channel's picture.

pictureColor?

string | undefined

(Optional) The dominant color of the channel's picture, represented by a hex value.

serviceTitle?

string | undefined

(Optional)

sms?

boolean | undefined

(Optional) Indicates if the channel supports SMS. Default is false.

subject?

string | undefined

(Optional) The subject of the channel.

transcriptionLanguage?

string | undefined

(Optional)

userId?

string | undefined

(Optional) The unique identifier of the user when a service token is used.

whatsapp?

boolean | undefined

(Optional) Indicates if the channel supports WhatsApp. Default is false.

whatsappStatus?

ChannelWhatsAppStatus | undefined

(Optional) The WhatsApp status of the channel.