github
/
apprise
mirror of https://github.com/caronc/apprise
1
0
Fork 0
Code Issues Releases Wiki Activity

Updated Notify_msg91 (markdown)

master
Chris Caron 2023-10-06 16:35:01 -04:00
parent 9c65b823b3
commit ae161efb17
1 changed files with 41 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
Notify_msg91.md

@ -5,34 +5,62 @@
* **Message Limit**: 160 Characters per message * **Message Limit**: 160 Characters per message
### Account Setup ### Account Setup
To use MSG91, you will need to acquire your _Authentication Key_. This is accessible via the [MSG91 Dashboard](https://world.msg91.com/user/index.php#api). To use MSG91, you will need to acquire your _Authentication Key_. This is accessible via the [MSG91 Dashboard](https://control.msg91.com). In addition to this, you will need to prepare a template and assign a `body`, `title`, and `type` variable to it so that Apprise can relay it's information through here.
### Syntax ### Syntax
Valid syntaxes are as follows: Valid syntax is as follows:
* **msg91**://**{AuthKey}**/**{PhoneNo}** * `msg91://{TemplateID}@{AuthKey}/{PhoneNo}`
* **msg91**://**{AuthKey}**/**{PhoneNo1}**/**{PhoneNo2}**/**{PhoneNoN}** * `msg91://{TemplateID}@{AuthKey}/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}`
* **msg91**://**{SenderID}**@**{AuthKey}**/**{PhoneNo}**
* **msg91**://**{SenderID}**@**{AuthKey}**/**{PhoneNo1}**/**{PhoneNo2}**/**{PhoneNoN}**
### Parameter Breakdown ### Parameter Breakdown
| Variable | Required | Description | Variable | Required | Description
| --------------- | -------- | ----------- | --------------- | -------- | -----------
| AuthKey | Yes | The _Authentication Key_ associated with your MSG91 account. This is available to you via the [MSG91 Dashboard](https://world.msg91.com/user/index.php#api). | AuthKey | Yes | The _Authentication Key_ associated with your MSG91 account. This is available to you via the [MSG91 Dashboard](https://control.msg91.com/).
| PhoneNo | Yes | A 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 | TemplateID | Yes | The _Template ID_ associated with your MSG91 account. This is available to you via the [MSG91 Dashboard](https://control.msg91.com/).
| Route | No | The SMS Route. This is an SMG91 configuration that defaults to **1** (Transactional) if not otherwise specified. | PhoneNo | Yes | A phone number MUST include the country codes dialing 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
| Country | No | The SMS Country. This is an SMG91 optional configuration that can either be **91** if referencing India, **1** if the USA and **0** if International. | short_url | No | A boolean (defaults) to `No` whether the SMS messages should use the Short URL notation.
#### Example
### Template Variables
The templates you generate allow you to specify your own key mappings. B
The following keys are automatically passed from Apprise to the MSG91 Template system should you chose to use them or not.
- `##body##`: The Apprise Message Body (Title is prefixed into this if defined)
- `##type##`: The Apprise Message Type (e.g. `warning`, `info`, `failure`, or `success`)
If you wish to assign new types to `body` or `type` from Apprise, these special keywords are specified instead with the `:` (colon) prefix providing the mapping/over-ride. For example: `?:body=msg` would remap the default message body from apprise to the `msg` keyword instead.
If you wish to remove the `type` from being passed, you simply define it in the URL but do not assign it to anything such as: `?:type`.
Finally if you wish to define your own arguments, just define them as such `?:key=value` would assign a `key` the contents of `value` when being passed into your template.
### Example
Send a MSG91 Notification as an SMS: Send a MSG91 Notification as an SMS:
```bash ```bash
# Assuming our {TemplateID} is 12345
# Assuming our {AuthKey} is gank339l7jk3cjaE # Assuming our {AuthKey} is gank339l7jk3cjaE
# Assuming our {PhoneNo} - is in the US somewhere making our country code +1 # Assuming our {PhoneNo} - is in the US somewhere making our country code +1
# - identifies as 800-555-1223 # - identifies as 800-555-1223
apprise -vv -t "Test Message Title" -b "Test Message Body" \ apprise -vv -t "Test Message Title" -b "Test Message Body" \
msg91://gank339l7jk3cjaE/18005551223 msg91://12345@gank339l7jk3cjaE/18005551223
# the following would also have worked (spaces, brackets, # the following would also have worked (spaces, brackets,
# dashes are accepted in a phone no field): # dashes are accepted in a phone no field):
apprise -vv -t "Test Message Title" -b "Test Message Body" \ apprise -vv -t "Test Message Title" -b "Test Message Body" \
"msg91://gank339l7jk3cjaE/1-(800) 555-1223" "msg91://12345@gank339l7jk3cjaE/1-(800) 555-1223"
```
Here is a templating example:
Send a MSG91 Notification as an SMS:
```bash
# Assuming our {TemplateID} is 12345
# Assuming our {AuthKey} is gank339l7jk3cjaE
# Assuming our {PhoneNo} - is in the US somewhere making our country code +1
# Assuming we want to map our `body` tag (sent from Apprise to `payload` instead
# Assuming we want to make sure Apprise does not pass along the `type`
# Assuming we want to define our Foobar Inc company name as the template token `company`:
# - identifies as 800-555-1223
apprise -vv -t "Test Message Title" -b "Test Message Body" \
msg91://12345@gank339l7jk3cjaE/18005551223?:body=payload&:type&company=Foobar%20Inc
``` ```