From e3a1222eb9ba3cca758b72cf19d0aedca3469e8e Mon Sep 17 00:00:00 2001 From: Chris Caron Date: Thu, 6 Jun 2019 22:13:55 -0400 Subject: [PATCH] Created Notify_nexmo (markdown) --- Notify_nexmo.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 Notify_nexmo.md diff --git a/Notify_nexmo.md b/Notify_nexmo.md new file mode 100644 index 0000000..d8ae9da --- /dev/null +++ b/Notify_nexmo.md @@ -0,0 +1,41 @@ +## Nexmo +* **Source**: https://nexmo.com/ +* **Icon Support**: No +* **Message Format**: Text +* **Message Limit**: 140 Characters per message + +### Account Setup +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). + +The **{FromPhoneNo}** must be a number provided to you through Nexmo + +### Syntax +Valid syntaxes are as follows: +* **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 +| --------------- | -------- | ----------- +| 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 Nexmo Notification as an SMS: +```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 nexmo://bc1451bd:gank339l7jk3cjaE@19005559999/18005551223 + +# the following would also have worked (spaces, brackets, +# dashes are accepted in a phone no field): +apprise nexmo://bc1451bd:gank339l7jk3cjaE@1-(900) 555-9999/1-(800) 555-1223 +``` \ No newline at end of file