15.handling-attachments

This sample demonstrates different ways a bot may send and receive attachments.

Concepts introduced in this sample

What is a bot?

A bot is an app that users interact with in a conversational way using text, graphics (cards), or speech. It may be a simple question and answer dialog, or a sophisticated bot that allows people to interact with services in an intelligent manner using pattern matching, state tracking and artificial intelligence techniques well-integrated with existing business services.

Attachments

A message exchange between user and bot may contain cards and media attachments, such as images, video, audio, and files. The types of attachments that may be sent and received varies by channel. Additionally, a bot may also receive file attachments.

To try this sample

• Clone the repository.

git clone https://github.com/microsoft/botbuilder-samples.git

• [Optional] Update the appsettings.json file under botbuilder-samples/samples/csharp_dotnetcore/15.handling-attachments with your botFileSecret. For Azure Bot Service bots, you can find the botFileSecret under application settings.

Running Locally

Visual Studio

• Navigate to the samples folder (botbuilder-samples/samples/csharp_dotnetcore/15.handling-attachments) and open HandlingAttachmentsBot.csproj in Visual Studio
• Run the project (press F5 key)

.NET Core CLI

• Install the .NET Core CLI tools.
• Using the command line, navigate to botbuilder-samples/samples/csharp_dotnetcore/15.handling-attachments
• Type dotnet run.

Testing the bot using Bot Framework Emulator

Microsoft 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.

Connect to bot using Bot Framework Emulator V4

• Launch the Bot Framework Emulator.
• File -> Open bot and navigate to botbuilder-samples/samples/csharp_dotnetcore/06.using-cards folder.
• Select handling-attachments.bot file.

Deploy this bot to Azure

You can use the MSBot Bot Builder CLI tool to clone and configure any services this sample depends on. In order to install this and other tools, you can read Installing CLI Tools.

To clone this bot, run

msbot clone services -f deploymentScripts/msbotClone -n <BOT-NAME> -l <Azure-location> --subscriptionId <Azure-subscription-id> --appId <YOUR APP ID> --appSecret <YOUR APP SECRET PASSWORD>

NOTE: You can obtain your appId and appSecret at the Microsoft's Application Registration Portal

Further reading

• Azure Bot Service Introduction
• Bot Basics
• Channels and Bot Connector Service
• Activity Processing
• Attachments