MessageBird Notifications
Account Setup
Section titled “Account Setup”To use MessageBird, you will need to acquire your API Key. This is accessible via the MessageBird Dashboard.
Syntax
Section titled “Syntax”Valid syntax is as follows:
msgbird://{ApiKey}/{FromPhoneNo}msgbird://{ApiKey}/{FromPhoneNo}/{ToPhoneNo}msgbird://{ApiKey}/{FromPhoneNo}/{ToPhoneNo1}/{ToPhoneNo2}/{ToPhoneNoN}
Parameter Breakdown
Section titled “Parameter Breakdown”| Variable | Required | Description |
|---|---|---|
| ApiKey | Yes | The API Key associated with your MessageBird account. This is available to you via the MessageBird Dashboard. |
| FromPhoneNo | Yes | A from phone number MUST include the country codes dialling prefix as well when placed. This field is also very friendly and supports brackets, spaces and hyphens in the event you want to format the number in an easy to read fashion. This MUST be the the number you registered with your MessageBird account. |
| ToPhoneNo | No | A to phone number MUST include the country codes dialling prefix as well when placed. This field is also very friendly and supports brackets, spaces and hyphens in the event you want to format the number in an easy to read fashion. If no ToPhoneNo is specified, then the FromPhoneNo is notified instead. |
Global Parameters
Section titled “Global Parameters”| Variable | Description |
|---|---|
| overflow | This parameter can be set to either split, truncate, or upstream. This determines how Apprise delivers the message you pass it. By default this is set to upstream 👉 upstream: Do nothing at all; pass the message exactly as you received it to the service.👉 truncate: Ensure that the message will fit within the service’s documented upstream message limit. If more information was passed then the defined limit, the overhead information is truncated.👉 split: similar to truncate except if the message doesn’t fit within the service’s documented upstream message limit, it is split into smaller chunks and they are all delivered sequentially there-after. |
| 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. |
| 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. |
Examples
Section titled “Examples”Send a MessageBird Notification as an SMS:
# Assuming our {APIKey} is gank339l7jk3cjaE# Assuming our {FromPhoneNo} - is in the US somewhere making our country code +1# - identifies as 1-123-555-1223apprise -vv -t "Test Message Title" -b "Test Message Body" \ msgbird://gank339l7jk3cjaE/11235551223
# the following would also have worked (spaces, brackets,# dashes are accepted in a phone no field):apprise -vv -t "Test Message Title" -b "Test Message Body" \ msgbird://gank339l7jk3cjaE/1-(123) 555-1223