Mobile Message Notifications
Account Setup
Section titled “Account Setup”- Sign up for an account at mobilemessage.com.au.
- Sign in and open Settings -> API. Create an API key, then copy its API username and API password.
- Open Settings -> Sender IDs and choose an approved Sender ID. This can be a dedicated number, a verified mobile, or an ACMA-registered name such as
ALERTS.
Syntax
Section titled “Syntax”Valid syntax is as follows:
mobilemessage://{apiUser}:{apiPass}@{senderID}/{toPhoneNo}mobilemessage://{apiUser}:{apiPass}@{senderID}/{toPhoneNo1}/{toPhoneNo2}/{toPhoneNoN}
You can shorten mobilemessage:// to mobilemsg://.
Use local (0412345678) or international (61412345678) phone numbers. Apprise converts them to international form.
Parameter Breakdown
Section titled “Parameter Breakdown”| Variable | Required | Description |
|---|---|---|
| apiUser | *Yes | The API username created under Settings -> API. |
| apiPass | *Yes | The API password that came with your API username. |
| senderID | *Yes | The Sender ID your message is delivered from. It must already be registered on your account. |
| toPhoneNo | *Yes | One or more Australian mobile numbers. Separate them with a / in the URL path. |
| to | No | Alias for the destination numbers. Accepts a comma-separated list and can be combined with numbers already in the URL path. |
| from | No | Alias for senderID. Handy in YAML configuration files where you would rather keep the Sender ID on its own line. |
| batch | No | Group up to 10,000 recipients per request instead of sending one request each. Defaults to yes. |
| unicode | No | Keep emoji and accented characters instead of removing them. This reduces the size of each message part and may use more credits. Defaults to no. |
| max_parts | No | The most message parts a single notification may use, between 1 and 99. Lower it to cap what one alert can cost you. Defaults to 10. |
| ref | No | Your own reference string, attached to each message and echoed back by the service. Useful for matching messages up in your Mobile Message history. |
Global Parameters
Section titled “Global Parameters”| Variable | Description |
|---|---|
| overflow | Controls messages that exceed a service’s documented limit. The default is upstream.👉 upstream: Send one message without splitting or truncating it for that limit.👉 truncate: Keep the portion that fits and discard the rest.👉 split: Prefer a readable break, fall back to a hard boundary, and send every part in order.Splitting undeclared or structured content is best effort. Use upstream when the body must remain one intact document. |
| format | This parameter can be set to either text, html, or markdown. Some services support the ability to post content by several different means. The default of this varies (it can be one of the 3 mentioned at any time depending on which service you choose). You can optionally force this setting to stray from the defaults if you wish. If the service doesn’t support different types of transmission formats, then this field is ignored. |
| verify | External requests made to secure locations (such as through the use of https) will have certificates associated with them. By default, Apprise will verify that these certificates are valid; if they are not then no notification will be sent to the source. In some occasions, a user might not have a certificate authority to verify the key against or they trust the source; in this case you will want to set this flag to no. By default it is set to yes. |
| redirect | By default, Apprise will follow HTTP redirects (3xx responses) issued by the remote server, matching the behaviour of the underlying requests library. If you want to prevent custom headers and credentials from being forwarded to destinations that differ from the original URL, set this to no. By default it is set to yes. |
| cto | This stands for Socket Connect Timeout. This is the number of seconds Requests will wait for your client to establish a connection to a remote machine (corresponding to the connect()) call on the socket. The default value is 4.0 seconds. |
| rto | This stands for Socket Read Timeout. This is the number of seconds the client will wait for the server to send a response. The default value is 4.0 seconds. |
| emojis | Enable Emoji support (such as providing :+1: would translate to 👍). By default this is set to no. Note: Depending on server side settings, the administrator has the power to disable emoji support at a global level; but default this is not the case. |
| tz | Identify the IANA Time Zone Database you wish to operate as. By default this is detected based on the configuration the server hosting Apprise is running on. You can set this to things like America/Toronto, or any other properly formated Timezone describing your area. |
| retry | The number of additional delivery attempts to make after the first failure before giving up. Accepts an integer in the range 0 to 10. The default is 0 (no retries — a single attempt is made). When combined with wait, Apprise pauses the specified number of seconds between each attempt. |
| wait | The number of seconds to pause between retry attempts. Accepts a decimal value in the range 0.0 to 20.0; integer values are promoted to float automatically. The default is 0.5. This value is only meaningful when retry is greater than zero — a service with retry=0 makes exactly one attempt regardless of the wait value. |
| optional | When set to yes, a delivery failure for this service is silently absorbed. The overall notify() call still evaluates as true even if this endpoint was unreachable, provided that every required (non-optional) service in the same batch succeeded. Setting this flag does not skip delivery or bypass retry logic — all configured retry attempts are still made before the failure is absorbed. By default this is set to no, meaning every failure is propagated to the caller. |
Examples
Section titled “Examples”Send an alert to one number:
# Assuming our API username is apiuser01# Assuming our API password is s3cr3tpassw0rd# Assuming our Sender ID is ALERTSapprise -vv -t "Test Message Title" -b "Test Message Body" \ "mobilemessage://apiuser01:s3cr3tpassw0rd@ALERTS/0412345678"Send to several people in one request:
apprise -vv -b "The backup job failed" \ "mobilemessage://apiuser01:s3cr3tpassw0rd@ALERTS/0412345678/0498765432"Send from a dedicated number instead of an alphanumeric name:
apprise -vv -b "Server is down" \ "mobilemsg://apiuser01:s3cr3tpassw0rd@61400000000/0412345678"Limit an alert to one message part to control its cost:
apprise -vv -b "Disk usage above 90%" \ "mobilemessage://apiuser01:s3cr3tpassw0rd@ALERTS/0412345678?max_parts=1"Allow emoji and accented characters, and tag the messages with your own reference:
apprise -vv -b "Backup finished, café server included" \ "mobilemessage://apiuser01:s3cr3tpassw0rd@ALERTS/0412345678?unicode=yes&ref=nightly-backup"Use query parameters to keep values separate in a YAML configuration:
apprise -vv -b "Hello world" \ "mobilemessage://apiuser01:s3cr3tpassw0rd@?from=ALERTS&to=0412345678,0498765432" Questions or Feedback?
Technical Issues
Having trouble with the code? Open an issue on GitHub:
Made with love from Canada