从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

相关文章

Python实现特殊字符判断并去掉非字母和数字的特殊字符

《Python实现特殊字符判断并去掉非字母和数字的特殊字符》在Python中,可以通过多种方法来判断字符串中是否包含非字母、数字的特殊字符,并将这些特殊字符去掉,本文为大家整理了一些常用的,希望对大家... 目录1. 使用正则表达式判断字符串中是否包含特殊字符去掉字符串中的特殊字符2. 使用 str.isa

python中各种常见文件的读写操作与类型转换详细指南

《python中各种常见文件的读写操作与类型转换详细指南》这篇文章主要为大家详细介绍了python中各种常见文件(txt,xls,csv,sql,二进制文件)的读写操作与类型转换,感兴趣的小伙伴可以跟... 目录1.文件txt读写标准用法1.1写入文件1.2读取文件2. 二进制文件读取3. 大文件读取3.1

使用Python实现一个优雅的异步定时器

《使用Python实现一个优雅的异步定时器》在Python中实现定时器功能是一个常见需求,尤其是在需要周期性执行任务的场景下,本文给大家介绍了基于asyncio和threading模块,可扩展的异步定... 目录需求背景代码1. 单例事件循环的实现2. 事件循环的运行与关闭3. 定时器核心逻辑4. 启动与停

基于Python实现读取嵌套压缩包下文件的方法

《基于Python实现读取嵌套压缩包下文件的方法》工作中遇到的问题,需要用Python实现嵌套压缩包下文件读取,本文给大家介绍了详细的解决方法,并有相关的代码示例供大家参考,需要的朋友可以参考下... 目录思路完整代码代码优化思路打开外层zip压缩包并遍历文件:使用with zipfile.ZipFil

Python处理函数调用超时的四种方法

《Python处理函数调用超时的四种方法》在实际开发过程中,我们可能会遇到一些场景,需要对函数的执行时间进行限制,例如,当一个函数执行时间过长时,可能会导致程序卡顿、资源占用过高,因此,在某些情况下,... 目录前言func-timeout1. 安装 func-timeout2. 基本用法自定义进程subp

Python实现word文档内容智能提取以及合成

《Python实现word文档内容智能提取以及合成》这篇文章主要为大家详细介绍了如何使用Python实现从10个左右的docx文档中抽取内容,再调整语言风格后生成新的文档,感兴趣的小伙伴可以了解一下... 目录核心思路技术路径实现步骤阶段一:准备工作阶段二:内容提取 (python 脚本)阶段三:语言风格调

Python结合PyWebView库打造跨平台桌面应用

《Python结合PyWebView库打造跨平台桌面应用》随着Web技术的发展,将HTML/CSS/JavaScript与Python结合构建桌面应用成为可能,本文将系统讲解如何使用PyWebView... 目录一、技术原理与优势分析1.1 架构原理1.2 核心优势二、开发环境搭建2.1 安装依赖2.2 验

Java字符串操作技巧之语法、示例与应用场景分析

《Java字符串操作技巧之语法、示例与应用场景分析》在Java算法题和日常开发中,字符串处理是必备的核心技能,本文全面梳理Java中字符串的常用操作语法,结合代码示例、应用场景和避坑指南,可快速掌握字... 目录引言1. 基础操作1.1 创建字符串1.2 获取长度1.3 访问字符2. 字符串处理2.1 子字

Vue3组件中getCurrentInstance()获取App实例,但是返回null的解决方案

《Vue3组件中getCurrentInstance()获取App实例,但是返回null的解决方案》:本文主要介绍Vue3组件中getCurrentInstance()获取App实例,但是返回nu... 目录vue3组件中getCurrentInstajavascriptnce()获取App实例,但是返回n

一文详解如何在Python中从字符串中提取部分内容

《一文详解如何在Python中从字符串中提取部分内容》:本文主要介绍如何在Python中从字符串中提取部分内容的相关资料,包括使用正则表达式、Pyparsing库、AST(抽象语法树)、字符串操作... 目录前言解决方案方法一:使用正则表达式方法二:使用 Pyparsing方法三:使用 AST方法四:使用字