xxxf0512 / wechat-public-account-push

微信公众号推送-给女朋友的浪漫

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

wechat-public-account-push

GitHub Stars GitHub Forks GitHub Issues GitHub Contributors GitHub License Unit Test

wechat-public-account-push 是一个用于微信公众号/微信测试号给用户执行微信推送的脚本,改编自目前小红书/知乎突然火起来的【给女朋友的七夕浪漫,微信自动推送消息】,用Nodejs实现而成。

如果这个项目很有意思,帮忙右上角点个 star✨ 支持我们 ❤❤

如果有任何需要帮助可以联系wangxin.leo@outlook.com ❤❤

>>> 点这里获取更新公告✨

详细功能如下:

  • 支持多个收件人设置成不同的测试号模板,专属定制更贴心
  • 推送每日天气
  • 支持农历生日提醒
  • 每日/明日/每周/每年星座运势
  • 文艺青年专属每日一句
  • 古诗古文
  • 彩虹屁
  • 朋友圈文案
  • 毒鸡汤
  • 根据配置就近推送前N个值得纪念的日子
  • 自定义出参,模板定制更个性
  • 推送回执
  • 不需要拥有服务器,白嫖actions执行,每天定时发送
  • 支持gitee go
  • 支持本地化部署每天定时发送
  • 理论上支持所有远端的日志推送(目前仅支持测试号,没时间做)

[目录]

Github 仓库地址:wangxinleo/wechat-public-account-push

Github 镜像仓库地址(国内备用01):wangxinleo/wechat-public-account-push

Github 镜像仓库地址(国内备用02):wangxinleo/wechat-public-account-push

注意:

  • 本仓库开源的初衷是看不下去营销号用这么一个简单的脚本刻意在网络上肆意要求加群/关注微信公众号才能获取源码的行为
  • 本应用仅用于学习和测试,作者本人并不对其负责,请于运行测试完成后自行删除,请勿滥用!
  • 所有代码都是开源且透明的,任何人均可查看,程序不会保存或滥用任何用户的个人信息
  • 请仔细阅读配置文档,自己对自己的配置负责

运行图示:

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址)

1. 如何使用(以测试号为例)

wechat-public-account-push 实现自消息推送的原理,是通过调用一系列开放的api实现的, 所以也非常适合初学者学习。

要使用 wechat-public-account-push, 我们只需要做拥有自己的公众号, 得到相关配置信息进行配置即可

1.1. 第一步:注册一个微信公众测试号

  • 浏览器打开并登录 微信公众测试号

  • 登录成功后, 就可以生成微信公众测试号的appID和appsecret这两串数字, 记下备用

图片无法查看请移步顶部访问 国内备用仓库地址

  • 扫描测试号二维码关注测试号, 扫描之后, 右边就会出现相应的已关注人员id, 记下备用

图片无法查看请移步顶部访问 国内备用仓库地址

1.2. 第二步:进行模板配置

新增测试模板, 点击 新增测试模板 , 进行以下设置

这里面的每一个{{***.DATA}}都对应相应的数据,需要就保留,不需要就删掉

更多模板 请查看上方更新内容

模板标题: 自定义,例如: 亲爱的,早上好!

模板内容:

{{date.DATA}}  
城市:{{city.DATA}}  
天气:{{weather.DATA}}  
最低气温: {{min_temperature.DATA}}  
最高气温: {{max_temperature.DATA}}  
今天是我们恋爱的第{{love_day.DATA}}天
今天是我们结婚的第{{marry_day.DATA}}天

{{birthday_message.DATA}}

{{one_talk.DATA}} -- {{talk_from.DATA}}

{{note_en.DATA}}  
{{note_ch.DATA}}

模板标题: 推送完成提醒

模板内容:

服务器信息:{{post_time_zone.DATA}} {{post_time.DATA}}

共推送 {{need_post_num.DATA}}  人
成功: {{success_post_num.DATA}} | 失败: {{fail_post_num.DATA}}
成功用户: {{success_post_ids.DATA}}
失败用户: {{fail_post_ids.DATA}}

