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.
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 = 'pip-clients-sms-node';
Define client configuration parameters.
// Client configurationvar 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 instancevar client = sdk; // Connect to the microserviceclient;
Now the client is ready to perform operations
// Send sms message to addressclient;
// Send sms message to usersclient;
Now you can send a message using the handlebars templates. Client will automatically load their content and parse.
// Send sms message to address using templateclient;
Acknowledgements
This client SDK was created and currently maintained by Sergey Seroukhov.