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

Updated Notify_nexmo (markdown)

master
Chris Caron 2019-06-26 20:22:49 -04:00
parent afad1cad4c
commit 19d43a9a4a
1 changed files with 19 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
Notify_nexmo.md

@ -1,39 +1,41 @@
## Nexmo
* **Source**: https://d7networks.com
* **Source**: https://nexmo.com/
* **Icon Support**: No
* **Message Format**: Text
* **Message Limit**: 160 Characters per message
* **Message Limit**: 140 Characters per message
### Account Setup
To use this service you will need a D7 Networks account from their [website](https://d7networks.com/)
To use Nexmo, you will need to acquire your _API Key_ and _API Secret_. Both of these are accessible via the [Nexmo Dashboard](https://dashboard.nexmo.com/getting-started-guide).
After you've established your account you can get your api login credentials (both _user_ and _password_) from the API Details section from within your [account profile area](https://d7networks.com/accounts/profile/).
The **{FromPhoneNo}** must be a number provided to you through Nexmo
### Syntax
Valid syntaxes are as follows:
* **d7sms**://**{user}**:**{password}**@/**{PhoneNo}**
* **d7sms**://**{user}**:**{password}**@**{PhoneNo1}**/**{PhoneNo2}**/**{PhoneNoN}**
* **nexmo**://**{ApiKey}**:**{ApiSecret}**@**{FromPhoneNo}**/**{PhoneNo}**
* **nexmo**://**{ApiKey}**:**{ApiSecret}**@**{FromPhoneNo}**/**{PhoneNo1}**/**{PhoneNo2}**/**{PhoneNoN}**
If no _ToPhoneNo_ is specified, then the _FromPhoneNo_ will be messaged instead; hence the following is a valid URL:
* **nexmo**://**{ApiKey}**:**{ApiSecret}**@**{FromPhoneNo}**/
### Parameter Breakdown
| Variable | Required | Description
| --------------- | -------- | -----------
| user | Yes | The _username_ associated with your D7 Networks account. This is available to you via the **API Details** section from within your [account profile area](https://d7networks.com/accounts/profile/).
| password | Yes | The _API Secret_ associated with your D7 Networks account. This is available to you via the **API Details** section from within your [account profile area](https://d7networks.com/accounts/profile/).
| PhoneNo | Yes | At least one phone number MUST identified to use this plugin. 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.
| from | No | Originating address,In cases where the rewriting of the sender's address is supported or permitted by the SMS-C. This is used to transmit the message, this number is transmitted as the originating address and is completely optional.
| priority | No | By default a priority of zero (0) is set (low). You can set 0, 1, 2, or 3 if you wish to adjust this value where as 3 represents a high priority.
| batch | No | D7 Networks allows a batch mode; by default this is off. If you identify more then one phone number, you can send all of them in a single post instead of the normal _Apprise_ approach as to send them one by one. By default batch mode is disabled.
| ApiKey | Yes | The _API Key_ associated with your Nexmo account. This is available to you via the [Nexmo Dashboard](https://dashboard.nexmo.com/getting-started-guide).
| ApiSecret | Yes | The _API Secret_ associated with your Nexmo account. This is available to you via the [Nexmo Dashboard](https://dashboard.nexmo.com/getting-started-guide).
| FromPhoneNo | Yes | This must be a _From Phone Number_ that has been provided to you from the Nexmo website.
| PhoneNo | **\*No** | 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
#### Example
Send a D7 Network Notification as an SMS:
Send a Nexmo Notification as an SMS:
```bash
# Assuming our {user} is l2g
# Assuming our {password} is appriseIsAwesome
# 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 d7sms://l2g:appriseIsAwesome@18005551223
apprise nexmo://bc1451bd:gank339l7jk3cjaE@19005559999/18005551223
# the following would also have worked (spaces, brackets,
# dashes are accepted in a phone no field):
apprise d7sms://l2g:appriseIsAwesome@1-(800) 555-1223
apprise nexmo://bc1451bd:gank339l7jk3cjaE@1-(900) 555-9999/1-(800) 555-1223
```