Created Notify_kavenegar (markdown)

master
Chris Caron 2020-01-29 13:07:53 -05:00
parent e2348e09e2
commit ff09244a2c
1 changed files with 36 additions and 0 deletions

36
Notify_kavenegar.md Normal file

@ -0,0 +1,36 @@
## Kavenegar
* **Source**: https://kavenegar.com
* **Icon Support**: No
* **Message Format**: Text
* **Message Limit**: 160 Characters per message
### Account Setup
To use Kavenegar, first register an account on [their website](https://kavenegar.com/). After you've done so, you can get your API Key from the [account profile](https://panel.kavenegar.com/client/setting/account) section.
### Syntax
Valid syntaxes are as follows:
* `kavenegar://{apikey}/{to_phone_no}`
* `kavenegar://{from_phone_no}@{apikey}/{to_phone_no}`
* `kavenegar://{apikey}/{to_phone_no}/{to_phone_no2}/{to_phone_noN}/`
* `kavenegar://{from_phone_no}@{apikey}/{to_phone_no}/{to_phone_no2}/{to_phone_noN}/`
### Parameter Breakdown
| Variable | Required | Description
| --------------- | -------- | -----------
| ApiKey | Yes | The _API Key_ associated with your Kavengar account. This is available to you via the [account profile](https://panel.kavenegar.com/client/setting/account) section of their website (after logging in).
| ToPhoneNo | Yes | Kavengar does not handle the `+` in front of the country codes. You need to substitute the correct amount of zero's in front of the outbound number in order for the call to be completed.
| FromPhoneNo | No | The number you wish to identify your call is coming from. This argument is optional.
#### Example
Send a Kavenegar Notification as an SMS:
```bash
# Assuming our {ApiKey} is gank339l7jk3cjaE
# Assuming our {PhoneNo} - is in the US somewhere making our country code 001
# - identifies as 800-555-1223
apprise kavenegar://gank339l7jk3cjaE/0018005551223
# the following would also have worked (spaces, brackets,
# dashes are accepted in a phone no field):
apprise kavenegar://gank339l7jk3cjaE/001 - (800) 555-1223
```