API Docs for: 2.0.20133.2
Show:

ui.virtualAgent.content.AssistedSupportFlow Class

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

Configuration for AssistedSupport flow

Properties

acceptedProducts

Array

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

list of Assisted Support IDs for products that the partner experience accepts as classifier results. Note that if this value is set, the flow extension product and issue values are treated as fallbacks for invalid classifier results and not as hard overrides -- for { product: "office", issue: "tech-service", acceptedProducts: ["office", "officemac", "outlook.com", "onedrive"] }, a classifier result of "outlook.com" will use the classifier result, while a classifier result of "windows" will fall back to office/tech-services. An empty list with no product or issue will make the user pick both the product and issue from a list of all available products

agentTitle

String

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

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

issue

String

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

issue to overwrite AI issue

phoneNumber

String

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

phone number of the user that will prepopulate the field

product

String

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

product to overwrite AI routing

showImmediately

Boolean

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

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:245

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:253

Fired when callback is rejected

onChatAgentDataReady

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

Fired when a chat message is received

Event Payload:

  • data Object

    A data object that is passed through the event

    • AgentId String

      The Id of the Agent

    • DisplayName String

      The name of the Agent

    • ImageUrl String

      A relative url to an image of the Agent

onChatClosed

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

Fired when chat session is closed

onChatEstablished

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

Fires when the chat session is established

onChatMessage

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

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:193

Fires when chat request is queued

onChatQueueUpdated

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

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:238

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:232

Fired when chat is transferred