decisiontelecom v1.0.2

IT-Decision Telecom Node.js SDK

Convenient Node.js client for IT-Decision Telecom messaging API.

Requirements

• Sign up for a free IT-Decision Telecom account
• Request login and password to send SMS messages and access key to send Viber messages
• Node.js version 14.x or higher installed
• You should have an application written in Node.js to make use of this SDK

Installation

npm install decisiontelecom

Usage

We have put some self-explanatory usage examples in the examples folder, but here is a quick reference on how IT-Decision Telecom clients work. First you need to initialize the library.

CommonJS require syntax:

const decisiontelecom = require('decisiontelecom')

Then, create an instance of a required client. Be sure to use real login, password and access key.

var smsClient = new decisiontelecom.SmsClient("<YOUR_LOGIN>", "<YOUR_PASSWORD>");
var viberClient = new decisiontelecom.ViberClient("<YOUR_ACCESS_KEY>");
var viberPlusSmsClient = new decisiontelecom.ViberPlusSmsClient("<YOUR_ACCESS_KEY>");

Now you can use created client to perform needed operations. For example, this is how you can get your SMS balance:

try {
    // Call client GetBalance method to get SMS balance information.
    var balance = await smsClient.getBalance();

    // GetBalance method should return SMS balance information.
    console.log(`Balance: ${balance.balance}, Credit: ${balance.credit}, Currency: ${balance.currency}`);
} catch (error) {
    if (error instanceof SmsError) {
        // SmsError contains specific DecisionTelecom error with the code of what went wrong during the operation.
        console.log(`SMS error code: ${error.errorCode.code} (${error.errorCode})`);
    } else {
        // A non-DecisionTelecom error occurred during the operation (like connection error).
        console.log(error);
    }
}

Error handling

All client methods throw an error in case if something went wrong during the operation. It might be a general error in case of connection error, for example. Or it might be a specific DecisionTelecom error with some details of what went wrong.

SMS client methods might throw SmsError which contains an SMS error code. Viber and Viber plus SMS client methods might throw ViberError which contains some error details like name, message, status and code.

See provided examples on how to handle specific DecisionTelecom exceptions.

SMS errors

SMS client methods return errors in form of the error code. Here are all possible error codes:

• 40 - Invalid number
• 41 - Incorrect sender
• 42 - Invalid message ID
• 43 - Incorrect JSON
• 44 - Invalid login or password
• 45 - User locked
• 46 - Empty text
• 47 - Empty login
• 48 - Empty password
• 49 - Not enough money to send a message
• 50 - Authentication error
• 51 - Invalid phone number

Viber errors

Viber and Viber plus SMS client methods return errors in form of a class with the name, message, code and status properties.

Known Viber errors are:

{
  "name": "Too Many Requests",
  "message": "Rate limit exceeded",
  "code": 0,
  "status": 429
}

{
  "name": "Invalid Parameter: [param_name]",
  "message": "Empty parameter or parameter validation error",
  "code": 1,
  "status": 400
}

{
  "name": "Internal server error",
  "message": "The server encountered an unexpected condition which prevented it from fulfilling the request",
  "code": 2,
  "status": 500
}

{
  "name": "Topup balance is required",
  "message": "User balance is empty",
  "code": 3,
  "status": 402
}