跳转到主要内容

Microsoft Bot Framework Bot Builder SDK for Python。

项目描述

Azure DevOps status for master branch Latest PyPI package version

在Bot Framework中,Bot Connector服务使您的机器人能够在Bot Framework Portal中配置的通道上与用户交换消息。

如何安装

pip install botframework-connector

如何使用

身份验证

您的机器人通过加密通道(SSL/TLS)使用HTTP与Bot Connector服务进行通信。当您的机器人向Connector服务发送请求时,它必须包含Connector服务可以使用来验证其身份的信息。

为了验证请求,您需要使用在注册您的机器人期间获得的App ID和密码配置Connector,Connector将处理其余部分。

更多信息:https://docs.microsoft.com/en-us/bot-framework/rest-api/bot-framework-rest-connector-authentication

示例

客户端创建(带有身份验证)、对话初始化并向用户发送活动。

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

APP_ID = '<your-app-id>'
APP_PASSWORD = '<your-app-password>'
SERVICE_URL = 'https://slack.botframework.com'
CHANNEL_ID = 'slack'
BOT_ID = '<bot-id>'
RECIPIENT_ID = '<user-id>'

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)]))

connector.conversations.send_to_conversation(conversation.id, Activity(
            type=ActivityTypes.message,
            channel_id=CHANNEL_ID,
            recipient=ChannelAccount(id=RECIPIENT_ID),
            from_property=ChannelAccount(id=BOT_ID),
            text='Hello World!'))

Rest API 文档

有关Connector服务API文档,请参阅我们的API参考

文档/Wiki

您可以通过访问我们的Wiki了解更多关于botbuilder-python项目的信息。

要求

源代码

最新开发者版本可在github仓库中找到:https://github.com/Microsoft/botbuilder-python/

贡献

本项目欢迎贡献和建议。大多数贡献都需要您同意一份贡献者许可协议(CLA),声明您有权利并且实际上确实授予我们使用您贡献的权利。有关详细信息,请访问https://cla.microsoft.com

当您提交拉取请求时,一个CLA机器人将自动确定您是否需要提供CLA,并相应地装饰PR(例如,标签,注释)。只需按照机器人提供的说明操作。您只需在整个使用我们的CLA的仓库中做一次。

本项目采用了Microsoft开源行为准则。有关更多信息,请参阅行为准则FAQ或通过opencode@microsoft.com与我们联系,提出任何额外的问题或评论。

报告安全问题

应通过电子邮件私下报告安全问题,通过电子邮件发送到微软安全响应中心(MSRC)的secure@microsoft.com。您应在24小时内收到回复。如果您由于某种原因没有收到回复,请通过电子邮件跟进以确保我们已收到您的原始消息。更多信息,包括MSRC PGP密钥,可在安全技术中心找到。

许可证

版权(c)微软公司。保留所有权利。

许可协议MIT

项目详情


下载文件

下载适合您平台的文件。如果您不确定该选择哪个,请了解更多关于 安装包 的信息。

源代码分发

此版本没有提供源代码分发文件。请参阅关于 生成分发存档 的教程。

构建的分发

botframework_connector-4.16.2-py2.py3-none-any.whl (100.3 kB 查看哈希值)

上传时间 Python 2 Python 3

由支持