👁 Image
Microsoft.Teams.Apps.BotBuilder 1.0.4

Microsoft.Teams.Apps.BotBuilder

A compatibility bridge that enables existing Bot Framework SDK v4 applications to run on the modern Microsoft Teams Bot Core infrastructure. It implements the Adapter pattern, translating between Bot Framework interfaces and the new Teams Core SDK — allowing migration without rewriting existing bot logic.

Key Features

• Drop-in Adapter — TeamsBotFrameworkHttpAdapter implements IBotFrameworkHttpAdapter, so existing bots work with minimal changes
• Full Conversation Support — Send, update, delete activities, manage members, and handle attachments through adapted interfaces
• OAuth Compatibility — CompatUserTokenClient bridges token management between the two frameworks
• Proactive Messaging — ContinueConversationAsync for resuming conversations from external triggers
• Teams API Access — Static TeamsApiClient methods for Teams-specific operations (meetings, batch messaging, team/channel metadata)
• Schema Translation — Bidirectional conversion between Bot Framework and Core activity models

Installation

dotnet add package Microsoft.Teams.Apps.BotBuilder

Quick Start

Register the Adapter

var builder = WebApplication.CreateBuilder(args);
builder.AddTeamsBotFrameworkHttpAdapter();

var app = builder.Build();
// Map your existing IBot implementation to the endpoint
app.MapPost("api/messages", async (HttpContext context) =>
{
 var adapter = context.RequestServices
 .GetRequiredService<IBotFrameworkHttpAdapter>();
 var bot = context.RequestServices.GetRequiredService<IBot>();
 await adapter.ProcessAsync(
 context.Request, context.Response, bot, context.RequestAborted);
});

app.Run();

Use with an Existing Bot

Your existing IBot implementation works unchanged:

public class MyBot : ActivityHandler
{
 protected override async Task OnMessageActivityAsync(
 ITurnContext<IMessageActivity> turnContext, CancellationToken ct)
 {
 await turnContext.SendActivityAsync(
 MessageFactory.Text($"Echo: {turnContext.Activity.Text}"), ct);
 }
}

// Register your bot
builder.Services.AddTransient<IBot, MyBot>();

Teams-Specific Operations

Use the static TeamsApiClient for Teams APIs within your bot handlers:

// Get a specific member
var member = await TeamsApiClient.GetMemberAsync(turnContext, userId);

// Get team details
var team = await TeamsApiClient.GetTeamDetailsAsync(turnContext);

// Get paginated team members
var members = await TeamsApiClient.GetPagedTeamMembersAsync(turnContext, teamId);

// Meeting info
var meeting = await TeamsApiClient.GetMeetingInfoAsync(turnContext);

// Send notification to a meeting
await TeamsApiClient.SendMeetingNotificationAsync(turnContext, notification);

Batch Messaging

// Send to all users in a team
var operationId = await TeamsApiClient.SendMessageToAllUsersInTeamAsync(
 turnContext, activity, teamId, tenantId);

// Send to all users in tenant
var operationId = await TeamsApiClient.SendMessageToAllUsersInTenantAsync(
 turnContext, activity, tenantId);

// Check operation status
var state = await TeamsApiClient.GetOperationStateAsync(turnContext, operationId);

// Get failed entries
var failures = await TeamsApiClient.GetPagedFailedEntriesAsync(turnContext, operationId);

Proactive Messaging

var adapter = serviceProvider
 .GetRequiredService<IBotFrameworkHttpAdapter>() as TeamsBotFrameworkHttpAdapter;

await adapter!.ContinueConversationAsync(
 botId, conversationReference,
 async (turnContext, ct) =>
 {
 await turnContext.SendActivityAsync("Proactive notification!", cancellationToken: ct);
 });

Architecture

The library bridges two frameworks through a set of adapter classes:

Bot Framework SDK Teams Bot Core
───────────────── ──────────────
IBotFrameworkHttpAdapter ←──→ TeamsBotFrameworkHttpAdapter
BotAdapter ←──→ TeamsBotAdapter
IConnectorClient ←──→ CompatConnectorClient
IConversations ←──→ CompatConversations → ConversationClient
UserTokenClient ←──→ CompatUserTokenClient → Core UserTokenClient
Activity (BF) ←──→ CoreActivity (ActivitySchemaMapper)

• TeamsBotFrameworkHttpAdapter handles HTTP request/response lifecycle and delegates to the Core SDK
• CompatConversations implements IConversations by forwarding calls to the Core ConversationClient
• CompatUserTokenClient adapts Core token operations to the Bot Framework UserTokenClient interface
• ActivitySchemaMapper provides bidirectional conversion between Bot Framework Activity and Core CoreActivity
• TeamsApiClient provides static methods for Teams-specific APIs not covered by standard Bot Framework interfaces

Main Types