Package Exports

pip-services-sms-node

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (pip-services-sms-node) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

SMS Microservice

This is a sms sending microservice from Pip.Services library. This microservice is intended mostly to send smss to registered users as well as orbitrary recipients. Users have ability to enable or disable certain subcription types. In the current version sms attachments are not supported.

The microservice currently supports the following deployment options:

Deployment platforms: Standalone Process, Seneca
External APIs: HTTP/REST, Seneca

This microservice has optional dependencies on the following microservices:

pip-services-activities - to log user activities

Quick Links:

Download Links
Development Guide
Configuration Guide
Deployment Guide
Client SDKs
- Node.js SDK
Communication Protocols
- HTTP Version 1
- Seneca Version 1

Contract

Logical contract of the microservice is presented below. For physical implementation (HTTP/REST, Thrift, Seneca, Lambda, etc.), please, refer to documentation of the specific protocol.

class SmsMessageV1 {
    public from: string;
    public to: string;
    public text: string;
}

class SmsRecipientV1 {
    public id: string;
    public name: string;
    public phone: string;
    public language: string;
}

class SmsSettingsV1 implements IStringIdentifiable {
    /* Recipient information */
    public id: string;
    public name: string;
    public phone: string;
    public language: string;

    /* Sms management */
    public subscriptions: any;
    public verified: boolean;
    public ver_code: string;
    public ver_expire_time: Date;

    /* Custom fields */
    public custom_hdr: any;
    public custom_dat: any;
}

interface ISmsV1 {
    getSettingsById(correlationId: string, recipientId: string,
        callback: (err: any, settings: SmsSettingsV1) => void): void;
    getSettingsByPhone(correlationId: string, phone: string,
        callback: (err: any, settings: SmsSettingsV1) => void): void;
    setSettings(correlationId: string, settings: SmsSettingsV1,
        callback?: (err: any, settings: SmsSettingsV1) => void): void;
    setRecipient(correlationId: string, recipientId: string,
        name: string, sms: string, language: string,
        callback?: (err: any, settings: SmsSettingsV1) => void): void;
    setSubscriptions(correlationId: string, recipientId: string, subscriptions: any,
        callback?: (err: any, settings: SmsSettingsV1) => void): void;
    deleteSettingsById(correlationId: string, recipientId: string,
        callback?: (err: any) => void): void;

    sendMessage(correlationId: string, message: SmsMessageV1, parameters: ConfigParams,
        callback?: (err: any) => void): void;
    sendMessageToRecipient(correlationId: string, recipient: SmsRecipientV1, subscription: string,
        message: SmsMessageV1, parameters: ConfigParams, callback?: (err: any) => void);
    sendMessageToRecipients(correlationId: string, recipients: SmsRecipientV1[], subscription: string,
        message: SmsMessageV1, parameters: ConfigParams, callback?: (err: any) => void): void;

    sendTemplatedMessage(correlationId: string, templateId: string, parameters: ConfigParams,
        callback?: (err: any) => void): void;
    sendTemplatedMessageToRecipient(correlationId: string, recipient: SmsRecipientV1,
        subscription: string, templateId: string, parameters: ConfigParams,
        callback?: (err: any) => void);
    sendTemplatedMessageToRecipients(correlationId: string, recipients: SmsRecipientV1[],
        subscription: string, templateId: string, parameters: ConfigParams,
        callback?: (err: any) => void): void;

    resendVerification(correlationId: string, recipientId: string,
        callback?: (err: any) => void): void;
    verifyPhone(correlationId: string, recipientId: string, code: string,
        callback?: (err: any) => void): void;
}

Message subject, text and html content can be set by template, that it processed using parameters set. Here is an example of the template:

Dear <%= name %>,
Please, help us to verify your sms address. Your verification code is <%= code %>.
<%= signature %>

Download

Right now the only way to get the microservice is to check it out directly from github repository

git clone git@github.com:pip-services-users/pip-services-sms-node.git

Pip.Service team is working to implement packaging and make stable releases available for your as zip downloadable archieves.

Run

Add config.yml file to the root of the microservice folder and set configuration parameters. As the starting point you can use example configuration from config.example.yml file. Example of microservice configuration ```yaml

descriptor: "pip-services-commons:logger:console:default:1.0" level: "trace"
descriptor: "pip-services-sms:persistence:file:default:1.0" path: "./data/sms_settings.json"
descriptor: "pip-services-sms:controller:default:default:1.0" message: from: '+12453453445' to: '+79532347823' connection: arn: 'xxx' credential: access_id: 'xxx' access_key: 'xxx'
descriptor: "pip-services-sms:service:http:default:1.0" connection: protocol: "http" host: "0.0.0.0" port: 8080

 
For more information on the microservice configuration see [Configuration Guide](Configuration.md).

Start the microservice using the command:
```bash
node run

Use

The easiest way to work with the microservice is to use client SDK. The complete list of available client SDKs for different languages is listed in the Quick Links

If you use Node.js then you should add dependency to the client SDK into package.json file of your project

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

Inside your code get the reference to the client SDK

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

Define client configuration parameters that match configuration of the microservice external API

// Client configuration
var config = {
    connection: {
        protocol: 'http',
        host: 'localhost', 
        port: 8080
    }
};

Instantiate the client and open connection to the microservice

// Create the client instance
var client = sdk.SmsHttpClientV1(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: '+13452345324',
        text: 'This is a test message. Please, ignore it'
    },
    function (err) {
        ...
    }
);

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

Acknowledgements

This microservice was created and currently maintained by Sergey Seroukhov.