Notifyre


Schemes	`notifyre://`
Cargo feature	`service-notifyre`
Service	https://notifyre.com/
Body formats	`text` (first is the default)
Attachments	yes
Title length	no title (merged into the body)
Body length	160 characters
Body lines	unlimited
Request throttle	none
Vendor URLs accepted	no

URL formats

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

{schema} is one of notifyre://.

URL tokens

Token	Meaning	Type	Required	Notes
`{apikey}`	API Key	string	yes	secret
`{target_phone}`	Target Phone No	string	no	prefix `+`; must match `^[0-9\s)(+-]+$`
`{targets}`	Targets	list	no	any of `target_phone`; separated by `/`

Query parameters

Parameter	Meaning	Type	Default	Notes
`campaign`	Campaign Name	string
`from`	Source Phone No	string
`header`	Fax Header	string
`hq`	High Quality	bool	`yes`
`mode`	Mode	choice	`sms`	one of `sms`, `fax`
`ref`	Client Reference	string
`template`	Template Name	string
`to`	Targets	list		sets `{targets}`

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):

notifyre://apikey/15551232000
notifyre://apikey/15551232000?mode=S
notifyre://apikey/15551232000/+61 412 345 678/bad?to=15551232001
notifyre://apikey/15551232000?from=15551239999&campaign=%20Camp%20
notifyre://apikey/15551232000?mode=fax&template=Tpl&ref=R1&hq=no&header=Hdr&from=15551239999

Rejected URLs:

notifyre://
notifyre://apikey/15551232000?from=abc
notifyre://apikey/15551232000?mode=email

Send one from the command line:

mercurio -t 'Backup' -b 'Finished in 42s' 'notifyre://apikey/15551232000'

Notes

Notifyre (notifyre://): SMS and fax through the Notifyre API.