Free Download

Knowledge Base

Back to support overview

Accept Call 

Accepts an incoming Assist call.

Identifier: accept_call

Example

<accept_call id="myaction"/>

Call Menu

Opens the menu during an Assist call.

Identifier: call_menu

Example

<call_menu id="myaction"/>

Change Stream Volume

Adjusts the stream volume during a call.

Identifier: change_stream_volume

Example

<change_stream_volume id="myaction"/>

Convert Contacts to Selection List

Converts a set of contacts into a selectable list.

Identifier: convert_contacts_to_selection_list

Output

  • CONTACTS_CONVERTED: The action has been completed successfully.
  • BUSY_CONTACT_ID: The contact is currently busy.

Example

<convert_contacts_to_selection_list id="myaction"/>

Reject Call

Rejects an incoming Assist call.

Identifier: reject_call

Example

<reject_call id="myaction"/>

Start Call

Starts an Assist call.

Identifier: start_call

Example

<start_call id="stopcall"/>

Stop Call

Stops an ongoing Assist call.

Identifier: stop_call

Example

<stop_call id="stopcall"/>

Toggle Stream

Toggles the video and audio stream on/off during a Assist call.

Identifier: toggle_stream

Example

<toggle_stream id="myaction"/>

Take Picture

Takes a picture during an ongoing Assist call.

Identifier: xassist_take_picture

Example

<xassist_take_picture id="myaction"></xassist_take_picture>

Trigger Autofocus

Toggles the Autofocus feature on/off during an ongoing Assist call.

Identifier: trigger_auto_focus

Example

<trigger_auto_focus id="focus"/>

Workflow metadata

Predefined information will be shared in the chat if the Assist call is placed at any point while executing the Task. The data format is text messages, images, and files.

Identifier: call_metadata

Attributes

Here's an explanation of the available attribute:

  • delete_after: It will remove the metadata after one call is started.
    • Required: No
    • Default value: False
  • replace: It will remove the previous data instead of extending it.
    • Required: No
    • Default value: True

Elements

The different elements are as follows:

  • data: Unnamed list
    • Default value: Empty list

Example

<call_metadata id="call_metadata" delete_after="false" replace="true"> 
    <list name="data" listType="UNNAMED" defaultElemType="string"> 
        <elem>Hey</elem>
        <elem>#{xassist::activated}</elem> 
        <elem>xai:/xassist_pictures/ceggert_hmd_2023-03-03_17-35-01_highres-pic.jpg?version=1</elem> 
    </list>
</call_metadata>