记下模板代码

图片无法查看请移步顶部访问 国内备用仓库地址

1.3. 第三步:完成配置文件,并运行wechat-public-account-push

1.3.1 方式一:使用Github-Action(不准时,排队执行,胜在免费)

👇👇👇👇点击展开

1.3.1.1 fork仓库并修改相应配置

  • fork仓库

github-fork

  • 修改相应配置

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

  • 按提示填入相应配置后保存

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

1.3.1.2 在私人仓库中写入自己公众号的信息,启用workflow自动任务,定时执行

  • 按下图添加两项保密信息APP_IDAPP_SECRET, 可以从测试号后台拿到这两项信息

这步一定要认真填写,不然程序无法运行!

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

  • 启用action脚本

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

1.3.1.3 (选做):检查脚本是否可以正常执行

  • 手动启动脚本

图片无法查看请移步顶部访问 国内备用仓库地址

  • 查看执行结果

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

1.3.1.4 (选做):如何更改自动执行时间

5.1. github action如何更改自动执行时间


1.3.2 方式二:使用Gitee-go(定时任务收费,前200分钟免费,非常准时)

👇👇👇👇点击展开

>>> gitee国内仓库地址 wechat-public-account-push <<<

1.3.2.1 fork gitee仓库并修改相应配置

  • fork仓库

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

  • 保护个人隐私安全,将仓库设为私有

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

  • 修改相应配置

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

  • 按提示填入相应配置后保存

图片无法查看请移步顶部访问 国内备用仓库地址

1.3.2.2 在私人仓库中写入自己公众号的信息,启用【流水线】自动任务,定时执行

  • 启用【流水线】

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

version: '1.0'
name: weixin-push-on-time
displayName: weixin-push-on-time
triggers:
  trigger: auto
  schedule:
    # 以下时间指北京时间8点整
    - cron: '* 0 8 * * ? *'
stages:
  - name: stage-d2bdc7e0
    displayName: 微信推送
    strategy: naturally
    trigger: auto
    executor: []
    steps:
      - step: build@nodejs
        name: build_nodejs
        displayName: Nodejs 构建
        nodeVersion: 16.14.2
        commands:
          - '# 设置NPM源,提升安装速度'
          - npm config set registry https://registry.npmmirror.com
          - ''
          - git checkout master
          - ''
          - npm ci
          - ''
          - '# 执行编译命令'
          - npm run dev
        caches:
          - ~/.npm
          - ~/.yarn
        notify: []
        strategy:
          retry: '0'

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

1.3.2.3 (选做):检查脚本是否可以正常执行

  • 手动启动脚本

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

  • 查看执行结果

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

1.3.2.4 (选做):如何更改自动执行时间

5.2. gitee go如何更改自动执行时间


1.3.3 方式三:下载程序包到本地或服务器运行(需要有自己的服务器,使用系统的定时任务非常准时)

如果是 Nodejs 开发者,直接 Clone 源码,然后 VS 打开解决方案,配置 Cookie 后即可直接本地进行运行和调试。

对于不是开发者的朋友,可以通过以下命令到本地或任意服务器运行,步骤如下。

  • Linux 系统

👇👇👇👇点击展开

Ⅰ. 安装运行环境

  • 如果本地已安装 Nodejsgit 环境, 请跳过这一步

如果您使用的是以 Debian 或 Ubuntu 为基础的 服务器系统

# Using Debian and Ubuntu based distributions
cd ~

curl -fsSL https://deb.nodesource.com/setup_16.x | sudo -E bash -

sudo apt-get install -y nodejs

sudo apt-get install git

如果您使用的是 centos 或 其他 服务器系统

# Using Enterprise Linux based distributions
cd ~

curl -fsSL https://rpm.nodesource.com/setup_16.x | sudo bash -

yum install git

Ⅱ. 下载项目

cd ~ && git clone https://github.com/wangxinleo/wechat-public-account-push.git

cd ~/wechat-public-account-push

# 二选一:**内地执行这一步,速度更快
npm install -g cnpm --registry=https://registry.npm.taobao.org  && cnpm install && cnpm install pm2 -g

