textmagic-rest-nodejs's Introduction

TextMagic JavaScript SDK

This library provides you with an easy way of sending SMS and receiving replies by integrating TextMagic SMS Gateway into your JavaScript application.

What Is TextMagic?

TextMagic’s application programming interface (API) provides the communication link between your application and TextMagic’s SMS Gateway, allowing you to send and receive text messages and to check the delivery status of text messages you’ve already sent.

Installation

npm install [email protected] --save

Usage Example

Please follow the installation instructions and execute the following JS code:

const textmagicClient = require('textmagic-client');

const fs = require('fs');
const client = textmagicClient.ApiClient.instance;
const auth = client.authentications['BasicAuth'];

auth.username = 'YOUR_USERNAME';
auth.password = 'YOUR_PASSWORD';

const api = new textmagicClient.TextMagicApi();

// Simple ping request example
api.ping().then(function (data) {
    console.log(data.ping);
}).catch(function(err){
    console.error(err);
});

// Send a new message request example
api.sendMessage({
    'text': 'I love TextMagic!',
    'phones': '+12341234123'
}).then(function (data) {
    console.log(data.id);
}).catch(function(err){
    console.error(err);
});

// Get all outgoing messages request example
api.getAllOutboundMessages({
    'page': 1,
    'limit': 200
}).then(function (data) {
    console.log(data.resources[0].text);
}).catch(function(err){
    console.error(err);
});

// Upload new avatar for contacts list (group) with Id 3223 example
let stream = new fs.ReadStream('test.jpg');
api.uploadListAvatar(stream, 3223).then(function (data) {
    console.log(data.id);
}).catch(function(err){
    console.error(err);
});