API Docs for: 2.0.17170.2
Show:

ui.virtualAgent.content.AssistedSupportFlow Class

Extends FlowExtension
Defined in: src\internal\ui\virtualAgent\content\content.ts:145
Module: UI VirtualAgent
Parent Module: UI

Configuration for AssistedSupport flow

Properties

agentTitle

String

Defined in src\internal\ui\virtualAgent\content\content.ts:170

change agent title e.g. for agent title "Microsoft answer tech"

issue

String

Defined in src\internal\ui\virtualAgent\content\content.ts:158

issue to overwrite AI issue

phoneNumber

String

Defined in src\internal\ui\virtualAgent\content\content.ts:176

phone number of the user that will prepopulate the field

product

String

Defined in src\internal\ui\virtualAgent\content\content.ts:152

product to overwrite AI routing

showImmediately

Boolean

Defined in src\internal\ui\virtualAgent\content\content.ts:164

prompt user to access assisted support immediately as part of the initial greeting message.

Events

onCallbackAccepted

Defined in src\internal\ui\virtualAgent\content\content.ts:230

Fired when callback is accepted

Event Payload:

  • data Object

    A data object that is passed through the event

    • datetime String

      Date and time of the requested callback

onCallbackRejected

Defined in src\internal\ui\virtualAgent\content\content.ts:238

Fired when callback is rejected

onChatClosed

Defined in src\internal\ui\virtualAgent\content\content.ts:202

Fired when chat session is closed

onChatEstablished

Defined in src\internal\ui\virtualAgent\content\content.ts:182

Fires when the chat session is established

onChatMessage

Defined in src\internal\ui\virtualAgent\content\content.ts:208

Fired when a chat message is received

Event Payload:

  • data Object

    A data object that is passed through the event

    • sender Object

      Sender of the message

      • senderName String
        Sender's name

onChatQueued

Defined in src\internal\ui\virtualAgent\content\content.ts:188

Fires when chat request is queued

onChatQueueUpdated

Defined in src\internal\ui\virtualAgent\content\content.ts:194

Fires when chat queue status changes

Event Payload:

  • data Object

    A data object that is passed through the event

    • position Number

      Current queue position

onChatRejoinUrl

Defined in src\internal\ui\virtualAgent\content\content.ts:223

Fired when chat rejoin url is received

Event Payload:

  • data String

    Url to rejoin the chat

onChatTransferred

Defined in src\internal\ui\virtualAgent\content\content.ts:217

Fired when chat is transferred