botframework-connector

What it is and what it does

botframework-connector is the Python client library for Microsoft's Bot Framework Connector service. It handles the HTTP communication layer between your bot and the Bot Framework, managing authentication via App ID and password credentials, and providing methods to create conversations and send activities (messages) to users across configured channels.

The package wraps REST API calls to the Bot Connector service, abstracting away the low-level HTTP details. You instantiate a ConnectorClient with MicrosoftAppCredentials, then use it to initialize conversations and send Activity objects to recipients. It depends on msrest for HTTP transport, PyJWT for token handling, botbuilder-schema for message type definitions, and msal for Microsoft authentication.

Use it for:

• Initialize a conversation with a user on a Bot Framework channel and send a welcome message
• Authenticate your bot with the Connector service using registered App ID and password credentials
• Send formatted activities (messages, cards, attachments) to users across multiple channels
• Build a Python bot that integrates with channels via Bot Framework Portal

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Enables Python bots to send and receive messages through Microsoft Bot Framework channels by providing HTTP client authentication and conversation management.

No. The repository is archived and the project is abandoned as of 2026-01-05 with no active maintenance. While the package has low install friction and a permissive MIT license, the lack of ongoing support means security vulnerabilities, breaking changes in dependencies, or incompatibilities with current services will not be addressed. Use only if maintaining legacy code that already depends on it.

Install

botframework-connector on PyPI

pip install botframework-connector

uv add botframework-connector

poetry add botframework-connector

Installing botframework-connector

Before you install

Low friction installation with four runtime dependencies (msrest, PyJWT, botbuilder-schema, msal). However, the repository is archived and marked abandoned as of the latest release on 2026-01-05, with no active maintenance.

License in practice

Licensed under MIT (permissive), so you may use, modify, and distribute this package freely with minimal restrictions, though you must include the license notice.

Quickstart

pip install botframework-connector

from botbuilder.schema import *
from botframework.connector import ConnectorClient
from botframework.connector.auth import MicrosoftAppCredentials

credentials = MicrosoftAppCredentials(APP_ID, APP_PASSWORD)
connector = ConnectorClient(credentials, base_url=SERVICE_URL)
conversation = connector.conversations.create_conversation(ConversationParameters(
    bot=ChannelAccount(id=BOT_ID),
    members=[ChannelAccount(id=RECIPIENT_ID)]))

Requires Python >= 3.7.0 and valid Microsoft App ID and password obtained during bot registration.

Verify before relying

• Whether the archived repository will receive security patches or bug fixes in the future
• Compatibility with current Microsoft Bot Framework Portal registration and service endpoints
• Whether alternative maintained packages now provide the same Bot Framework connector functionality

Package facts

Evidence: botframework_connector-4.17.1-py2.py3-none-any.whl

Keywords: BotFrameworkConnector, bots, ai, botframework, botbuilder

Tags

More Artificial Intelligence packages