Octopush API library for Node.js
A Node.js 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
Installation via npm
npm install octopush
Usage
config.js
)
Config file (var octopush = ; moduleexports = user_login: '************@********' api_key: '****************' sms_recipients: '+33600000000' sms_text: 'test text ' + + '-' + + 1 + '-' + sms_type: octopushconstantsSMS_PREMIUM sms_mode: octopushconstantsINSTANTANE sms_sender: 'Octopush';
Balance check
var octopush = ;var config = ; var sms = configuser_login configapi_key; sms;
SMS sending
var octopush = ;var config = ; var sms = configuser_login configapi_key; sms;sms;sms;sms;sms;sms; sms;
More examples can be found in Simple Examples and Advanced Examples.
Requirements
- API key, register at octopush.com to get one
- Node.js
Documentation
This library is completely documented using JSDoc and will show autocompletions in all editors that supports it. Alternatively you can build HTML version of documentation via jsdoc tool.
API documentation available on Octopush API documentation portal.