From 9c7fa088e1120d78b82fc016cdc09318a7639249 Mon Sep 17 00:00:00 2001 From: Chris Caron Date: Sat, 1 Jul 2023 16:46:34 -0400 Subject: [PATCH] Created Notify_burst_sms (markdown) --- Notify_burst_sms.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 Notify_burst_sms.md diff --git a/Notify_burst_sms.md b/Notify_burst_sms.md new file mode 100644 index 0000000..5658cca --- /dev/null +++ b/Notify_burst_sms.md @@ -0,0 +1,36 @@ +* **Source**: https://burstsms.com/ +* **Icon Support**: No +* **Attachment Support**: No +* **Message Format**: Text +* **Message Limit**: 160 Characters per message + +You need to have an account with [Burst SMS](https://burstsms.com/). Visit your profile options and create a `Secret` to associate with your account. You'll notice that there is already an `API Key` present. These will be used for your credentials. + +Burst SMS will set you up with a Sender ID that you're notifications will originate from. This must be provided as part of the Apprise URL as well. + +### Syntax +The syntax is as follows +* `burstsms://{api_key}:{secret}@{sender_id}/{targets}` + +### Parameter Breakdown +| Variable | Required | Description +| ----------- | -------- | ----------- +| api_key | Yes | This is the **API Key** associated with your Bulk SMS Account +| secret | Yes | This is the **Client Secret** associated with your Bulk SMS Account +| sender_id | Yes | This is the **Phone Number** associated with your Bulk SMS Account. +| targets | Yes | Optionally identify the phone numbers you wish to send your **SMS** Message to. | +| country | No | Optionally specify the `countrycode` which is either `en`, `gb`, `au` or `nz`. By default this is set to `us` +| validity | No | Optionally define how long an unsent SMS message is valid for (and will be attempted to be resent). By default this is set to zero (0) for the maximum amount of validity. This value is defined in minutes. +| batch | No | Optionally send notifications in a batch (vs individually). By default this is set to `No`. + +#### Example +Send a Burst SMS Notification: +```bash +# Assuming our {APIKey} is bc1451bd +# Assuming our {APISecret} is gank339l7jk3cjaE +# Assuming our {FromPhoneNo} is +1-900-555-9999 +# Assuming our {PhoneNo} - is in the US somewhere making our country code +1 +# - identifies as 800-555-1223 +apprise -vv -t "Test Message Title" -b "Test Message Body" \ + nexmo://bc1451bd:gank339l7jk3cjaE@19005559999/18005551223 +``` \ No newline at end of file