从python应用app向微软Microsoft Teams Channel发送消息message

2024-08-29 06:36

本文主要是介绍从python应用app向微软Microsoft Teams Channel发送消息message,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

一、简介

有这样的需求,web app需要提供功能可以发送消息到Teams来提醒用户。所以需要将发消息到Teams功能集成到web app中。由于我们的web app是python开发的,所以使用pyteams库。

先看效果:有标题、内容、链接、@用户

二、步骤

2.1 首先在Teams channel中建一个webhook

直接参考官方文档:Create an Incoming Webhook - Teams | Microsoft Learn

建好之后把webhook的url复制保存好,这个url用来发送消息到指定的Teams channel

2.2 然后在web app中写代码来实现发送消息功能

参考pyteams官方文档,用法很简单:

​​​​​pymsteams · PyPI  / ​​​​​​​https://github.com/rveachkc/pymsteams

这个库虽然用起来很方便,但没有提供一个统一的类来实现我的一些需求,需要写繁琐的代码。因此我对这个库做了二次封装,可以轻松实现发送消息(标题、正文、链接、@某人等)

代码如下:这个模块可以命名为messenger.py

from pymsteams import connectorcard, TeamsWebhookException
import logging
from typing import List, Optional
import copy
from pydantic import BaseModel# 初始化日志记录
logger = logging.getLogger(__name__)# 定义发送到Teams的默认消息有效载荷模板
DEFAULT_PAYLOAD_TEMPLATE = {"type": "message","attachments": [{"contentType": "application/vnd.microsoft.card.adaptive","content": {"type": "AdaptiveCard","body": [],"actions": [],"$schema": "http://adaptivecards.io/schemas/adaptive-card.json","version": "1.0","msteams": {"width": "Full"}}}]
}class User(BaseModel):"""用户类,表示要在消息中提及的用户,具有可选的电子邮件和OID字段"""name: stremail: Optional[str] = ""oid: Optional[str] = ""class MessageDTO(BaseModel):"""MessageDTO类是数据传输对象,用于封装消息的详细信息"""text: strtitle: Optional[str] = Nonemention_users: Optional[List[User]] = Nonelink_title: Optional[str] = Nonelink_url: Optional[str] = Noneclass TeamsMessenger:"""Microsoft Teams的Messenger实现"""def __init__(self, webhook_url, messageDTO: MessageDTO):self.messageDTO = messageDTOself.my_messenger = connectorcard(hookurl=webhook_url)  # 使用Webhook URL初始化Teams连接器def send_message(self):"""构造并发送消息到Teams,使用连接卡"""try:# 初始化默认有效载荷模板self.my_messenger.payload = copy.deepcopy(DEFAULT_PAYLOAD_TEMPLATE)# 添加消息标题(如果提供)if self.messageDTO.title:self.my_messenger.payload["attachments"][0]["content"]["body"].append({"type": "TextBlock","size": "Large","weight": "Bolder","text": self.messageDTO.title})# 添加消息文本self.my_messenger.payload["attachments"][0]["content"]["body"].append({"type": "TextBlock","size": "Medium","text": self.messageDTO.text,"wrap": True})# 根据提供的用户添加提及if self.messageDTO.mention_users:mentions_entities = []  # 存储提及实体的列表mention_text = ""  # 累积用于在消息中显示的提及文本for mention_user in self.messageDTO.mention_users:mentions_entities.append({"type": "mention","text": f"<at>{mention_user.name}</at>",  # 使用markdown格式进行提及"mentioned": {"id": mention_user.email,  # 用户的标识符(假定为电子邮件)"name": mention_user.name}})# 格式化提及文本mention_text += f"@<at>{mention_user.name}</at> "self.my_messenger.payload["attachments"][0]["content"]["body"].append({"type": "TextBlock","text": mention_text})self.my_messenger.payload["attachments"][0]["content"]["msteams"]["entities"] = mentions_entities# 如果提供了标题和链接,则添加操作链接if self.messageDTO.link_title and self.messageDTO.link_url:self.my_messenger.payload["attachments"][0]["content"]["actions"].append({"type": "Action.OpenUrl","title": self.messageDTO.link_title,"url": self.messageDTO.link_url})# 发送构造的消息到Microsoft Teamsself.my_messenger.send()except TeamsWebhookException as e:  # 处理特定的Teams Webhook异常logger.error(f"发送Teams消息时发生错误。 {e}")except Exception as e:  # 处理其他任何异常logger.error(f"处理发送Teams消息时发生错误。 {e}")

调用时,只需要初始化messenger这个类,然后就可以轻松调用了。示例如下:

