BulkSMS Notifications
Ce contenu n’est pas encore disponible dans votre langue.
Account Setup
Section titled “Account Setup”Sign up for BulkSMS account from here. You will be provided to create a user and password to associate with your account. This is all you need to use this through Apprise.
Syntax
Section titled “Syntax”Valid syntax is as follows:
bulksms://{user}:{password}@{target}
A target can be either a phone number, or if prefixed with @ it becomes a group.
bulksms://{user}:{password}@{phoneNo}bulksms://{user}:{password}@{phoneNo1}/{phoneNo2}/{phoneNoN}bulksms://{user}:{password}@{group}bulksms://{user}:{password}@{group1}/@{group2}/@{groupN}
You can mix and match as well
bulksms://{user}:{password}@{to_phone1}/@{group1}
For ambiguity, if you do not provide a valid phone number, and the information parsed does not exclusively have a@ in front of it, then it is first interpreted as phone number. However if alphanumeric characters are detected in it, then it is switched to a group.
Parameter Breakdown
Section titled “Parameter Breakdown”| Variable | Required | Description |
|---|---|---|
| user | Yes | The username associated with your BulkSMS Account. |
| password | Yes | The password associated with your BulkSMS Account. |
| to | *No | A phone number and/or group you wish to send your notification to. You can use comma’s to separate multiple entries if you wish. This is an alias to targets. |
| from | *No | Specify the phone number you registered with BulkSMS you wish the message to be identified as being sent from. |
| batch | No | Send multiple specified notifications in a single batch (1 upstream post to the end server). By default this is set to no. |
| route | No | Can be set to either ECONOMY, STANDARD, or PREMIUM (not case sensitive). If not otherwise provided, this assumes to be STANDARD by default. |
| unicode | No | Optionally tell Apprise to not mark your text message as having unicode characters in it. The message mode changes to TEXT if this is set to No |
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 BulkSMS Message:
# Assuming our {user} is joe# Assuming our {password} is hard-to-guess# Assuming the {PhoneNo} we wish to notify is +134-555-1223apprise -vv -t "Test Message Title" -b "Test Message Body" \ bulksms://joe:hard-to-guess@+134-555-1223