# 二选一:国外服务器执行这一步
npm install && npm install pm2 -g

Ⅲ. 填写发送配置

不会使用vim 命令的可以使用其他命令,或用图形化界面进行修改。

这是你的服务器,只要能改掉文件里的配置就可以了。

vim ~/wechat-public-account-push/config/index.js

Ⅳ. 填写发送配置 不会使用vim 命令的可以使用其他命令,或用图形化界面进行修改。

这是你的服务器,只要能改掉文件里的配置就可以了。

此时间为每天的早上8点,*为匹配任意一个

这里的时间是**时间 秒 分 时 日 月 年

0 0 8 * * *

更详细的规则点此

vim ~/wechat-public-account-push/config/server-config.js

Ⅴ. 运行

cd ~/wechat-public-account-push && npm run pm2start

运行完成效果图

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

Ⅵ. 如何停止/重启/删除服务?如何查看运行日志/清空日志?

# 停止
pm2 stop @wechat-push 
# 重启
pm2 restart @wechat-push 
# 删除服务
pm2 delete @wechat-push 

# 查看运行日志
pm2 log @wechat-push
# 清空日志
pm2 flush

Ⅶ. 本地服务器版如何更新?

  1. 在github上先 fork syncing

图片无法查看请移步顶部访问 国内备用仓库地址

  1. 执行以下代码
cd ~./wechat-public-account-push && git pull origin master
  1. 查看配置是否被覆盖,被覆盖则重新填写好配置;

  2. 重启服务

pm2 restart @wechat-push 

  • Windows 系统

👇👇👇👇点击展开

Ⅰ. 安装运行环境

  • 如果本地已安装 Nodejsgit 环境, 请跳过这一步

下载Nodejs16.x安装包

下载git安装包

安装说明:无它,一路next

Ⅱ. 下载项目

在你的电脑里随便一个盘选择任意一个文件夹(最好自己创建,自己要知道在哪里)

进入到文件夹后,右键当前文件夹的空白处 --> 【Git Base Here】

(win11 则点开【显示更多选项】即可看到 【Git Base Here】)

图片无法查看请移步顶部访问 国内备用仓库地址

执行以下命令

git clone https://github.com/wangxinleo/wechat-public-account-push.git

cd ./wechat-public-account-push

# 二选一:**内地执行这一步,速度更快
npm install -g cnpm --registry=https://registry.npm.taobao.org && cnpm install && cnpm install pm2 -g

# 二选一:国外服务器执行这一步
npm install && npm install pm2 -g

当黑窗口回到光标闪烁状态时即完成。

图片无法查看请移步顶部访问 国内备用仓库地址

Ⅲ. 填写发送配置

如果上一步执行成功了,你当前文件夹里面肯定会出现 wechat-public-account-push 文件夹

图片无法查看请移步顶部访问 国内备用仓库地址

wechat-public-account-push/config/index.js 中修改配置。

图片无法查看请移步顶部访问 国内备用仓库地址

如果显示无法打开,选中该文件 --> 右键 --> 打开方式 --> 记事本

图片无法查看请移步顶部访问 国内备用仓库地址

按照提示修改配置

Ⅳ. 填写发送配置wechat-public-account-push/config/server-config.js 中修改配置。

图片无法查看请移步顶部访问 国内备用仓库地址

此时间为每天的早上8点,*为匹配任意一个

这里的时间是**时间 秒 分 时 日 月 年

0 0 8 * * *

Ⅴ. 运行

wechat-public-account-push 文件夹中,右键 --> 【Git Base Here】

图片无法查看请移步顶部访问 国内备用仓库地址

执行以下命令

npm run pm2start

运行完成效果图

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

Ⅵ. 如何停止/重启/删除服务?如何查看运行日志/清空日志?

# 停止
pm2 stop @wechat-push 
# 重启
pm2 restart @wechat-push 
# 删除服务
pm2 delete @wechat-push 

# 查看运行日志
pm2 log @wechat-push
# 清空日志
pm2 flush

