Setting up the Enterprise Bot Builder SDK

This document explains how to setup the Enterprise Bot Builder SDK for using in other projects. This documentation closely follows the samples available along with it.

The Bot Builder SDK is exposed as the IEnterprisePlatform interface. Any bot created is an instance of the IEnterprisePlatform interface.

Calling Bots

This enterprise SDK supports two types of bots for calling. They are called the Local Media bots and Remote Media bots.

As their names suggest, Local Media bots media is hosted by the bot itself, i.e., the bot sends and receives raw Audio and Video frames as required. In Remote Media scenarios, Skype servers handle the media for you and you have an api to act on the particular media streams like playing a sound or receiving user input.

Important

Local Media calls require that the further notifications and updates from the server always hit the same instance of the bot when multiple instances are present. Look at State Management to learn more

Create a new bot

  • Register your bot in the Bot framework portal and save the Microsoft AppId and Password as entered in it.
  • Add the Skype channel and the settings required for that. You would select your media type (Local Media - Real Time Media or Remote Media - IVR) in the settings. You also provide a webhook where Skype would contact you for the notification of incoming calls.
  • After the setup is done, the bot now creates an EnterprisePlatformBuilder object to which you can set all the required parameters for the Bot like the credentials (SetCredentials), callback urls (SetCallbackUrl) and others.
  • Call EnterprisePlatformBuilder.Build method to create a IEnterprisePlatfrom instance which represents the SDK.