Octopush


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

URL formats

{schema}://{api_login}/{api_key}/{targets}
{schema}://{sender}:{api_login}/{api_key}/{targets}

{schema} is one of octopush://.

URL tokens

Token	Meaning	Type	Required	Notes
`{api_key}`	API Key	string	yes	secret
`{api_login}`	API Login	email	yes	secret
`{sender}`	Sender	string	no
`{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
`batch`	Batch Mode	bool	`no`
`key`	API Key	string		sets `{api_key}`
`login`	API Login	email		sets `{api_login}`
`purpose`	Purpose	choice	`alert`	one of `alert`, `wholesale`
`replies`	Accept Replies	bool	`no`
`to`	Targets	list		sets `{targets}`
`type`	Type	choice	`sms_premium`	one of `sms_premium`, `sms_low_cost`

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

octopush://user@myaccount.com/apikey/+0987654321
octopush://user@myaccount.com/apikey/1111111111/33333333333
octopush://sender:user@myaccount.com/apikey/1111111111/222/33333333333/?batch=yes
octopush://user@myaccount.com/apikey/+3333333333?replies=yes
octopush://?login=user@myaccount.com&key=key&to=9999999999&type=premium
octopush://_?key=abc123&login=user@myaccount.com&sender=abc&to=2222222222
octopush://?login=user@myaccount.com&key=key&to=9999999999&purpose=WholeSale

Rejected URLs:

octopush://
octopush://:@/
octopush://user@myaccount.com
octopush://_/apikey?login=invalid

Send one from the command line:

mercurio -t 'Backup' -b 'Finished in 42s' 'octopush://user@myaccount.com/apikey/+0987654321'

Notes

Octopush SMS (octopush://): SMS through the Octopush API.