springedge

Node.js REST API SMS Library using Spring Edge

Usage no npm install needed!

<script type="module">
  import springedge from 'https://cdn.skypack.dev/springedge';
</script>

README

SMS REST API for Node.js using Spring Edge

This repository contains A nodejs RestAPI package to send sms using Spring Edge (https://www.springedge.com) APIs

Requirements

Sign up for a free Trail Messaging account
Create a new apikey from developers section of sms account
Setup sender name for sms account.
SpringEdge REST API for Node.js requires Node.js >= 0.10 or io.js

Installation

npm install springedge

Usage

Example of sending message:

var springedge = require('springedge');

var params = {
  'apikey': '', // API Key
  'sender': 'SEDEMO', // Sender Name
  'to': [
    '919019xxxxxxxx'  //Moblie Number
  ],
  'message': 'Hello, This is a test message from spring edge',
  'format': 'json'
};

springedge.messages.send(params, 5000, function (err, response) {
  if (err) {
    return console.log(err);
  }
  console.log(response);
});

// Result:

{
  "groupID":xxxx,
  "MessageIDs":"xxxxx-x",
  "status":"AWAITED-DLR"
}

Or in case of an error:

{
  "error":"Invalid Mobile Numbers"
}

Support

For any support or instructions please visit below website: https://www.springedge.com