企业微信调用手册
向群推送文本通知
使用群消息推送的独立 Webhook,把通知送到其所属群。
← 返回平台功能接入准备
- 在允许添加消息推送的企业微信群中创建消息推送并取得 Webhook。
- 只需要 Webhook 的 key,不需要企业应用 access_token。
准备环境变量
示例值需要替换为自己的凭证或资源 ID。代码在本机或服务端运行;密钥不应放进公开网页。
WECOM_WEBHOOK_KEY- 群消息推送 Webhook 中的 key,泄露后应重置。
export WECOM_WEBHOOK_KEY='replace_with_webhook_key'以上 export 适用于 macOS / Linux 的终端,在同一终端内运行后续代码。Python 示例保存为 request.py 后执行 python3 request.py。
调用步骤
- 01
在消息推送详情复制 Webhook,取 key 查询参数,填入 WECOM_WEBHOOK_KEY。
- 02
执行下方文本请求;检查 errcode,再到群中核对通知。
- 03
需提醒具体群成员时,在 text.mentioned_list 放真实 userid;默认示例不 @ 全员。
调用 01
推送一条文本
仅发送测试文本,消息由该 Webhook 对应的消息推送发布。
POST
https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=${WECOM_WEBHOOK_KEY}请求头
Content-Typeapplication/json
参数说明
参数表可左右滑动,查看完整说明。
| 字段 / 位置 | 类型 / 必填 | 说明 |
|---|---|---|
keyQuery | string必填 | 群 Webhook 凭证。 |
msgtype请求体 | string必填 | 本例固定 text。 |
text.content请求体 | string必填 | UTF-8 文本,最长 2048 字节;不是 2048 个汉字。 |
text.mentioned_list请求体 | string[]可选 | 提醒指定群成员的 userid;使用 @all 会提醒全员。 |
调用代码
替换示例 ID 与请求体内容后运行。cURL 会报 HTTP 错误,业务状态还需按下方返回示例核对。
cat > request-body.json <<'JSON'
{
"msgtype": "text",
"text": {
"content": "接入测试:通知服务已启动"
}
}
JSON
# 执行后核对返回 JSON 的业务状态;HTTP 200 仍可能包含业务错误。
curl --silent --show-error --fail-with-body \
--request POST \
--url "https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=${WECOM_WEBHOOK_KEY}" \
--header "Content-Type: application/json" \
--data-binary @request-body.json
import json
import os
import re
import urllib.request
import urllib.error
def expand(value):
return re.sub(r"\$\{([A-Z][A-Z0-9_]*)\}",
lambda match: os.environ[match.group(1)], value)
url = expand("https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=${WECOM_WEBHOOK_KEY}")
headers = {
"Content-Type": expand("application/json"),
}
body = {
"msgtype": "text",
"text": {
"content": "接入测试:通知服务已启动",
},
}
data = json.dumps(body, ensure_ascii=False).encode("utf-8")
request = urllib.request.Request(url, data=data, headers=headers, method="POST")
try:
with urllib.request.urlopen(request, timeout=30) as response:
result = json.load(response)
except urllib.error.HTTPError as error:
print(f"HTTP {error.code}: {error.read().decode('utf-8', errors='replace')}")
raise SystemExit(1)
print(json.dumps(result, ensure_ascii=False, indent=2))
if isinstance(result, dict) and "errcode" in result and result["errcode"] != 0:
raise SystemExit("平台返回业务错误,请结合下方排错说明检查响应")
// Node.js 22+,保存为 request.mjs 后运行 node request.mjs
function expand(value) {
return value.replace(/\$\{([A-Z][A-Z0-9_]*)\}/g, (_, name) => {
if (!process.env[name]) throw new Error(`缺少环境变量 ${name}`);
return process.env[name];
});
}
const url = expand("https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=${WECOM_WEBHOOK_KEY}");
const headers = Object.fromEntries(
Object.entries({
"Content-Type": "application/json"
}).map(([key, value]) => [key, expand(value)])
);
const body = {
"msgtype": "text",
"text": {
"content": "接入测试:通知服务已启动"
}
};
const response = await fetch(url, {
method: "POST",
headers,
body: JSON.stringify(body),
signal: AbortSignal.timeout(30000),
});
const text = await response.text();
if (!response.ok) throw new Error(`HTTP ${response.status}: ${text}`);
const result = JSON.parse(text);
console.log(JSON.stringify(result, null, 2));
if (Object.hasOwn(result, "errcode") && result["errcode"] !== 0) {
throw new Error('平台返回业务错误,请结合下方排错说明检查响应');
}
返回示例
按官方字段整理的节选示意,使用虚构 ID,不是实测结果。成功以 errcode=0 为准。 以下为结构示意,非本站实测结果。
{
"errcode": 0,
"errmsg": "ok"
}常见错误与排查
errcode 非 0推送被拒绝- 核对 key、推送状态、文本长度及发送频率;以实际 errmsg 定位。
调用注意
- 每个消息推送最多 20 条/分钟。
- 此凭证不读取聊天历史;与智能机器人 API 模式、内部应用通知不同。
注意事项
- 文件和语音需用同一个消息推送的上传接口取得 media_id,media_id 仅 3 天有效;不能混用其他应用的媒体 ID。
核验来源
本站按官方资料整理本场景的必要调用步骤与代码,覆盖范围以本页列出的接口为准。官方资料用于追溯规范及查看变更。
- 01消息推送配置说明核验日期 2026-10-15
