extern/apprise
1
0
Fork 0
mirror of https://github.com/caronc/apprise.git synced 2024-12-12 09:51:05 +01:00
Code Issues Packages Projects Releases Wiki Activity

Created Notify_popcornnotify (markdown)

Chris Caron 2019-09-09 19:42:20 -04:00
parent 818d0fcdfd
commit b4b1696bfd
1 changed files with 47 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
Notify_popcornnotify.md Normal file

@ -0,0 +1,47 @@
## PopcornNotify Notifications
* **Source**: https://popcornnotify.com/
* **Icon Support**: No
* **Message Format**: Text
* **Message Limit**: 32768 Characters per message
### Account Setup
Get yourself an API Key from [their website](https://popcornnotify.com/) and you're already to use the service.
### Syntax
Valid syntaxes are as follows:
* `popcorn**://{ApiKey}/{PhoneNo}/`
* `popcorn**://{ApiKey}/{PhoneNo1}/{PhoneNo2}/{PhoneNoN}/`
* `popcorn**://{ApiKey}/{Email}/`
* `popcorn**://{ApiKey}/{Email1}/{Email2}/{EmailN}/`
You can mix and match the information too:
* `popcorn**://{ApiKey}/{PhoneNo1}/{Email1}/{EmailN}/{PhoneNoN}`
### Parameter Breakdown
| Variable | Required | Description
| ----------- | -------- | -----------
| ApiKey | Yes | The Personal API Token associated with your account.
| PhoneNo | No | A Phone Number you wish to notify (via SMS).
| Email | No | The Email address you wish to notify
| to | No | This is an alias to the Phone/Email variable.
| batch | No | PopcornNotify allows a batch mode. If you identify more then one phone number and/or email, you can send all of these targets you identify on the URL in a single shot instead of the normal _Apprise_ approach (which sends them one by one). Enabling batch mode has both it's pro's and cons. By default batch mode is disabled.
#### Example
Send a PopcornNotify notification as an SMS:
```bash
# Assuming our {ApiKey} is abc123456
# Assuming our {PhoneNo} - is in the US somewhere making our country code +1
# - identifies as 800-555-1223
apprise popcorn:///abc123456/18005551223
# the following would also have worked (spaces, brackets,
# dashes are accepted in a phone no field):
apprise popcorn:///abc123456/1-(800) 555-1223
```
You can also send emails just as easily:
```bash
# Assuming our {ApiKey} is abc123456
# Assuming our {Email} is user@example.com
apprise popcorn:///abc123456/user@example.com
```