Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including pip-clients-sms-node with all npm packages installed. Try it out:

var pipClientsSmsNode = require("pip-clients-sms-node")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

pip-clients-sms-node v1.0.1

Node.js client sdk for pip-services-sms microservice

Sms Delivery Microservice Client SDK for Node.js

This is a Node.js client SDK for pip-services-sms microservice. It provides an easy to use abstraction over communication protocols:

  • HTTP client
  • Seneca client (see http://www.senecajs.org)
  • Direct client for monolythic deployments
  • Null client to be used in testing

In addition to the microservice functionality the client SDK supports message templates that can be configured by client user.

Quick Links:

Install

Add dependency to the client SDK into package.json file of your project

{
    ...
    "dependencies": {
        ....
        "pip-clients-sms-node": "^1.0.*",
        ...
    }
}

Then install the dependency using npm tool

# Install new dependencies
npm install

# Update already installed dependencies
npm update

Use

Inside your code get the reference to the client SDK

var sdk = new require('pip-clients-sms-node');

Define client configuration parameters.

// Client configuration
var config = {
    parameters: {
        server_url: 'http://localhost:3000',
        client_url: 'http://localhost:8000',
        client_name: 'PipServices Sample',
        welcome_message: 'Congratulations with your signup in <%= clientName %>!',
        signature: 'Sincerely, <%= clientName %> Team'
    },
    connection: {
        protocol: 'http',
        host: 'localhost', 
        port: 8080
    }
};

Instantiate the client and open connection to the microservice

// Create the client instance
var client = sdk.SmsHttpClient(config);

// Connect to the microservice
client.open(null, function(err) {
    if (err) {
        console.error('Connection to the microservice failed');
        console.error(err);
        return;
    }
    
    // Work with the microservice
    ...
});

Now the client is ready to perform operations

// Send sms message to address
client.sendMessage(
    null,
    { 
        to: '+12343455633',
        text: 'This is a test message. Please, ignore it'
    },
    null,
    function (err) {
        ...
    }
);
// Send sms message to users
client.sendMessageToRecipients(
    null,
    [
        { id: '123', phone: '+12343455633' },
        { id: '321', phone: '+12343434633' }
    ],
    { 
        text: 'This is a test message. Please, ignore it'
    },
    null,
    function (err) {
        ...
    }
);

Now you can send a message using the handlebars templates. Client will automatically load their content and parse.

// Send sms message to address using template
client.sendMessage(
    null,
    { 
        to: 'somebody@somewhere.com',
        text: 'Today is {{ today }}'
    },
    {
        today: new Date.toISOString()
    },
    function (err) {
        ...
    }
);

Acknowledgements

This client SDK was created and currently maintained by Sergey Seroukhov.

Metadata

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free