Ⅶ. 本地服务器版如何更新?

  1. 在github上先 fork syncing

图片无法查看请移步顶部访问 国内备用仓库地址

  1. 执行以下代码
cd ~./wechat-public-account-push && git pull origin master
  1. 查看配置是否被覆盖,被覆盖则重新填写好配置;

  2. 重启服务

pm2 restart @wechat-push 

2. 公众号模板参数说明

这里的参数是指能够被微信测试号模板接收的参数集合。启动后会根据我们的配置信息,组成相应的参数,如:

{
    one_talk: { value: '没有绝对的废物,只有放错位置的资源。', color: '#1e90fa' },
    talk_from: { value: '上海市垃圾分类', color: '#5c23ca' },
    earthy_love_words: { value: '看着你,我喝白开水都会醉。', color: '#daae5e' },
    love_day: { value: 2682, color: '#f0b4ee' },
    marry_day: { value: 973, color: '#fcde54' },
    ex_day: { value: 3, color: '#703316' },
    encourage_oneself: { value: '你主要的问题在于读书太少而想得太多', color: '#4b84d2' },
    lover_prattle: { value: '因为太喜欢你,所以看谁都像是情敌。', color: '#6f6041' }
}

程序启动后,会生成以上json格式的参数集合。

所以微信测试号模板的那些 {{xxx.DATA}} 从哪儿来,就是从这里来的!!!!

所以微信测试号模板的那些 {{xxx.DATA}} 从哪儿来,就是从这里来的!!!!

所以微信测试号模板的那些 {{xxx.DATA}} 从哪儿来,就是从这里来的!!!!

划分的依据主要是根据功能需求和个人配置,通过获取到这些参数由测试号进行组装推送模板。

目前可被推送模板获取的字段如下:

* 为新增的可配置参数

删除线 为已废除的参数

基础类

参数 详细 示例
* to_name.DATA 收件人姓名 老婆3
date.DATA YYYY-MM-DD 星期d 2022-08-26 星期五
* province.DATA 省份  广东
city.DATA 城市  惠州

天气类

参数 详细 示例
weather.DATA 天气 阵雨转多云
min_temperature.DATA 最低气温 25℃
max_temperature.DATA 最高气温 25℃
* wind_direction.DATA 风向 持续东南风
* wind_scale.DATA 风级 <3级

节假日

参数 详细 示例
holidaytts.DATA 下一休息日综合提醒 还有3天就周六了,好好工作吧!距离国庆还有18天,早着呢

每日N句

参数 详细 示例
note_en.DATA 金山每日一句-英文 Nothing in this world that's worth having comes easy.
note_ch.DATA 金山每日一句-中文 这世界上凡是值得拥有的东西,都不易获得。
* one_talk.DATA 每日一言-内容 愿你遍布祖国山河,觉得人生也值得
* talk_from.DATA 每日一言-来源 晓良
* earthy_love_words.DATA 土味情话(彩虹屁) 我今晚会很忙,忙着跟你过日子
* moment_copyrighting.DATA 朋友圈文案 错过太阳就不要再错过月亮了
* poison_chicken_soup.DATA 毒鸡汤 我从不以强凌弱,我欺负他之前,真不晓得他比我弱。
* poetry_content.DATA 古诗古文-内容 举头望明月,低头思故乡。
* poetry_title.DATA 古诗古文-标题 静夜思
* poetry_author.DATA 古诗古文-作者 李白
* poetry_dynasty.DATA 古诗古文-朝代 唐代

星座运势

参数 详细 示例
comprehensive_horoscope.DATA 综合运势 太多了,不示例了,自己调用查看效果
love_horoscope.DATA 爱情运势 太多了,不示例了,自己调用查看效果
career_horoscope.DATA 事业学业 太多了,不示例了,自己调用查看效果
wealth_horoscope.DATA 财富运势 太多了,不示例了,自己调用查看效果
healthy_horoscope.DATA 健康运势 太多了,不示例了,自己调用查看效果

计时类

