apprise

extern/apprise

Fork 0

mirror of https://github.com/caronc/apprise.git synced 2024-12-04 05:54:35 +01:00

Table of Contents

Vonage (formerly Nexmo)

Account Setup
Syntax
Parameter Breakdown

Example

Vonage (formerly Nexmo)

Source: https://nexmo.com/
Icon Support: No
Message Format: Text
Message Limit: 160 Characters per message

Account Setup

To use Vonage, you will need to acquire your API Key and API Secret. Both of these are accessible via the Vonage Dashboard.

The {FromPhoneNo} must be a number provided to you through Nexmo

Syntax

Valid syntax is as follows:

nexmo://{ApiKey}:{ApiSecret}@{FromPhoneNo}/{PhoneNo}
nexmo://{ApiKey}:{ApiSecret}@{FromPhoneNo}/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}
vonage://{ApiKey}:{ApiSecret}@{FromPhoneNo}/{PhoneNo}
vonage://{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 Vonage Dashboard.
ApiSecret	Yes	The API Secret associated with your Nexmo account. This is available to you via the Vonage Dashboard.
FromPhoneNo	Yes	This must be a From Phone Number that has been provided to you from the Vonage 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 Vonage Notification as an SMS:

# 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" \
   vonage://bc1451bd:gank339l7jk3cjaE@19005559999/18005551223

# the following would also have worked (spaces, brackets,
# dashes are accepted in a phone no field):
apprise -vv -t "Test Message Title" -b "Test Message Body" \
   vonage://bc1451bd:gank339l7jk3cjaE@1-(900) 555-9999/1-(800) 555-1223

Quick Links:

📣 Apprise Notification Services and URL Examples
💡 Apprise CLI Tool Help
⚙️ Apprise Configuration Help
🌎 Apprise API/Web Interface