❤
npm
Sign UpSign In

aspsms

0.1.1 • Public • Published

node-aspsms

A partial implementation of the aspsms.com XML SMS API for node.js.

Installation

sudo npm install aspsms

Methods

  • setDefaultOptions(options) Sets the default options
  • send(options, callback, message) Sends a text message
  • showCredits(options, callback, message) Returns the amount of credits left

Options

  • userkey Your ASPSMS Uesrkey
  • password Your ASPSMS password
  • originator Name of the sender
  • recipient Mobile phone number of the recipient

Errors

If the operation was successfull the error object passed to the callback will be null. If the operation fails the error object will contain an errorCode and an errorDescription field with values according to the aspsms.com documentation.

Examples

Send a text message

var aspsms = require('aspsms');
 
aspsms.setDefaultOptions({
    'userkey' : 'YOUR_ASPSMS_USERKEY', 
    'password' : 'YOUR_ASPSMS_PASSWORD', 
    'originator' : 'TestApp'
});
 
aspsms.send({
    'recipient' : '+41555123456'
 
}, function (error) {
    if (!error) {
        console.log('Success!');
    }
    
}, 'Hello, this is a test.');

Show how many credits you have left

var aspsms = require('aspsms');
 
aspsms.setDefaultOptions({
    'userkey' : 'YOUR_ASPSMS_USERKEY', 
    'password' : 'YOUR_ASPSMS_PASSWORD', 
});
 
aspsms.showCredits({ }, function (error, credits) {
    if (!error) {
        console.log('You have ' + credits + ' left');
    }
    
});

If you don't want to use setDefaultOptions you can pass all options in each command.

var aspsms = require('aspsms');
 
aspsms.send({
    'userkey' : 'YOUR_ASPSMS_USERKEY', 
    'password' : 'YOUR_ASPSMS_PASSWORD', 
    'originator' : 'TestApp', 
    'recipient' : '+41555123456'
 
}, function (error) {
    if (!error) {
        console.log('Success!');
    }
    
}, 'Hello, this is a test.');

Readme

Keywords

none

Package Sidebar

Install

npm i aspsms

Repository

github.com/maxkueng/node-aspsms

Homepage

github.com/maxkueng/node-aspsms#readme

Weekly Downloads

3

Version

0.1.1

License

none

Last publish

Collaborators

  • maxkueng
Try on RunKit
Report malware