参数 详细 示例
love_day.DATA 已预置, 但是可以删掉, 在配置中自定义, 见下文 2674
marry_day.DATA 已预置, 但是可以删掉, 在配置中自定义, 见下文 965
birthday_message.DATA 生日消息和节日消息 距离 宝贝 的生日还有122天,距离 中秋节还有30天

自定义计时及自定义文本插槽

现在你可以自己加入更多需要铭记的日子,来丰富你的推送模板了!

比如:

光荣的退伍军人,您好!
今天是您退伍的第{{ex_day.DATA}}天

您守护的不只是山河社稷,更是每个年轻人的未来!

这个 ex_day.DATA 在上面的出参表并没有定义啊,怎么设置它呢?

现在在配置文件中就可以进行设置了!

图片无法查看请移步顶部访问 国内备用仓库地址

但是有以下情况需要注意,不要占用表中已有的关键字,会发生不可预料的状况噢!

图片无法查看请移步顶部访问 国内备用仓库地址

推送回执(特有, 仅在其他模板发送完成后才能获取)

参数 详细 示例
* post_time_zone.DATA 服务器时区 Asia/Shanghai
* post_time.DATA 服务器执行脚本时间 2022-08-31 19:41:57
* need_post_num.DATA 共需推送N人 4
* success_post_num.DATA 成功推送N人 1
* fail_post_num.DATA 推送失败N人 3
* success_post_ids.DATA 推送成功的用户 老婆0
* fail_post_ids.DATA 推送失败的用户 老婆1,老婆2,老婆3

3. config参数说明

关于config文件的一些参数说明

👇👇👇👇点击展开

