从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

相关文章

中文分词jieba库的使用与实景应用(一)

知识星球:https://articles.zsxq.com/id_fxvgc803qmr2.html 目录 一.定义: 精确模式(默认模式): 全模式: 搜索引擎模式: paddle 模式(基于深度学习的分词模式): 二 自定义词典 三.文本解析   调整词出现的频率 四. 关键词提取 A. 基于TF-IDF算法的关键词提取 B. 基于TextRank算法的关键词提取

水位雨量在线监测系统概述及应用介绍

在当今社会,随着科技的飞速发展,各种智能监测系统已成为保障公共安全、促进资源管理和环境保护的重要工具。其中,水位雨量在线监测系统作为自然灾害预警、水资源管理及水利工程运行的关键技术,其重要性不言而喻。 一、水位雨量在线监测系统的基本原理 水位雨量在线监测系统主要由数据采集单元、数据传输网络、数据处理中心及用户终端四大部分构成,形成了一个完整的闭环系统。 数据采集单元:这是系统的“眼睛”,

python: 多模块(.py)中全局变量的导入

文章目录 global关键字可变类型和不可变类型数据的内存地址单模块(单个py文件)的全局变量示例总结 多模块(多个py文件)的全局变量from x import x导入全局变量示例 import x导入全局变量示例 总结 global关键字 global 的作用范围是模块(.py)级别: 当你在一个模块(文件)中使用 global 声明变量时,这个变量只在该模块的全局命名空

csu 1446 Problem J Modified LCS (扩展欧几里得算法的简单应用)

这是一道扩展欧几里得算法的简单应用题,这题是在湖南多校训练赛中队友ac的一道题,在比赛之后请教了队友,然后自己把它a掉 这也是自己独自做扩展欧几里得算法的题目 题意:把题意转变下就变成了:求d1*x - d2*y = f2 - f1的解,很明显用exgcd来解 下面介绍一下exgcd的一些知识点:求ax + by = c的解 一、首先求ax + by = gcd(a,b)的解 这个

hdu1394(线段树点更新的应用)

题意:求一个序列经过一定的操作得到的序列的最小逆序数 这题会用到逆序数的一个性质,在0到n-1这些数字组成的乱序排列,将第一个数字A移到最后一位,得到的逆序数为res-a+(n-a-1) 知道上面的知识点后,可以用暴力来解 代码如下: #include<iostream>#include<algorithm>#include<cstring>#include<stack>#in

zoj3820(树的直径的应用)

题意:在一颗树上找两个点,使得所有点到选择与其更近的一个点的距离的最大值最小。 思路:如果是选择一个点的话,那么点就是直径的中点。现在考虑两个点的情况,先求树的直径,再把直径最中间的边去掉,再求剩下的两个子树中直径的中点。 代码如下: #include <stdio.h>#include <string.h>#include <algorithm>#include <map>#

【Python编程】Linux创建虚拟环境并配置与notebook相连接

1.创建 使用 venv 创建虚拟环境。例如,在当前目录下创建一个名为 myenv 的虚拟环境: python3 -m venv myenv 2.激活 激活虚拟环境使其成为当前终端会话的活动环境。运行: source myenv/bin/activate 3.与notebook连接 在虚拟环境中,使用 pip 安装 Jupyter 和 ipykernel: pip instal

【区块链 + 人才服务】可信教育区块链治理系统 | FISCO BCOS应用案例

伴随着区块链技术的不断完善,其在教育信息化中的应用也在持续发展。利用区块链数据共识、不可篡改的特性, 将与教育相关的数据要素在区块链上进行存证确权,在确保数据可信的前提下,促进教育的公平、透明、开放,为教育教学质量提升赋能,实现教育数据的安全共享、高等教育体系的智慧治理。 可信教育区块链治理系统的顶层治理架构由教育部、高校、企业、学生等多方角色共同参与建设、维护,支撑教育资源共享、教学质量评估、

【机器学习】高斯过程的基本概念和应用领域以及在python中的实例

引言 高斯过程(Gaussian Process,简称GP)是一种概率模型,用于描述一组随机变量的联合概率分布,其中任何一个有限维度的子集都具有高斯分布 文章目录 引言一、高斯过程1.1 基本定义1.1.1 随机过程1.1.2 高斯分布 1.2 高斯过程的特性1.2.1 联合高斯性1.2.2 均值函数1.2.3 协方差函数(或核函数) 1.3 核函数1.4 高斯过程回归(Gauss

AI行业应用(不定期更新)

ChatPDF 可以让你上传一个 PDF 文件,然后针对这个 PDF 进行小结和提问。你可以把各种各样你要研究的分析报告交给它,快速获取到想要知道的信息。https://www.chatpdf.com/