Python如何对接飞书API发送自定义消息到指定群组

最新推荐文章于 2024-08-28 11:02:36 发布

程序员杨叔

最新推荐文章于 2024-08-28 11:02:36 发布

阅读量1.1k

点赞数 21

分类专栏： Python 测试平台开发文章标签： python 飞书软件测试测试开发

本文链接：https://blog.csdn.net/baidu_28340727/article/details/140999680

版权

测试平台开发同时被 2 个专栏收录

23 篇文章 0 订阅

订阅专栏

Python

21 篇文章 15 订阅

订阅专栏

一、背景

随着数字化办公环境的深入发展，企业需要越来越多的工具来提高团队之间的沟通效率和工作协作能力，飞书（Feishu）作为一款全面的企业协作平台，已经被越来越多的企业选择作为团队内部使用的办公工具，而飞书强大的API接口，也为开发者提供了丰富的定制和扩展能力。

本文将重点介绍如何利用飞书的API功能来发送自定义消息到指定群组。通过这种方式，您可以实现诸如自动化通知、任务提醒、数据更新通知等工作流程，大大提升团队的协作效率和工作的及时性。

二、准备工作：飞书开放平台创建应用

2.1 要发送消息，首先需要一个消息发起方，因此需要先前往飞书开放平台，创建一个应用：
在这里插入图片描述
2.2 应用下添加一个机器人，后续在飞书群组中添加该机器人来发送消息：

2.3 然后进入自己创建的应用详情页面，查看应用凭证信息：

2.4 进入应用发布=》版本管理与发布，发布机器人版本。注意：只有发布后的机器人，才能在飞书中被搜索到，然后添加到群组中去使用。
在这里插入图片描述
2.5 同时注意权限设置：在左侧导航栏中，进入开发配置 > 权限管理，在 API 权限中，添加以下权限。

获取与更新群组信息
获取与发送单聊、群组消息

至此，准备工作就已经完成。关于上述步骤的更多详情，可以参考飞书开发指南文档：https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/create-an-app

三、开始编码

3.1 编写代码通过应用凭证信息app_id+app_secret，封装get_access_token方法，获取该机器人的访问令牌：access_token

def get_access_token(app_id, app_secret):
    """
    获取机器人access_token
    """
    url = "https://open.feishu.cn/open-apis/auth/v3/tenant_access_token/internal"
    req = {
        "app_id": app_id,
        "app_secret": app_secret
    }
    request_content = json.dumps(req)
    headers = {
        'Content-Type': 'application/json; charset=utf-8'
    }
    response = requests.request("POST", url, headers=headers, data=request_content)
    print(response.text)
    token = response.json()["tenant_access_token"]
    print("token的值：", token)
    return token

成功获取到access_token值，返回结果如下图：
在这里插入图片描述
3.2 飞书里面，将该机器人添加到需要发送消息的群组内。封装get_chats方法，通过access_token入参，获取该机器人所在群组的信息，用于后续往指定群组发送消息使用：

def get_chats(access_token):
    """
    获取飞书机器人所在的群列表
    """
    url = "https://open.feishu.cn/open-apis/im/v1/chats"
    headers = {"Authorization": "Bearer {0}".format(access_token)}
    response = requests.request("GET", url, headers=headers)
    res = response.json()
    chats = [{"chat_id": i["chat_id"], "name": i["name"]} for i in res["data"]["items"]]
    print("所在群列表：", chats)

成功获取该机器人所在群组的信息，返回结果如下图：
在这里插入图片描述
3.3 根据前面获得的access_token + 群组信息，封装send方法，调用飞书机器人发送消息API接口，向指定群组发送自定义的消息内容：

def send(access_token, chat_id, msg):
    """
    执行机器人向飞书群组发送消息
    """
    url = "https://open.feishu.cn/open-apis/im/v1/messages"
    params = {"receive_id_type": "chat_id"}
    msg_content = {
        "text": msg,
    }
    req = {
        "receive_id": chat_id,
        "content": json.dumps(msg_content),
        "msg_type": "text",
    }
    payload = json.dumps(req)
    headers = {
        'Authorization': 'Bearer {0}'.format(access_token),
        'Content-Type': 'application/json'
    }
    response = requests.request("POST", url, params=params, headers=headers, data=payload)
    if response.status_code != 200:
        raise Exception("执行机器人向飞书群组发送消息失败")
    res = response.json()
    return res

