onpagecorp / onpage_hub_api_cli_py Goto Github PK

==================
OnPage HUB API CLI
==================

OnPage HUB API CLI allows to send Pages to the OnPage Pagers from command line. For more information visit
http://www.onpage.com. To use this script you have to change ENTERPRISE_NAME, TOKEN and <recipients> Pager numbers to
real values.

CLI requires OnPage-HUB-API-Client module that can be installed using pip
```
pip install OnPage-HUB-API-Client
```
or  by executing

```
python setup.py install
```

Typical usage to send Page::

sendOnPage.py -e ENTERPRISE_NAME -t TOKEN -s subject_text –r PAGER1,PAGER2 –f SENDER

Available parameters in command line:
        -e|--enterprise_name - required parameter, has to be requested from [email protected]
        -t|--token token - required parameter, has to be requested from [email protected]
        -s|--subject subject - required parameter
        -r|--recipients recipient_1[,recipient_2[,...]] - required parameter, list of OnPage Pagers delimited by ','
        -f|--from sender_name - required parameter, sender name to be shown for recipient(s)
        [-m|--m message_body] - not required parameter
        [-l|--log INFO|NOTSET|DEBUG|ERROR|CRITICAL|FATAL] - not required parameter, default value is INFO. sendOnPage.log
            file will be created with log information. To disable log file use NOTSET value.


If everything is configured right the output of the script has to be something like:

Message 170315170855-8836 accepted by OnPage

and recipients will receive it immediately.

As an option the '''onpage_configuration.cfg''' configuration file can be used instead of specifying enterprise name and
token values in a command line, but if these values are specified in the command line they will override the values from
the configuration file.

For more information contact [email protected]