{
  /**
   * 公众号配置
   */

  // 公众号APP_ID
  // 建议不要填这里,请使用文档中github secret的方法进行保密配置,保护您的隐私安全。
  // 如果你非要填这里也行。脚本也能运行
  APP_ID: "wxab1981180f309e81",

  // 公众号APP_SECRET
  // 建议不要填这里,请使用文档中github secret的方法进行保密配置,保护您的隐私安全。
  // 如果你非要填这里也行。脚本也能运行
  APP_SECRET: "2d51ac5a89274c7ecd891575cfe5e54f",

  // 是否给文字设置多彩颜色, 和emoji不兼容
  // 如果您使用了微信测试号的模板中含有emoji表情,请填 false
  IS_SHOW_COLOR: true,

  // 功能开关,打开:true,关闭:false
  SWITCH: {
    /** 每日天气 */
    weather: true,

    /** 节假日 */
    // 下一休息日综合提醒
    holidaytts: true,

    /** 每日N句 */
    // 金山每日一句
    CIBA: true,
    // 每日一言
    oneTalk: true,
    // 土味情话(彩虹屁)
    earthyLoveWords: false,
    // 朋友圈文案
    momentCopyrighting: false,
    // 毒鸡汤
    poisonChickenSoup: false,
    // 古诗古文
    poetry: false,

    /** 星座运势 */
    horoscope: false,

    /** 生日消息和节日消息 */
    birthdayMessage: true,
  },
  

  /**
   * 接收公众号消息的微信号,如果有多个,需要在[]里用英文逗号间隔
   */
  USERS: [
    {
      // 想要发送的人的名字
      name: "老婆0",
      // 扫码关注你的微信测试号后生成的一段字符串,在测试号后台能看到
      id: "ohxOO6VskYv0Kuf-ywIZVRMpuX1k",
      // 你想对他发送的模板消息的模板ID
      useTemplateId: "Wue80GrtY1nAia4tam-FDxZF9WNx9pwcBc0LMpAN1u8",
      // 所在省份
      province: "广东",
      // 所在城市
      city: "肇庆",
      // 新历生日, 仅用作获取星座运势, 格式必须
      horoscopeDate: '12-27',
      // 获取什么时候的星座运势,可选:['今日', '明日', '本周', '本月', '今年'], 留空则随机
      horoscopeDateType: '今日',
      // 他点击详情后跳转的页面,你可以设置成微博的热榜,也可以设置成其他,网址一定要填对;不填对也没关系,随便你,会打不开而已。
      openUrl: "https://wangxinleo.cn",
      // 专属节日提醒,如果你在这里填写了节日提醒,就不会执行FESTIVALS的提醒了, 和FESTIVALS的配置方法相同,可以往下查看,我这里就不重复写了
      festivals: [
        // 注意:此条配置日期为阴历日期,因为`type`中 “生日” 之前有 * 符号
        {"type": "*生日", "name": "老婆", "year": "1996", "date": "09-09"},
        {"type": "节日", "name": "结婚纪念日", "year": "2020", "date": "09-03"},
        // 注意:此条配置日期为阳历日期,因为`type`中 “生日” 之前没有 * 符号
        {"type": "生日", "name": "李四", "year": "1996", "date": "09-31"},
        {"type": "节日", "name": "被搭讪纪念日", "year": "2021", "date": "09-01"},
      ],
      // 专属纪念日/倒数日,如果你在这里填写了纪念日/倒数日,就不会计算CUSTOMIZED_DATE_LIST的日子了, 和CUSTOMIZED_DATE_LIST的配置方法相同,可以往下查看,我这里就不重复写了
      customizedDateList: [
        // 在一起的日子
        {"keyword": "love_day", date: "2022-09-08"},
        // 结婚纪念日
        {"keyword": "marry_day", date: "2022-09-09"},
        // 退伍日
        {"keyword": "ex_day", date: "2022-09-10"},
      ]
    },
    {
      name: "老婆1",
      id: "",
      useTemplateId: "",
      province: "",
      city: "",
      horoscopeDate: '',
      horoscopeDateType: '',
      openUrl: "https://wangxinleo.cn",
      festivals: [],
      customizedDateList: []
    },
    // 你可以不断按格式往下增加
    // ...
  ],

  /**
   * 【推送完成提醒】 相关,主要用来展示发送是否成功/失败的数据
   */

  // 【推送完成提醒】模板id, 用来看自己有没有发送成功的那个模板
  CALLBACK_TEMPLATE_ID: "zjVglIuCXo4CsraXWEio1iP7sZJ7IQEES9lDsg14yOU",

  // 接收成功回调消息的微信号,(一般来说只填自己的微信号, name填不填无所谓)
  CALLBACK_USERS: [
    {
      // 一般都填自己
      name: "自己",
      // 自己的微信id,扫码关注你的微信测试号后生成的一段字符串,在测试号后台能看到
      id: "ohxOO6VskYv0Kuf-ywIZVRMpuX1k",
    },
    // 你可以不断按格式往下增加
    // ...
  ],

  /**
   * 信息配置
   */

  /** 天气相关 */

  // 默认所在省份, USERS 中没填的话, 会默认拿这里的省份
  PROVINCE: "广东",
  // 默认所在城市, USERS 中没填的话, 会默认拿这里的城市
  CITY: "惠州",

  /** 重要节日相关 */

  /**
   * 重要节日,修改名字为对应需要显示的名字, date 仅填月日即可, 请严格按照示例填写
   * type必须填! 只能 “生日” 和 “节日” 二选一!
   * 
   * --- 阴历配置开始 ---
   * 如果日期使用阴历,请在 “生日” 或 "节日“ 前添加 * 符号
   * --- 阴历配置结束 ---
   * 
   * 生日时,name填写想要展示的名字,你可以填“美丽可爱亲亲老婆”
   * 节日时,name填写相应展示的节日,你可以填“被搭讪纪念日”
   * 
   * --- 是否展示周岁信息开始 ---
   * isShowAge: true 展示岁数, 仅type为生日生效
   * isShowAge: false 不展示岁数, 仅type为生日生效
   * 删除isShowAge属性,也会不展示岁数
   * --- 是否展示周岁信息结束 ---
   */
  FESTIVALS: [
    // 注意:此条配置日期为阴历日期,因为`type`中 “生日” 之前有 * 符号
    {"type": "*生日", "name": "老婆", "year": "1996", "date": "09-09", isShowAge: true},
    {"type": "节日", "name": "结婚纪念日", "year": "2020", "date": "09-03"},
    // 注意:此条配置日期为阳历日期,因为`type`中 “生日” 之前没有 * 符号
    {"type": "生日", "name": "李四", "year": "1996", "date": "09-31", isShowAge: true},
    {"type": "节日", "name": "被搭讪纪念日", "year": "2021", "date": "09-01"},
    // 你可以不断按格式往下增加
    // ...
  ],

  /**
   * 限制重要节日的展示条目, 需要填写数字;
   * 如果为3, 则仅展示“将要到达” 的3个重要节日提醒,剩下的将被忽略
   * 如果为0, 则默认展示全部
   */
  FESTIVALS_LIMIT: 4,

  /** 日期相关 */

  /** 你现在可以随心增加你认为的所有的需要纪念的日子啦!
    * keyword是指暴露给测试号的模板字段,填什么就暴露什么, 请注意不要和README的出参表中的字段重复。
    * 比如:keyword: "love_date" ,在测试号中就是 {{ love_date.DATA }}
    * */
  CUSTOMIZED_DATE_LIST: [
    // 在一起的日子
    {"keyword": "love_day", date: "2022-09-08"},
    // 结婚纪念日
    {"keyword": "marry_day", date: "2022-09-09"},
    // 退伍日
    {"keyword": "ex_day", date: "2022-09-10"},
    // 你可以不断按格式往下增加
    // ...
  ],

  /** 插槽 */

  /** 你可以在这里写超多的你想显示的内容了!
    * keyword是指暴露给测试号的模板字段,填什么就暴露什么, 请注意不要和README的出参表中的字段重复。
    * 比如:keyword: "lover_prattle" ,在测试号中就是 {{ lover_prattle.DATA }}
    * */
  SLOT_LIST: [
    // 这样配置的话,就会每次发送这句话
    {"keyword": "encourage_oneself", contents: "你主要的问题在于读书太少而想得太多"},
    // 这样配置的话,就会每次随机选一句话发送
    {"keyword": "lover_prattle", contents: [
      "因为太喜欢你,所以看谁都像是情敌。",
      "申请成为你爱里的永久居民。",
      "你很傻,你很笨,可我还是很羡慕你,因为你有我",
      "遇见你,就好像捡到了100斤的运气",
    ]},
    // 你可以不断按格式往下增加
    // ...
  ],

  /** 每日一言 */

  // 好文节选的内容类型
  // 可以填写【动画,漫画,游戏,小说,原创,网络,其他】; 随机则填写 ""
  LITERARY_PREFERENCE: ""


}

