通过 Teams 聊天机器人从外部进程向组织用户发送主动消息
Sending proactive messages from an outside process to organizational users via Teams chat bot
我通过 Teams 在我的组织中安装了 Azure Bot。与机器人的交互功能正常。
我们有一个场景需要从外部进程(Azure 中的 C# 应用 运行)向我们的用户发送通知。
我尝试使用 Bot Framework REST API to create a conversation with a user in order to then message them with the notification as outlined here
这种情况不起作用,因为我无法为未使用全局 Bot Framework 租户的机器人获取访问令牌。我们的 Bot 作为 SingleTenant BotType 安装在我们的 Azure 租户上,所以我收到以下错误:
Application with identifier 'BOT-APP-ID' was not found in the directory 'Bot Framework'
我尝试了各种选项,包括 DirectLine 通道、BotConnector SDK 和 Power Automate - 但似乎没有一个符合我的需要。
有没有办法对我们安装的 Bot 使用 Rest API 来创建对话和发送消息?这将是理想的,因为我可以直接从触发它们的事件中启动这些通知。
更新
Hilton 在下面的回答使情况更加明朗。最终我不得不部署一个新的 Bot 集来使用 Multitenant BotType.
这配置了绑定到 Bot 集的 AppRegistration 以使用 MultiTenant。
此外,在托管 api/messages 端点的 WebApp 中,您必须包含一个名为 MicrosoftAppType[=45 的 属性 =] 并将其也设置为 MultiTenant。以下是 WebApp 所需的完整配置:
MicrosoftAppId: [The AppId of the AppRegistration]
MicrosoftAppPassword: [The Secret of the AppRegistration]
MicrosoftAppTenantId: [Your Tenant Id]
MicrosoftAppType: MultiTenant
为了捕获 ConversationId、ServiceUrl 和 UserId,我将以下内容添加到 OnMembersAddedAsync
foreach (var member in membersAdded)
{
if (!string.IsNullOrEmpty(member.AadObjectId))
{
//This is a user in our AAD. Store the conversation id reference:
var userId = member.AadObjectId;
var serviceUrl = turnContext.Activity.ServiceUrl;
var conversationId = turnContext.Activity.Conversation.Id;
//Save variables to your state store here...
}
else
{
// This is likely a test outside of Teams
//var userId = member.Id; //<-- Not used in my scenario
}
}
然后在我的外部应用程序(本例中为控制台)中,我可以使用这些变量(连同 AppRegistration 凭据)创建 Bot ConnectorClient 并更新对话:
using Microsoft.Bot.Connector;
using Microsoft.Bot.Connector.Authentication;
using Microsoft.Bot.Schema;
var botAppId = "[BOT_ID/APP_REG_ID]";
var botAppKey = "[APP_REG_SECRET]";
var conversationId = "[CONVERSATION_ID]";
var serviceUrl = "[SERVICE_URL]";
MicrosoftAppCredentials.TrustServiceUrl(serviceUrl);
var connector = new Microsoft.Bot.Connector.ConnectorClient(new Uri(serviceUrl), botAppId, botAppKey);
var activity = new Activity()
{
Text = "Proactively saying **Hello**",
Type = ActivityTypes.Message,
Conversation = new ConversationAccount(false, "personal", conversationId)
};
try
{
var result = await connector.Conversations.SendToConversationAsync(conversationId, activity);
Console.WriteLine("Notification sent!");
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
}
主动消息传递绝对是您想要的,但有几件重要的事情需要注意。这是一个示例 https://github.com/pnp/teams-dev-samples/tree/main/samples/bot-proactive-messaging that will hopefully be useful - I included both a C# and a Node version as well as some links to further reading, and here is a link to a video session where I talk more about the concept: https://www.youtube.com/watch?v=mM7-fYdcJhw&t=1398s.
简而言之,请记住 Bot Framework 可以在许多情况下使用,Teams 只是其中之一。重要的是,与其他上下文不同,当您在 Teams 中时,没有“创建”与用户对话的概念。只有一个“对话”,你基本上是在“继续”对话。结果,您想调用 continueConversation
。在我上面链接的同一个示例中,这里是 relevant line。在幕后,这确实是在调用 REST API,但像这样包装起来更容易。
但是,如示例所示,由于您无法 开始 对话,并且只能继续一个对话,因此您需要确保您已经拥有对话上下文,这也可能意味着确保用户已经将机器人安装到个人上下文中(这实际上是开始对话的内容)。 Here 是样本中发生的地方。
如果您的用户已经安装了机器人,那么它只是一个存储对话上下文的例子,就像我在示例中展示的那样。如果没有,并且您想了解如何 pre-install 机器人,请参阅此问题:
Hilton 的回答基本上是正确的,但是,值得注意的是一些额外的要点和附录...
首先,您可以通过 Teams 机器人开始 对话(如果它 return 现有对话的详细信息已经存在)并且意味着您的通知 API 端点可以接受 upn 而不是更神秘的“conversationId”——这不是最简单的事情,但可以使用适配器的 CreateConversationAsync
方法。挑战在于为您要向其发送消息的用户获取“内部”ID,因为这不容易获得并且是 ConversationReference
对象所必需的。
可以通过演示整个流程的 installedApps/chat
Graph call and inspecting the "members" (for which there would only be two... the user and the app). Then you can create a ConversationReference
object which in turn allows you to call CreateConversationAsync
and if it's not yet installed proactively installing the app for the user (assuming consented scopes) - here is a C# sample and a Node sample 获取用户与机器人之间 1:1 聊天的引用来检索此用户 ID。
注意: 要让主动安装生效,该应用确实需要在 public 应用商店或org 商店,因为 Teams 应用程序 ID(在清单中指定)是针对 side-loaded 个应用程序随机分配的,因此不容易被发现。
其次,尽管服务 url 现在在我的测试中需要一个地理区域 (https://smba.trafficmanager.net/{emea,uk,apac,etc...}),但您可以使用 任何有效的 值并且活动被路由正确...现在我不能确定将来是否会出现这种情况,显然您需要从数据流的角度研究这是否可以接受,但我通常会使用预配置的“后备” " serviceurl 然后在我收到轮流上下文时缓存每个用户的实际 serviceurl - 我也只存储这个 in-memory 因为它是否丢失并不重要,因为我将构建无论如何,随着时间的推移更新那本字典。
我有过这样的对话很多所以在这里写下它:https://hackandchat.com/teams-proactive-messaging/ - 这也包括主动安装,当你想通知没有'尚未安装该应用程序。
我通过 Teams 在我的组织中安装了 Azure Bot。与机器人的交互功能正常。
我们有一个场景需要从外部进程(Azure 中的 C# 应用 运行)向我们的用户发送通知。
我尝试使用 Bot Framework REST API to create a conversation with a user in order to then message them with the notification as outlined here
这种情况不起作用,因为我无法为未使用全局 Bot Framework 租户的机器人获取访问令牌。我们的 Bot 作为 SingleTenant BotType 安装在我们的 Azure 租户上,所以我收到以下错误:
Application with identifier 'BOT-APP-ID' was not found in the directory 'Bot Framework'
我尝试了各种选项,包括 DirectLine 通道、BotConnector SDK 和 Power Automate - 但似乎没有一个符合我的需要。
有没有办法对我们安装的 Bot 使用 Rest API 来创建对话和发送消息?这将是理想的,因为我可以直接从触发它们的事件中启动这些通知。
更新
Hilton 在下面的回答使情况更加明朗。最终我不得不部署一个新的 Bot 集来使用 Multitenant BotType.
这配置了绑定到 Bot 集的 AppRegistration 以使用 MultiTenant。
此外,在托管 api/messages 端点的 WebApp 中,您必须包含一个名为 MicrosoftAppType[=45 的 属性 =] 并将其也设置为 MultiTenant。以下是 WebApp 所需的完整配置:
MicrosoftAppId: [The AppId of the AppRegistration]
MicrosoftAppPassword: [The Secret of the AppRegistration]
MicrosoftAppTenantId: [Your Tenant Id]
MicrosoftAppType: MultiTenant
为了捕获 ConversationId、ServiceUrl 和 UserId,我将以下内容添加到 OnMembersAddedAsync
foreach (var member in membersAdded)
{
if (!string.IsNullOrEmpty(member.AadObjectId))
{
//This is a user in our AAD. Store the conversation id reference:
var userId = member.AadObjectId;
var serviceUrl = turnContext.Activity.ServiceUrl;
var conversationId = turnContext.Activity.Conversation.Id;
//Save variables to your state store here...
}
else
{
// This is likely a test outside of Teams
//var userId = member.Id; //<-- Not used in my scenario
}
}
然后在我的外部应用程序(本例中为控制台)中,我可以使用这些变量(连同 AppRegistration 凭据)创建 Bot ConnectorClient 并更新对话:
using Microsoft.Bot.Connector;
using Microsoft.Bot.Connector.Authentication;
using Microsoft.Bot.Schema;
var botAppId = "[BOT_ID/APP_REG_ID]";
var botAppKey = "[APP_REG_SECRET]";
var conversationId = "[CONVERSATION_ID]";
var serviceUrl = "[SERVICE_URL]";
MicrosoftAppCredentials.TrustServiceUrl(serviceUrl);
var connector = new Microsoft.Bot.Connector.ConnectorClient(new Uri(serviceUrl), botAppId, botAppKey);
var activity = new Activity()
{
Text = "Proactively saying **Hello**",
Type = ActivityTypes.Message,
Conversation = new ConversationAccount(false, "personal", conversationId)
};
try
{
var result = await connector.Conversations.SendToConversationAsync(conversationId, activity);
Console.WriteLine("Notification sent!");
}
catch (Exception ex)
{
Console.WriteLine(ex.Message);
}
主动消息传递绝对是您想要的,但有几件重要的事情需要注意。这是一个示例 https://github.com/pnp/teams-dev-samples/tree/main/samples/bot-proactive-messaging that will hopefully be useful - I included both a C# and a Node version as well as some links to further reading, and here is a link to a video session where I talk more about the concept: https://www.youtube.com/watch?v=mM7-fYdcJhw&t=1398s.
简而言之,请记住 Bot Framework 可以在许多情况下使用,Teams 只是其中之一。重要的是,与其他上下文不同,当您在 Teams 中时,没有“创建”与用户对话的概念。只有一个“对话”,你基本上是在“继续”对话。结果,您想调用 continueConversation
。在我上面链接的同一个示例中,这里是 relevant line。在幕后,这确实是在调用 REST API,但像这样包装起来更容易。
但是,如示例所示,由于您无法 开始 对话,并且只能继续一个对话,因此您需要确保您已经拥有对话上下文,这也可能意味着确保用户已经将机器人安装到个人上下文中(这实际上是开始对话的内容)。 Here 是样本中发生的地方。
如果您的用户已经安装了机器人,那么它只是一个存储对话上下文的例子,就像我在示例中展示的那样。如果没有,并且您想了解如何 pre-install 机器人,请参阅此问题:
Hilton 的回答基本上是正确的,但是,值得注意的是一些额外的要点和附录...
首先,您可以通过 Teams 机器人开始 对话(如果它 return 现有对话的详细信息已经存在)并且意味着您的通知 API 端点可以接受 upn 而不是更神秘的“conversationId”——这不是最简单的事情,但可以使用适配器的 CreateConversationAsync
方法。挑战在于为您要向其发送消息的用户获取“内部”ID,因为这不容易获得并且是 ConversationReference
对象所必需的。
可以通过演示整个流程的 installedApps/chat
Graph call and inspecting the "members" (for which there would only be two... the user and the app). Then you can create a ConversationReference
object which in turn allows you to call CreateConversationAsync
and if it's not yet installed proactively installing the app for the user (assuming consented scopes) - here is a C# sample and a Node sample 获取用户与机器人之间 1:1 聊天的引用来检索此用户 ID。
注意: 要让主动安装生效,该应用确实需要在 public 应用商店或org 商店,因为 Teams 应用程序 ID(在清单中指定)是针对 side-loaded 个应用程序随机分配的,因此不容易被发现。
其次,尽管服务 url 现在在我的测试中需要一个地理区域 (https://smba.trafficmanager.net/{emea,uk,apac,etc...}),但您可以使用 任何有效的 值并且活动被路由正确...现在我不能确定将来是否会出现这种情况,显然您需要从数据流的角度研究这是否可以接受,但我通常会使用预配置的“后备” " serviceurl 然后在我收到轮流上下文时缓存每个用户的实际 serviceurl - 我也只存储这个 in-memory 因为它是否丢失并不重要,因为我将构建无论如何,随着时间的推移更新那本字典。
我有过这样的对话很多所以在这里写下它:https://hackandchat.com/teams-proactive-messaging/ - 这也包括主动安装,当你想通知没有'尚未安装该应用程序。