Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

WPUSH

Schemeswpush://
Cargo featureservice-wpush
Servicehttps://wpush.cn/
Body formatstext (first is the default)
Attachmentsno
Title length255 characters
Body length10,000 characters
Body linesunlimited
Request throttlenone
Vendor URLs acceptedyes

URL formats

{schema}://{apikey}
{schema}://{apikey}/{targets}

{schema} is one of wpush://.

URL tokens

TokenMeaningTypeRequiredDefaultNotes
{apikey}API Keystringyessecret; must match ^WPUSH[a-z0-9]{27}$
{targets}Topicslistnoseparated by /

Query parameters

ParameterMeaningTypeDefaultNotes
apikeyAPI Keystringsets {apikey}
channelChannellistseparated by , or space; one of wechat, app, sms, mail, webhook, dingtalk, feishu, wechat_work, clawbot, qqbot
groupGroup / Option Codestringalso option
toTopicslistsets {targets}
topicTopicslistsets {targets}
topic_codeTopicslistsets {targets}
urlClick URLstring

The common URL parameters (format, overflow, verify, redirect, cto, rto, retry, wait, store, tag, tz, user, password, port, optional, emojis) apply as well.

Examples

Accepted URLs (tokens are fake):

wpush://WPUSHabcdefghijklmnopqrstuvwxyz0
wpush://WPUSHabcdefghijklmnopqrstuvwxyz0/topic2/topic1
wpush://WPUSHabcdefghijklmnopqrstuvwxyz0?channel=FEISHU
wpush://WPUSHabcdefghijklmnopqrstuvwxyz0?option=a&group=b
wpush://WPUSHabcdefghijklmnopqrstuvwxyz0?url=https://example.com/
wpush://WPUSHabcdefghijklmnopqrstuvwxyz0?channel=qqbot&group=123456
wpush://WPUSHabcdefghijklmnopqrstuvwxyz0?channel=qqbot&option=123456
wpush://?apikey=WPUSHabcdefghijklmnopqrstuvwxyz0

Rejected URLs:

wpush://
wpush://short
wpush://WPUSHabcdefghijklmnopqrstuvwxyz0?channel=invalid
wpush://WPUSHabcdefghijklmnopqrstuvwxyz0?group=123456&topic_code=mytopic

Send one from the command line:

mercurio -t 'Backup' -b 'Finished in 42s' 'wpush://WPUSHabcdefghijklmnopqrstuvwxyz0'

Notes

WPUSH (wpush://): push notifications through WPUSH.