Browse source on GitHub

Relay Bot

Deprecated

This sample uses the archived Bot Framework SDK (Microsoft.Bot.Builder). It will be replaced with an M365 Agents SDK implementation.

Sample of connecting an Azure Bot Service bot to a Copilot Studio agent using the Direct Line API.

This bot has been created based on Bot Framework, it shows how to create an Azure Bot Service bot that connects to a Copilot Studio agent

Prerequisites

  • .NET SDK version 10.0

    # determine dotnet version
    dotnet --version
    

To try this sample

  • Clone the repository

      git clone https://github.com/microsoft/CopilotStudioSamples.git
    
  • In a terminal, navigate to extensibility/agents-sdk/relay-bot
  • Update file appsettings.json with your Power Virtual Agent bot id, tenant id, bot name and other settings.

    To retrieve your bot’s bot ID and tenant ID, click on left side pane’s Manage, click Channels and click on the Azure Bot Service channel that you need to connect to. Copy and save the bot ID and tenant ID value by clicking Copy.

    Bot name can be found in you Power Virtual Agents bot Home page.

  • Run the bot from a terminal or from Visual Studio, choose option A or B.

    A) From a terminal

    # run the bot
    dotnet run
    

    B) Or from Visual Studio

    • Launch Visual Studio
    • File -> Open -> Project/Solution
    • Navigate to extensibility/agents-sdk/relay-bot folder
    • Select SampleBot.csproj file
    • Press F5 to run the project

Testing the bot using Bot Framework Emulator

Bot Framework Emulator is a desktop application that allows bot developers to test and debug their bots on localhost or running remotely through a tunnel.

  • Install the Bot Framework Emulator version 4.3.0 or greater from here

Connect to the bot using Bot Framework Emulator

  • Launch Bot Framework Emulator
  • File -> Open Bot
  • Enter a Bot URL of http://localhost:3978/api/messages

Deploy the bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.

Further reading