4. 模板样例

亲爱的, 早上好

{{date.DATA}}  
城市:{{city.DATA}}  
天气:{{weather.DATA}}  
最低气温: {{min_temperature.DATA}}  
最高气温: {{max_temperature.DATA}}  
今天是我们恋爱的第{{love_day.DATA}}天
今天是我们结婚的第{{marry_day.DATA}}天

{{birthday_message.DATA}}

{{one_talk.DATA}} -- {{talk_from.DATA}}

{{note_en.DATA}}  
{{note_ch.DATA}}

推送完成提醒

服务器信息:{{post_time_zone.DATA}} {{post_time.DATA}}

共推送 {{need_post_num.DATA}}  人
成功: {{success_post_num.DATA}} | 失败: {{fail_post_num.DATA}}
成功用户: {{success_post_ids.DATA}}
失败用户: {{fail_post_ids.DATA}}

5. GitHub/Gitee 如何更改自动执行时间

5.1 github action如何更改自动执行时间

这里的脚本使用的是 github 的 workflow 定时任务, 具体脚本文件放置在:

wechat-public-account-push/.github/workflows/weixin-push-on-time.yml

这里简单说明一下如何更改自动执行时间

目前脚本默认执行时间为 每天的 北京时间上午 10:10

如果想要变更脚本定时任务执行时间,可以更改以下代码段

on:
  workflow_dispatch:
  schedule:
    # 每天国际时间2:10 运行, 即北京时间 10:10 运行
    - cron: '10 2 * * *'

