Skip to main content

@wildix/xbees-conversations-client > CreateGroupChannelInput

CreateGroupChannelInput interface

Signature:

export interface CreateGroupChannelInput 

Properties

Property

Modifiers

Type

Description

access?

ChannelAccess

(Optional) The access level of the channel.

broadcast?

boolean

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

channelId?

string

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

description?

string

(Optional) The description of the channel.

members?

(string)[]

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

membersToInvite?

(UserToInvite)[]

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

picture?

string

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

pictureColor?

string

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

subject?

string

(Optional) The subject of the channel.

userId?

string

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