Upgrade from Node.js Legacy to v4.8.0 or Latest Version

Introduction

This is a major application update. Plivo recommends you always use the latest or an active version of our SDKs for guaranteed security, stability, and uptime. The active SDK versions are designed to handle intermittent and regional failures of API requests. In addition, they offer a host of security features, such as protection against DoS attacks and bot detection for suspicious user agents.

Deprecation notice: We’re deprecating Plivo Node.js SDK legacy versions lower than v4.8.0 on January 31, 2022. If you use a deprecated version of our SDK after that date, your API requests and messaging may fail intermittently. Plivo will no longer provide bug fixes to these versions, and our support team may ask you to upgrade before debugging issues.

Migrate your applications

Node.js version support

The 4.x version of the Plivo SDK is compatible with Node.js versions 5.5 and higher.

Use the command npm install plivo@4.8.0 to upgrade to the active version of the SDK, or npm install plivo@latest to upgrade to the latest version.

After you upgrade to the latest version of the SDK, you should check every program that depends on it and make changes to the syntax for several kinds of operations. Here are examples of how coding differs between the deprecated legacy version of the SDK and the latest active versions.

Import the SDK

Legacy Latest 
var plivo = require('plivo');
   
var plivo = require('plivo');

Initialize

Legacy Latest 
var p = plivo.RestAPI({
  authId: '<auth_id>',
  authToken: '<auth_token>'
});
   
var client = new plivo.Client('<auth_id>', '<auth_token>');

Access resources

Legacy Latest 
p.send_message(params, function(status, response) {
console.log('Status: ', status);
console.log('API Response:\n', response);
});
});
   
client.messages.create(params).then(function(response) {
    console.log(response);
}, function(err) {
    console.error(err);
});

Send a message

Legacy Latest 
var plivo = require('plivo');
var p = plivo.RestAPI({
    authId: '<auth_id>',
    authToken: '<auth_token>'
});

var params = {
    'src': '+12025551212',
    'dst': '+12025552323 ',
    'text': 'Hello, this is a sample text',
    'url': 'https://<yourdomain>.com/report/',
    'method': 'GET'
};

p.send_message(params, function(status, response) {
    console.log('API Response:\n', response);
});
   
var plivo = require('plivo');
(function main() {
    'use strict';
    var client = new plivo.Client('<auth_id>', '<auth_token>');
    client.messages.create({
        src: "+12025551212",
        dst: "+12025552323",
        text: "Hello, this is a sample text",
        url: "https://<yourdomain>.com/sms_status/"
    }).then(function(response) {
        console.log(response);
    });
})();

Retrieve a message

Legacy Latest 
var plivo = require('plivo');
var p = plivo.RestAPI({
    authId: '<auth_id>',
    authToken: '<auth_token>'
});

var params = {
    'record_id': '<your_message_uuid>'
};

p.get_message(params, function(status, response) {
    console.log('Status: ', status);
    console.log('API Response:\n', response);
    console.log('Units:', response['units']);
    console.log('Status:', response['message_state']);
});
   
var plivo = require('plivo');

(function main() {
    'use strict';
    var client = new plivo.Client('<auth_id>', '<auth_token>');
    client.messages.get('<your_message_uuid>', ).then(function(response) {
        console.log(response);
    }, );
})();

List all messages

Legacy Latest 
var plivo = require('plivo');
var p = plivo.RestAPI({
    authId: '<auth_id>',
    authToken: '<auth_token>'
});

var params = {};
p.get_messages(params, function(status, response) {
    console.log('Status: ', status);
    console.log('API Response:\n', response);
});

var params1 = {
    'limit': '5',
    'offset': '0'
};
p.get_messages(params1, function(status, response) {
    console.log('Status: ', status);
});
   
var plivo = require('plivo');

(function main() {
    'use strict';
    var client = new plivo.Client('<auth_id>', '<auth_token>');
    client.messages.list({
        limit: 5,
        offset: 0,
    }).then(function(response) {
        console.log(response);
    }, );
})();