推荐设置: 10 2 * * *10 22 * * * 等冷门时间,拥堵率低

定时任务注意尽量避免设置在 utc 0:00, XX:00 这类高拥堵时段。

定时任务注意尽量避免设置在 utc 0:00, XX:00 这类高拥堵时段。

定时任务注意尽量避免设置在 utc 0:00, XX:00 这类高拥堵时段。

图片无法查看请移步顶部访问 国内备用仓库地址

5.2 gitee go如何更改自动执行时间

图片无法查看请移步顶部访问 国内备用仓库地址

图片无法查看请移步顶部访问 国内备用仓库地址

6. 常见问题

关于获取accessToken:请求失败invalid appsecret rid xxxxx

关于推送失败,报40001- 4000X

关于目前仅支持测试号的问题

关于定时任务好像没有自动执行(?)

Issues(议题)板块可以用来提交Bug建议

Discussions(讨论)板块可以用来提问讨论

所以如果你有疑问,

  • 请先确认是否可以通过升级到最新版本解决
  • 然后搜索文档(特别是配置说明文档和常见问题文档)查看是否已有解决方案

如果确认还未解决,可以自己提交 Issue,我会尽快确认并解决。

7. 版本发布及更新

关于新版本发布后,如何同步最新的内容到自己 Fork 的仓库

7.1 重新fork

删掉后重新Fork会导致之前配置过的GitHub Secrets和提交的代码更改全部丢掉,只能重新部署。

7.2 pull request(这个方法太多人不会用了, 删除)

7.3 GitHub Fetch Upstream Branch

  • 在自己的项目仓库中选择 "Sync fork"

  • 点击 "Update branch" 完成

图片无法查看请移步顶部访问 国内备用仓库地址

可能会遇到 因为冲突需要你们删除你们已经更改的记录

如果只是纯粹更改配置,放心大胆的点删除, 然后更新最新代码仓库就好了。

如果你更改了源代码进行了部分定制, 请注意备份代码段。

7.4 actions 脚本自动

以后会考虑加入actions 脚本每周自动更新fork仓库,但是目前精力不足,只能采用上述保守方案

建议每个人先看看更新的内容是否是自己需要的再进行更新。

也建议把右上角的 Star 点一下,这样有重要更新时就会有邮件推送了。

8. 成为开源贡献成员

8.1 贡献代码

如果你有好的想法,欢迎向仓库贡献你的代码,贡献步骤:

  • 搜索查看 Issue,确定是否已有人提过同类问题或者有新的想法

  • 确认没有同类 Issue 后,自己可新建 Issue,描述问题或建议

  • 如果想自己解决,请 Fork 仓库后,在develop 分支进行编码开发,完成后提交 PR 到 develop 分支,并标注解决的 Issue 编号

我会尽快进行代码审核,测试成功后会合并入 main 主分支,提前感谢您的贡献。

8.2 贡献文档

文档部分由于我个人精力有限(写文档比写代码累多了),所以有些地方写的很简略,甚至有遗漏和错别字,不能贡献代码的朋友也欢迎来一起维护文档,欢迎 PR 来纠正我,一样都算是对开源做贡献了。

9. 致谢

贡献/参与者

@LordonCN Lordon

@ZzqiZQute zz

@shuangxunian ShuangxuNian

感谢那些默默支持我, 鼓励我继续更新这个小玩具的朋友。

感谢所有参与到开发/测试中的朋友们,是大家的帮助让 TA 越来越好! (*´▽`)ノノ

10. wechat-public-account-push答疑群

不管文档写得多详细,还是会有人不会呐!还是建个群答疑吧!

群我隐藏在文档里了哼哼,不仔细看文档可找不到加群的地方哦!

2022-09-10 算啦还是不隐藏了,你们来尽情问吧。

图片无法查看请移步顶部访问 国内备用仓库地址

wechat-public-account-push 交流群

11. 其他

时区查询: https://www.zeitverschiebung.net/cn/all-time-zones.html

About

微信公众号推送-给女朋友的浪漫

License:MIT License


Languages

Language:JavaScript 100.0%