Octopush API Python
A Python library for Octopush API.
Octopush offers a solution that was built in-house as a hosted service (SaaS, Software as a Service and an API) to allow marketing departments of major groups, advertising agencies and IT companies to enjoy an infrastructure that supports sending SMS messages to more than 200 countries.
Installation
Install via PyPI
pip install octopushOr add octopush to your application's requirements
file
and then run
pip install -r requirements.txtOr from source code
git clone https://github.com/bearburger/octopush-api-python.git
cd octopush-api-python
python setup.py installUsage
Config file (config.py)
import octopush
import datetime
config = {
'user_login': '*******@*******',
'api_key': '****************',
'sms_recipients': ['+33600000000'],
'sms_text': 'test text ' + datetime.datetime.now().strftime("%Y-%m-%d %H:%M"),
'sms_type': octopush.SMS_WORLD,
'sms_sender': 'onesender'
}Credit check
from octopush import SMS
from config import config
sms = SMS(config['user_login'], config['api_key'])
result = sms.get_credit()
for credit in result.findall('credit'):
print(credit.text)SMS sending
from octopush import SMS
from config import config
import uuid
sms = SMS(config['user_login'], config['api_key'])
sms.set_sms_text(config['sms_text'])
sms.set_sms_recipients(config['sms_recipients'])
sms.set_sms_type(config['sms_type'])
sms.set_sms_sender(config['sms_sender'])
sms.set_sms_request_id(str(uuid.uuid1()))
result = sms.send()
print(result)More examples can be found in Simple Examples and Advanced Examples.
Requirements
- API key, register at octopush.com to get one
- Python 2.6+, 3.5+
- python-requests
Documentation
This library is completely documented using PyDoc and will show autocompletions in all editors that supports it. Alternatively you can build HTML version of documentation via pydoc tool.
API documentation available on Octopush API documentation portal.
