Python 企业微信自建应用推送消息

原创

mob649e815a6b81 2024-08-06 12:40:05 ©著作权

©著作权归作者所有：来自51CTO博客作者mob649e815a6b81的原创作品，请联系作者获取转载授权，否则将追究法律责任

Python 企业微信自建应用推送消息

在现代企业中，及时的沟通是提高工作效率的重要一环。企业微信自建应用为我们提供了一个便捷的消息推送方式，今天，我们就来学习如何用 Python 实现企业微信自建应用的消息推送功能。

一、流程概述

在实际操作中，整体流程可以分为以下几个步骤。下面的表格列出了整个过程所需的步骤，以及每一步的简要描述：

步骤	描述
1. 创建企业微信应用	在企业微信管理后台创建自建应用，获取相关的应用信息
2. 获取Access Token	使用应用的凭证，获取Access Token
3. 发送消息	利用Access Token发送消息给指定的用户
4. 处理响应	处理接口返回的响应结果

二、逐步实现

接下来，我们将详细介绍每一步的具体操作，附上所需的代码和注释。

1. 创建企业微信应用

在开始代码编写之前，我们需要在企业微信管理后台新建一个自建应用。具体步骤如下：

登录企业微信后台。
在左侧导航栏中选择“应用”。
点击“创建应用”，填写相关信息。
创建完成后，可以获取到 agentid 和 secret，这两项信息在后续获取 Access Token 时将用到。

2. 获取Access Token

企业微信应用在发送消息之前，必须先获取 Access Token。Access Token 是调用接口的凭证，可以通过应用的 secret 获取。

以下是获取 Access Token 的代码：

import requests

def get_access_token(corp_id, secret):
    """
    获取应用的 Access Token

    Parameters:
    corp_id (str): 企业微信的企业ID
    secret (str): 应用的密钥

    Returns:
    str: Access Token
    """
    url = f"
    
    response = requests.get(url)
    result = response.json()
    
    if 'access_token' in result:
        return result['access_token']
    else:
        raise Exception(f"Error getting access token: {result}")

代码说明：

我们使用 requests 库发送 HTTP GET 请求，获取 Access Token。
通过 corp_id 和 secret 构造请求 URL，解析返回的 JSON 数据，提取出 access_token。

3. 发送消息

一旦获得 Access Token，我们就可以通过它来发送消息。这里我们使用图文消息作为示例。

以下是发送消息的代码：

def send_message(access_token, msg):
    """
    发送消息

    Parameters:
    access_token (str): 访问凭证
    msg (dict): 消息内容

    Returns:
    dict: 返回的响应内容
    """
    url = f"
    
    response = requests.post(url, json=msg)
    return response.json()

代码说明：

使用 POST 请求，将消息内容以 JSON 格式发送到指定的 URL。
返回发送结果的 JSON 响应。

# 发送消息示例
if __name__ == "__main__":
    # 企业ID和应用密钥
    CORP_ID = '你的企业ID'
    SECRET = '你的应用密钥'
    
    # 测试的消息内容
    message = {
        "touser": "用户ID",     # 可用用户ID或用户的标签进行指定
        "msgtype": "text",
        "agentid": "应用ID",   # 自建应用ID
        "content": "Hello from Python!"
    }
    
    # 获取 Access Token
    access_token = get_access_token(CORP_ID, SECRET)
    
    # 发送消息
    response = send_message(access_token, message)
    print(response)

代码说明：

touser 是接受消息的用户 ID，可以通过企业微信管理后台找到。
msgtype 定义了消息的类型，这里用的是文本消息。
在 main 函数内，我们调用 get_access_token 函数获取 Access Token，并使用 send_message 函数发送消息。

4. 处理响应

发送消息后，API 将返回一个 JSON 响应，我们需要根据响应结果进行相应的处理：

如果发送成功，响应中会包含一个 errcode 为 0 的字段。
如果发送失败，我们可以根据 errcode 来判断错误原因。

示例处理代码：

if response['errcode'] == 0:
    print("消息发送成功！")
else:
    print(f"消息发送失败，错误码：{response['errcode']}, 错误信息：{response['errmsg']}")

三、类图

为了更好地理解整个过程，我们可以用类图来表示：

classDiagram
    class WeChatAPI {
        +get_access_token(corp_id, secret)
        +send_message(access_token, msg)
    }

    class Message {
        +touser
        +msgtype
        +agentid
        +content
    }

    WeChatAPI --> Message : Sends