0.0.1 • Published 6 years ago

messageapi-client-nodejs v0.0.1

Weekly downloads
4
License
UNLICENSED
Repository
github
Last release
6 years ago

MessageAPIClient for NodeJS

RingRing provides simple and fast API for sending and receiving text messages (SMS).

How to use

  • Contact us at sales@ringring.be, we will create an account for you.
  • Once you have access to your account, you will be able to access to interface at https://portal.ringring.be. Here you will see all account information you need to send real messages through the API.
  • Lastly, install our npm package in your nodeJS Project by running :
$ npm install --save @ringring/messageapi-client-nodejs

:boom: NOTE : You must have your personal API key. And you must be in your project's folder to run this install command.

Example

const { MessageClient } = require('@ringring/messageapi-client-nodejs');
 
const m = new MessageClient('YOUR-API-KEY');
 
// First param  => phone numbers separated by , (up to 1000)
// Second param => message content
// Other Params ==> options ( cf. MessageAPI doc )
m.send('32123456789', 'My sms content').catch(err => {
  console.log(err);
});

Version

NodeJS 10.13 or more

Installation

It is recommended to read the messageApi docs first. For example, the send function accept all the params of messageAPI to send an SMS.

Documentation

http://docs.ringring.be