from msteams.messenger import TeamsMessenger, MessageDTO, User  # 导入TeamsMessenger、MessageDTO和User类  if __name__ == '__main__':  TEST_MESSENGER_WEBHOOK_URL = "你的webhook url"  # 设置测试用的Webhook URL  # 创建MessageDTO实例,用于封装要发送的消息内容  messageDTO = MessageDTO(  title="This is title",  # 消息标题  text="This is content",  # 消息内容  link_title="Visit xxx",  # 链接标题  link_url="xxx",          # 链接URL  mention_users=[User(name="lerry", email="xxx")]  # 提及的用户列表,这里包含一个用户  )  # 创建TeamsMessenger实例,传入Webhook URL和消息DTO  my_messenger = TeamsMessenger(webhook_url=TEST_MESSENGER_WEBHOOK_URL,  messageDTO=messageDTO)  # 发送消息  my_messenger.send_message()

三、总结

本文基于python应用和Teams工具,实现了发送消息到Teams的功能,对pyteams进行了二次封装,如果可能的话,有考虑把这个封装模块贡献到pyteams仓库。

这篇关于从python应用app向微软Microsoft Teams Channel发送消息message的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1117120

相关文章

SpringKafka消息发布之KafkaTemplate与事务支持功能

《SpringKafka消息发布之KafkaTemplate与事务支持功能》通过本文介绍的基本用法、序列化选项、事务支持、错误处理和性能优化技术,开发者可以构建高效可靠的Kafka消息发布系统,事务支... 目录引言一、KafkaTemplate基础二、消息序列化三、事务支持机制四、错误处理与重试五、性能优

SpringIntegration消息路由之Router的条件路由与过滤功能

《SpringIntegration消息路由之Router的条件路由与过滤功能》本文详细介绍了Router的基础概念、条件路由实现、基于消息头的路由、动态路由与路由表、消息过滤与选择性路由以及错误处理... 目录引言一、Router基础概念二、条件路由实现三、基于消息头的路由四、动态路由与路由表五、消息过滤

Python如何使用__slots__实现节省内存和性能优化

《Python如何使用__slots__实现节省内存和性能优化》你有想过,一个小小的__slots__能让你的Python类内存消耗直接减半吗,没错,今天咱们要聊的就是这个让人眼前一亮的技巧,感兴趣的... 目录背景:内存吃得满满的类__slots__:你的内存管理小助手举个大概的例子:看看效果如何?1.

Python+PyQt5实现多屏幕协同播放功能

《Python+PyQt5实现多屏幕协同播放功能》在现代会议展示、数字广告、展览展示等场景中,多屏幕协同播放已成为刚需,下面我们就来看看如何利用Python和PyQt5开发一套功能强大的跨屏播控系统吧... 目录一、项目概述:突破传统播放限制二、核心技术解析2.1 多屏管理机制2.2 播放引擎设计2.3 专

Python中随机休眠技术原理与应用详解

《Python中随机休眠技术原理与应用详解》在编程中,让程序暂停执行特定时间是常见需求,当需要引入不确定性时,随机休眠就成为关键技巧,下面我们就来看看Python中随机休眠技术的具体实现与应用吧... 目录引言一、实现原理与基础方法1.1 核心函数解析1.2 基础实现模板1.3 整数版实现二、典型应用场景2

Python实现无痛修改第三方库源码的方法详解

《Python实现无痛修改第三方库源码的方法详解》很多时候,我们下载的第三方库是不会有需求不满足的情况,但也有极少的情况,第三方库没有兼顾到需求,本文将介绍几个修改源码的操作,大家可以根据需求进行选择... 目录需求不符合模拟示例 1. 修改源文件2. 继承修改3. 猴子补丁4. 追踪局部变量需求不符合很

python+opencv处理颜色之将目标颜色转换实例代码

《python+opencv处理颜色之将目标颜色转换实例代码》OpenCV是一个的跨平台计算机视觉库,可以运行在Linux、Windows和MacOS操作系统上,:本文主要介绍python+ope... 目录下面是代码+ 效果 + 解释转HSV: 关于颜色总是要转HSV的掩膜再标注总结 目标:将红色的部分滤

Python 中的异步与同步深度解析(实践记录)

《Python中的异步与同步深度解析(实践记录)》在Python编程世界里,异步和同步的概念是理解程序执行流程和性能优化的关键,这篇文章将带你深入了解它们的差异,以及阻塞和非阻塞的特性,同时通过实际... 目录python中的异步与同步:深度解析与实践异步与同步的定义异步同步阻塞与非阻塞的概念阻塞非阻塞同步

Python Dash框架在数据可视化仪表板中的应用与实践记录

《PythonDash框架在数据可视化仪表板中的应用与实践记录》Python的PlotlyDash库提供了一种简便且强大的方式来构建和展示互动式数据仪表板,本篇文章将深入探讨如何使用Dash设计一... 目录python Dash框架在数据可视化仪表板中的应用与实践1. 什么是Plotly Dash?1.1

在C#中调用Python代码的两种实现方式

《在C#中调用Python代码的两种实现方式》:本文主要介绍在C#中调用Python代码的两种实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录C#调用python代码的方式1. 使用 Python.NET2. 使用外部进程调用 Python 脚本总结C#调