CreateConversationOptions interface

Options passed to Proactive.createConversation(). Flattened — no nested Conversation wrapper.

Properties

channelId

The target channel (e.g. 'msteams').

identity

JWT claims for the agent identity. aud must be the agent's client ID.

parameters

Conversation configuration passed to adapter.createConversationAsync().

scope

OAuth scope for token acquisition. Defaults to AzureBotScope when not set by the builder.

serviceUrl

The service URL for the channel.

storeConversation

When true, the resulting Conversation is stored automatically after creation. Defaults to false.

Property Details

channelId

The target channel (e.g. 'msteams').

channelId: string

Property Value

string

identity

JWT claims for the agent identity. aud must be the agent's client ID.

identity: ConversationClaims

Property Value

parameters

Conversation configuration passed to adapter.createConversationAsync().

parameters: Partial<ConversationParameters>

Property Value

scope

OAuth scope for token acquisition. Defaults to AzureBotScope when not set by the builder.

scope: string

Property Value

string

serviceUrl

The service URL for the channel.

serviceUrl: string

Property Value

string

storeConversation

When true, the resulting Conversation is stored automatically after creation. Defaults to false.

storeConversation?: boolean

Property Value

boolean