2015-02-02 00:11:14 +00:00
|
|
|
Twilio SMS Plugin
|
|
|
|
|
=================
|
|
|
|
|
|
2016-12-04 20:32:49 +00:00
|
|
|
Send SMS messages for new alerts using Twilio.
|
|
|
|
|
|
|
|
|
|
For help, join [](https://gitter.im/alerta/chat)
|
2015-02-02 00:11:14 +00:00
|
|
|
|
|
|
|
|
Installation
|
|
|
|
|
------------
|
|
|
|
|
|
2016-12-04 20:32:49 +00:00
|
|
|
Clone the GitHub repo and run:
|
|
|
|
|
|
2015-02-02 00:11:14 +00:00
|
|
|
$ python setup.py install
|
|
|
|
|
|
2016-12-04 20:32:49 +00:00
|
|
|
Or, to install remotely from GitHub run:
|
|
|
|
|
|
|
|
|
|
$ pip install git+https://github.com/alerta/alerta-contrib.git#subdirectory=plugins/twilio
|
|
|
|
|
|
|
|
|
|
Note: If Alerta is installed in a python virtual environment then plugins
|
|
|
|
|
need to be installed into the same environment for Alerta to dynamically
|
|
|
|
|
discover them.
|
2015-02-02 00:11:14 +00:00
|
|
|
|
|
|
|
|
Configuration
|
|
|
|
|
-------------
|
|
|
|
|
|
2016-12-04 20:32:49 +00:00
|
|
|
Add `twilio_sms` to the list of enabled `PLUGINS` in `alertad.conf` server
|
|
|
|
|
configuration file and set plugin-specific variables either in the
|
|
|
|
|
server configuration file or as environment variables.
|
|
|
|
|
|
|
|
|
|
```python
|
|
|
|
|
PLUGINS = ['twilio_sms']
|
2015-02-02 00:11:14 +00:00
|
|
|
TWILIO_ACCOUNT_SID = 'ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
|
|
|
|
|
TWILIO_AUTH_TOKEN = ''
|
|
|
|
|
|
|
|
|
|
TWILIO_TO_NUMBER = ''
|
|
|
|
|
TWILIO_FROM_NUMBER = ''
|
|
|
|
|
```
|
|
|
|
|
|
2016-12-04 20:32:49 +00:00
|
|
|
Troubleshooting
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
Restart Alerta API and confirm that the plugin has been loaded and enabled.
|
|
|
|
|
|
2015-02-02 00:11:14 +00:00
|
|
|
References
|
|
|
|
|
----------
|
|
|
|
|
|
2016-12-04 20:32:49 +00:00
|
|
|
* Twilio Sending Messages: https://www.twilio.com/docs/api/rest/sending-messages
|
|
|
|
|
|
|
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
Copyright (c) 2016 Nick Satterly. Available under the MIT License.
|
