Skip to main content

@wildix/xbees-conversations-client > CreateKiteChannelInput

CreateKiteChannelInput interface

Signature:

export interface CreateKiteChannelInput 

Properties

Property

Modifiers

Type

Description

channelId?

string

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

initialMessage?

InitialMessage

(Optional) A message to be added to the conversation for the user. If welcomeMessages or initialMessage are not specified, the system will generate a 'conversation was created' system message.

targetId

string

The unique identifier of the Kite widget or email of the agent (example: 36cv69ao or vadim.ruban@wildix.com).

targetRouteId?

string

(Optional) The unique identifier of the route for time-based configuration.

userId?

string

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

welcomeMessages?

(WelcomeMessage)[]

(Optional) A list of welcome messages is created during channel creation to preserve the same state as the client has on the interface. If welcomeMessages or initialMessage are not specified, the system will generate a 'conversation was created' system message.