3.4 最后调用上面封装的方法，完成给指定群组发送指定消息内容的发送，注意将代码中app_id、app_secret的值改为你的应用的值：

if __name__ == '__main__':

    # 项目测试进度消息发送
    app_id = "你的应用app_id"
    app_secret = "你的应用app_secret"
    # 获取机器人的访问令牌
    access_token = get_access_token(app_id,app_secret)
    # 获取该机器人所在群组
    chart_group = get_chats(access_token)

    # 机器人可能在多个群组中，给指定某个群组发消息
    for i in chart_group:
        if i['name'] == '测试消息群':
            # 自定义项目名称、消息体内容
            project_name = '字节跳动'
            detail_message = '1. 项目处于第一轮新功能测试阶段，测试进度60%'
            msg = """<at user_id="all">所有人</at>今日%s项目，测试进度情况如下，请相关责任人注意把控风险:
%s""" % (project_name, detail_message)
            # 发送消息
            send(access_token,i['chat_id'],msg)

成功在飞书中给“测试消息群”，发送了以下消息：
在这里插入图片描述

四、定时发送消息

4.1 很多时候我们想要定时运行脚本发送消息，比如每天的下午6点都定时发送通知，参看我之前的文章：Python脚本如何定时运行

五、优化：只在工作日发送消息

5.1 很多时候，我们只想在工作日定时发送飞书消息通知，节假日和周末的时候，就不要再无脑定时发送消息去打扰大家。这个时候就需要判断当前日期是不是节假日，这里给大家推荐一个好用的Python库：chinese_calendar。

5.2 安装：

pip install chinese_calendar

5.3 常用函数：

is_workday    判断是否为工作日，语法：is_workday(date)
is_holiday    判断是否为节假日/休息日，语法：is_holiday(date)
get_holiday_detail 判断是否为节假日并获取节假日名称，语法：get_holiday_detail(date)
get_workdays    传入开始日期和结束日期，得到工作日的日期，语法：get_workdays（start_date,end_date）
get_holidays    传入开始日期和结束日期，得到休息日的日期，语法：get_holidays（start_date,end_date）

5.4 用法举例：

import datetime
from chinese_calendar import is_workday

date = datetime.datetime.now().date()
# 判断当前日期是不是工作日，工作日才发消息
if is_workday(date):
    print("是工作日")
else:
    print("是休息日")

5.5 结合之前发送飞书消息的代码，则是在调用方法前先判断是不是工作日，是工作日才发送消息：

if __name__ == '__main__':
    # 获取当前日期并判断是不是工作日，工作日才发消息
    date = datetime.datetime.now().date()
    if is_workday(date):
        # 项目测试进度消息发送
        ......

六、更炫酷的卡片消息

6.1 使用上面的内容，发送普通飞书消息已经没有问题。现在飞书还提供了交互页面更好看的卡片消息，让数据更加可视化，并且还能支持一些简单的交互操作。普通消息和卡片消息对比图：
在这里插入图片描述
是不是比普通消息更加炫酷、交互也更友好！限于本文篇幅，详细的搭建使用方法如果有大家需要的话，后续可以单独写一篇文章来介绍，这里只简单提一下：

官方指导文档：https://open.feishu.cn/document/uAjLw4CM/ukzMukzMukzM/feishu-cards/feishu-card-cardkit/build-card-content
发送消息的请求入参：

req = {
   // 消息接收者的ID
  "receive_id": "机器人所在的群组ID",
  
  // 卡片消息类型为interactive
  "msg_type": "interactive",
  
  // 消息内容
  "content": "{\"type\":\"template\",\"data\":{\"template_id\":\"xxxxxxxxxxxx\",\"template_version_name\":\"1.0.0\",\"template_variable\":{\"key1\":\"value1\",\"key2\":\"value2\"}}}"
}

消息内容说明：

template_id：搭建工具中创建的卡片的ID，如 AAqigYkzabcef，可在搭建工具中通过复制卡片ID获取
template_version_name：搭建平台中创建的卡片的版本号，如 1.0.0
template_variable：如果卡片模板内设置了变量，则可以在此处为变量名（key）赋值（value），需要动态生成卡片内容时会用到