Ethscriptions commited on
Commit
537b30f
·
verified ·
1 Parent(s): 6b5ca20

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +10 -191
README.md CHANGED
@@ -1,191 +1,10 @@
1
- # Go-WXPush - 微信消息推送服务 (基于golang)
2
-
3
- 这是一个基于 golang 开发的微信测试公众号模板消息推送服务。它提供了一个简单的 API 接口,让您可以轻松地通过 HTTP 请求将消息推送到指定的微信用户。感谢[frankiejun/wxpush](https://github.com/frankiejun/wxpush)
4
-
5
- <p align="center">
6
- <img src="./img/logo.png">
7
- </p>
8
-
9
- ## ✨ 特性
10
-
11
- ✅ 完全免费,下载即使用
12
- ✅ 支持 Docker 一键部署(镜像容器大小仅2MB)
13
- ✅ 每天 10 万次额度,个人用不完
14
- ✅ 真正的微信原生弹窗 + 声音提醒
15
- ✅ 支持多用户
16
- ✅ 提供免费服务[https://push.hzz.cool](https://push.hzz.cool)(请勿滥用)
17
- ✅ 跳转稳定,自带消息详情页面 (默认使用[https://push.hzz.cool/detail](https://push.hzz.cool/detail), 可自己部署后使用参数替换)
18
- ✅ 可无限换皮肤 (使用项目[wxpushSkin](https://github.com/frankiejun/wxpushSkin))
19
-
20
- ## ⚠️ 部署条件
21
-
22
- - [微信公众平台接口测试帐号申请](https://mp.weixin.qq.com/debug/cgi-bin/sandbox?t=sandbox/login)
23
- ![wx1.png](img/wx1.png)
24
- - 获取appid 、appsecret
25
- ![wx2.png](img/wx2.png)
26
- - 关注测试公众号,获取userid(微信号),新增测试模板(注意模版内容填写格式 `内容: {{content.DATA}}`) 获取template_id(模板ID)
27
- ![wx3.png](img/wx3.png)
28
- - 将以上获取到的参数代入下面使用即可
29
- ![wx3.png](img/w0.jpg)
30
- ![wx3.png](img/w1.jpg)
31
-
32
- ## 🚀 部署指南
33
-
34
- ### [下载编译好的文件启动](https://github.com/hezhizheng/go-wxpush/releases/)
35
-
36
- - 启动参数
37
- * 命令行启动参数(可不加,启动之后直接在url上拼接参数也可) `./go-wxpush_windows_amd64.exe -port "5566" -title "测试标题" -content "测试内容" -appid "xxx" -secret "xxx" -userid "xxx-k08" -template_id "xxx-Ks_PwGm--GSzllU" -base_url "https://push.hzz.cool"`
38
- * url请求参数(get) `与命令行参数名称一致` `/wxsend?appid=xxx&secret=xxx&userid=xxx-k08&template_id=xxx-Ks_PwGm--GSzllU&base_url=https://push.hzz.cool&content=保持微笑,代码无 bug!`
39
-
40
- ### 自行编译可执行文件(跨平台)
41
-
42
- ```
43
- # 用法参考 https://github.com/mitchellh/gox
44
- # 生成文件可直接执行
45
- gox -osarch="windows/amd64" -ldflags "-s -w" -gcflags="all=-trimpath=${PWD}" -asmflags="all=-trimpath=${PWD}"
46
- gox -osarch="darwin/amd64" -ldflags "-s -w" -gcflags="all=-trimpath=${PWD}" -asmflags="all=-trimpath=${PWD}"
47
- gox -osarch="linux/amd64" -ldflags "-s -w" -gcflags="all=-trimpath=${PWD}" -asmflags="all=-trimpath=${PWD}"
48
- gox -osarch="linux/arm64" -ldflags "-s -w" -gcflags="all=-trimpath=${PWD}" -asmflags="all=-trimpath=${PWD}"
49
- ```
50
-
51
- ### 🐳 Docker 启动
52
- - 将编译好的文件放在与 Dockerfile 同目录
53
- - 构建镜像
54
- ```
55
- docker build -t go-wxpush:v2 .
56
- ```
57
- - 启动镜像,参数与命令行保持一致
58
- ```
59
- docker run -d -p 5566:5566 --name go-wxpush0 go-wxpush:v2 \
60
- -port "5566" \
61
- -title "测试标题" \
62
- -content "测试内容" \
63
- -appid "xxx" \
64
- -secret "xxx" \
65
- -userid "xxx-k08" \
66
- -template_id "xxx-Ks_PwGm--GSzllU"
67
- ```
68
-
69
- ### 🐳 Docker 一键部署
70
- ```
71
- # 重新部署请先拉一遍最新的镜像
72
- docker pull hezhizheng/go-wxpush:v4
73
- # 参数格式与终端启动保持一致, 替换成实际值即可
74
- docker run -it -d -p 5566:5566 --init --name go-wxpush4 hezhizheng/go-wxpush:v4 \
75
- -port "5566" \
76
- -title "测试标题5566" \
77
- -content "测试内容5566" \
78
- -appid "xxx" \
79
- -secret "xxx" \
80
- -userid "xxx-k08" \
81
- -template_id "xxx-Ks_PwGm--GSzllU" \
82
- -tz "Asia/Shanghai"
83
- ```
84
-
85
- ## 🗭 默认消息详情页
86
-
87
- 服务启动成功后会自带消息详情页界面(即消息模板跳转的页面),访问地址 `http://127.0.0.1:5566/detail` ,如有公网地址,可设置base_url参数为对应的host即可(无需加/detail)。
88
- ![wx3.png](img/msg.png)
89
-
90
- ## ⚙️ API 使用方法
91
-
92
- 服务部署成功后,您可以通过构造 URL 发起 `GET` 请求来推送消息。
93
-
94
- ### 请求地址
95
-
96
- ```
97
- http://127.0.0.1:5566/wxsend
98
- ```
99
-
100
- ### 请求参数
101
-
102
- | 参数名 | 类型 | 是否必填 | 描述 |
103
- |---------------|--------|------|----------------------|
104
- | `port` | String | 否 | 指定启动端口(仅针对命令行) |
105
- | `title` | String | 是 | 消息的标题。 |
106
- | `content` | String | 是 | 消息的具体内容。 |
107
- | `appid` | String | 是 | 临时覆盖默认的微信 AppID。 |
108
- | `secret` | String | 是 | 临时覆盖默认的微信 AppSecret。 |
109
- | `userid` | String | 是 | 临时覆盖默认的接收用户 OpenID。 |
110
- | `template_id` | String | 是 | 临时覆盖默认的模板消息 ID。 |
111
- | `base_url` | String | 否 | 临时覆盖默认的跳转 URL。 |
112
- | `tz` | String | 否 | 时区(默认东八区) |
113
-
114
- ### 使用示例
115
-
116
- **基础推送**
117
-
118
- 向默认配置的所有用户推送一条消息:
119
-
120
- ```
121
- http://127.0.0.1:5566/wxsend?title=服务器通知&content=服务已于北京时间%2022:00%20重���
122
- ```
123
-
124
- **临时覆盖用户**
125
-
126
- 向一个临时指定的用户推送消息:
127
-
128
- ```
129
- http://127.0.0.1:5566/wxsend?title=私人提醒&content=记得带钥匙&userid=temporary_openid_here
130
- ```
131
-
132
- ### Webhook / POST 请求
133
-
134
- 除了 `GET` 请求,服务也支持 `POST` 方法,更适合用于自动化的 Webhook 集成。
135
-
136
- **请求地址**
137
-
138
- ```
139
- http://127.0.0.1:5566/wxsend
140
- ```
141
-
142
- **请求方法**
143
-
144
- ```
145
- POST
146
- ```
147
-
148
- **请求头 (Headers)**
149
-
150
- ```json
151
- {
152
- "Content-Type": "application/json"
153
- }
154
- ```
155
-
156
- **请求体 (Body)**
157
-
158
- 请求体需要是一个 JSON 对象,包含与 `GET` 请求相同的参数。
159
-
160
- ```json
161
- {
162
- "title": "Webhook 通知",
163
- "content": "这是一个通过 POST 请求发送的 Webhook 消息。"
164
- }
165
- ```
166
-
167
- **使用示例 (cURL)**
168
-
169
- ```bash
170
- curl --location --request POST 'http://127.0.0.1:5566/wxsend' \
171
- --data-raw '{
172
- "title": "来自 cURL 的消息",
173
- "content": "自动化任务已完成。"
174
- }'
175
- ```
176
-
177
- ### 成功响应
178
-
179
- 如果消息成功发送给至少一个用户,服务会返回 `"errcode": 0` 状态码。
180
-
181
- ### 失败响应
182
-
183
- 如果发生错误(如 token 错误、缺少参数、微信接口调用失败等),服务会返回相应的状态码和错误信息。
184
-
185
- ## 🤝 贡献
186
-
187
- 欢迎任何形式的贡献!如果您有好的想法或发现了 Bug,请随时提交 Pull Request 或创建 Issue。
188
-
189
- ## 📜 许可证
190
-
191
- 本项目采用 [MIT License](./LICENSE.txt) 开源许可证。
 
1
+ ---
2
+ title: Yytz
3
+ emoji: 🦀
4
+ colorFrom: indigo
5
+ colorTo: green
6
+ sdk: docker
7
+ pinned: false
8
+ ---
9
+
10
+ Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference