diff --git a/Notify_voipms.md b/Notify_voipms.md new file mode 100644 index 0000000..66f5d98 --- /dev/null +++ b/Notify_voipms.md @@ -0,0 +1,47 @@ +## Voip.ms Notifications +* **Source**: https://voip.ms/ +* **Icon Support**: No +* **Message Format**: Text +* **Message Limit**: 160 Characters per Message + +### Setup +Sign up for Voip.ms [from here](https://voip.ms). From your dashboard, you will have to enable API access and create a password at the following link: [here](https://voip.ms/m/api.php) + +### Syntax +Valid syntax is as follows: + +* ```voipms://{password}:{email}/{fromPhoneNo}``` +* ```voipms://{password}:{email}/{fromPhoneNo}/{toPhoneNo}``` +* ```voipms://{password}:{email}/{fromPhoneNo}/{toPhoneNo1}/{toPhoneNo2}/{toPhoneNoN}/``` + +**Note:** If not channel is specified then by default the **#General** channel is messaged. + +### Parameter Breakdown +| Variable | Required | Description | +| ------------- | ------------- | ------------- | +| email | Yes | The email associated with your Voip.ms account | +| password | Yes | The password for API access, this is different from your Voip.ms account password | +| to | *No | A phone number and/or group you wish to send your notification to. You can use comma's to separate multiple entries if you wish. This is an alias to targets. | +| from | *No | Specify the phone number you registered with Voip.ms you wish the message to be identified as being sent from. | + +#### Example +Send a Voip.ms notification to ourselves: +```bash +# Assume: +# - our {email} is test@example.com +# - our {password} is abc123 +# - The {toPhoneNo} and {fromPhoneNo} is 6135551234 +apprise -vv -t "Test Message Title" -b "Test Message Body" \ + voipms://abc123:test@example.com/6135551234 +``` + +Send a Voip.ms notification to another device: +```bash +# Assume: +# - our {email} is test@example.com +# - our {password} is abc123 +# - The {fromPhoneNo} is 6135551234 +# - The {ToPhoneNo} is 5645554321 +apprise -vv -t "Test Message Title" -b "Test Message Body" \ + voipms://abc123:test@example.com/6135551234/5645554321 +```