Microsoft Copilot Studio legacy bots

This section describes Microsoft Copilot Studio legacy bots.

The Microsoft Copilot Studio legacy platform lets you build a bot without code. To integrate VoiceAI Connect functionality with a Copilot Studio legacy bot, you need to use a tool called Bot Framework Composer. This tool enables you to send Activities to VoiceAI Connect and receive notifications from VoiceAI Connect to the bot.

For an introduction to Copilot Studio legacy, including basic concepts which will provide you with a better understanding of how to integrate VoiceAI Connect with a Copilot Studio legacy bot, go to Microsoft's documentation.

• Topics: Topics are conversation flows in Copilot Studio legacy. A topic an be triggered with a pre-defined set of sentences. For example, "Track a package" flow is a topic, which can be triggered with sentences:

• Activities: In VoiceAI Connect, context an activity is a control command sent to VoiceAI Connect and not to the user (e.g., start recording or switch language). Sending activities can be done only via the Bot Framework Composer. There is a basic integration between the Copilot Studio legacy UI and the composer. To add an action in a topic workflow, you need to toggle between the two. For more information on activities, see Sending actions to VoiceAI Connect.

• Notifications: In VoiceAI Connect, context a notification is a message sent from the Session Manager to the bot, but is not necessarily connected to the current topic (e.g., start conversation event or no user input event). For VoiceAI Connect notifications, see Call Disconnect. Catching events and extracting data can be done in the Bot Framework Composer. For more information, see Receiving notifications from VoiceAI Connect.

Receiving notifications from VoiceAI Connect

To receive notifications from VoiceAI Connect, you need to create a shared variable in Copilot Studio legacy (shared between Bot Framework Composer and Copilot Studio legacy) and create a trigger in Composer.

Create a shared variable

1. Open a new topic in the web UI and leave the trigger phrases empty (this makes the topic unreachable for the caller).

2. Add an 'Ask a question' to create a variable:

3. Edit the variable name and type according to your needs. Change its usage to 'Bot' and then select the 'External sources can set values' option. This enables you to use this variable in Composer, which can be accessed in Composer using virtualagent.<variable name>.

Create a new trigger in Bot Framework Composer

1. Open your bot in Composer:

2. Create a new trigger:

3. Select the trigger type as Activities (Activity received):

4. Create a new condition (use if/else for one notification type and switch for multiple notifications):

5. Use turn.dialogEvent.name to extract the notification name:

6. Compare the received event name with the desired event name. (in the example, it's noUserInput).

7. Save the requested property in virtualagent object. virtualagent.<param name> (this saves the parameter in the variable that you created in the web UI).

Using a shared variable

After creating the shared variable, it's accessible in all of the Copilot Studio legacy under bot.<variable name>:

 

Sending actions to VoiceAI Connect

Each time you want to send an action to VoiceAI Connect and not to the user, you need to do the following:

Create an event in Bot Framework Composer

1. Open your bot in Composer.

2. Add a new dialog to your bot (three dots near the bot name):

3. In the 'begin dialog', add 'Send a response':

4. Click 'show code' to add AudioCodes custom actions:

5. Add the desired action lets, for example, start call recording:

6. Publish this section in Composer and tie it up in the web UI. Note that you must publish the changes from Composer to use them in the web UI:

7. In the desired topic, add 'redirect to another topic', and then select the topic that you created in Composer. Topics created in Composer are displayed in light blue:

8. Save the topic and then publish it.

Activity structure:

[Activity
  type = event
  name = <event name>
  channelData = ${json(`
  {
    "activityParams": {
      "<parameter name 1>": "<parameter value>",
      "<parameter name 2>": "<parameter value>"
    }
  }
`)}
]

Saving Channel Data

Channel data is an object that VoiceAI Connect sends in the start of the conversation (see Call initiation for details) In order to save and use channel Data we need to follow these steps:

To save channel data in bot framework composer:

1. Open your bot in the bot framework composer.

2. Create a new trigger.

3. Select trigger type as Activities (Activity received).

4. Create a new condition (use if/else for one notification type and switch for multiple notifications).

5. Use turn.activity.name to catch the channel event.

6. Save the JSON object using json(turn.activity.channelData).

Here the JSON is saved to a composer variable.

7. Save the requested property in virtualagent object. virtualagent.<param name> (this will save the parameter in the variable created in the web UI).

   A full list of the parameters exist in customizing call initiation behavior.

8. Redirect from channel event to a Copilot Studio legacy topic. By default, VoiceAI Connect sends two consecutive events to a Copilot Studio legacy bot in the start of a conversation - a channel event and a startConversation event to start the greeting topic. If your bot handles the channel event, and redirects it to a Copilot Studio legacy topic or responds with a greeting, you may disable the startConversation event (see Call initiation for the configuration and more details)

9. After consuming the channel event, select Begin a Power Virtual Agents topic.

10. Select your desired topic.