说明
OpenAPI是@Peng-YM编写的跨平台脚本API,同时支持Quantumult X, Loon, Surge, JSBox 和Node.js。最近笔者将其与@lxk0301的多平台通知进行增删改查整合,并提供9种通知。本文为修改后的OpenAPI在Node.js环境中应用的补充说明。
开始使用
将api-minified.js内容复制到js脚本下方
const $ = API("weather"); // 创建一个名字为weather的脚本。默认为product环境,抑制所有log输出,保持error信息。
const $ = API("weather", true); // 打开debug环境,打开所有log输出
设置通知参数
可以在脚本内直接赋值,或使用文末的export
方式声明
// 作者信息(缺省值为笔者信息)
$.author = "";
// 微信server酱
$.SCKEY = "";
// pushplus(推送加)
$.PUSH_PLUS_TOKEN = "";
$.PUSH_PLUS_USER = "";
// iOS Bark APP
$.BARK_PUSH = "";
$.BARK_SOUND = "";
$.BARK_GROUP = "";
// Telegram 机器人
$.TG_BOT_TOKEN = "";
$.TG_USER_ID = "";
$.TG_PROXY_HOST = "";
$.TG_PROXY_PORT = "";
$.TG_PROXY_AUTH = "";
$.TG_API_HOST = "";
// 钉钉机器人
$.DD_BOT_TOKEN = "";
$.DD_BOT_SECRET = "";
// 企业微信机器人
$.QYWX_KEY = "";
// 企业微信应用消息推送
$.QYWX_AM = "";
// iGot
$.IGOT_PUSH_KEY = "";
// go-cqhttp
$.GOBOT_URL = "";
$.GOBOT_TOKEN = "";
$.GOBOT_QQ = "";
推送通知
$.timeout = "15000"; //通知超时时间(单位毫秒),缺省值即为15000
$.notify("title", "subtitle", "content");
// 通知开关
$.isMute = ""; // 抑制通知发送(True or False, 缺省值为False)
$.isMuteLog = ""; // 抑制通知输出(True or False, 缺省值为False)
环境变量说明
通知开关
export isMute = '' # 抑制通知发送(True or False, 缺省值为False)
export isMuteLog = '' # 抑制通知输出(True or False, 缺省值为False)
微信server酱
官方网站:https://sct.ftqq.com/
下方填写SCKEY
值或SendKey
值
export SCKEY = ''
pushplus(推送加)
官方网站:http://www.pushplus.plus/
PUSH_PLUS_TOKEN:微信扫码登录后一对一推送或一对多推送下面的token(您的Token),默认为一对一推送
PUSH_PLUS_USER: 一对多推送的“群组编码”(一对多推送下面->您的群组(如无则新建)->群组编码,如果您是创建群组人。也需点击“查看二维码”扫描绑定,否则不能接受群组消息推送)
export PUSH_PLUS_TOKEN = ''
export PUSH_PLUS_USER = ''
iOS Bark APP
下方填你Bark APP的信息(IP/设备码,例如:https://api.day.app/XXXXXXXX
)。
自建api服务端官方文档
# 兼容自建api用户,仅填写设备码则默认使用官方api
export BARK_PUSH = ''
# Bark app推送铃声,铃声列表去APP查看复制填写
export BARK_SOUND = ''
# Bark app消息分组,默认AsVow
export BARK_GROUP = ''
Telegram 机器人
下方填写自己申请@BotFather的Token,例如:10xxx4:AAFcqxxxxgER5uw
export TG_BOT_TOKEN = ''
下方填写 @getuseridbot 中获取到的纯数字ID
export TG_USER_ID = ''
tg推送HTTP代理设置(选填)
export TG_PROXY_HOST = '' # 例如:127.0.0.1
export TG_PROXY_PORT = '' # 例如:1080
export TG_PROXY_AUTH = '' # tg代理配置认证参数
Telegram api自建的反向代理地址(选填),默认使用官方api api.telegram.org
搭建教程
export TG_API_HOST = ''
钉钉机器人
官方文档
下方填写token后面的内容,只需 https://oapi.dingtalk.com/robot/send?access_token=XXX
后面的XXX
即可
export DD_BOT_TOKEN = ''
# 密钥,机器人安全设置页面,加签一栏下面显示的SEC开头的字符串
export DD_BOT_SECRET = ''
企业微信机器人
官方文档
下方填写密钥,企业微信推送 webhook 后面的 key
export QYWX_KEY = ''
企业微信应用消息推送
官方文档
下方填依次填入 corpid,corpsecret,touser,agentid,消息类型(选填,不填默认文本消息类型)
注意用,号隔开(英文输入法的逗号)
可选推送消息类型(推荐使用图文消息mpnew):
export QYWX_AM = ''
iGot
官方文档
下方填您iGot的信息(推送key,例如:https://push.hellyw.com/XXXXXXXX
)
export IGOT_PUSH_KEY = ''
go-cqhttp
官方文档
gobot_url 填写请求地址,例如:http://127.0.0.1/send_private_msg
gobot_token 填写在go-cqhttp文件设置的访问密钥
gobot_qq 填写推送到个人QQ或者QQ群号
export GOBOT_URL = '' #推送到个人QQ: http://127.0.0.1/send_private_msg 群:http://127.0.0.1/send_group_msg
export GOBOT_TOKEN = '' # 访问密钥
export GOBOT_QQ = '' # 如果GOBOT_URL设置 /send_private_msg 则需要填入 user_id=个人QQ 相反如果是 /send_group_msg 则需要填入 group_id=QQ群