README.md

TeleSign Node.js SDK Examples

How to Run

1. Edit file and replace values for API Key, Customer ID, and mobile_number
2. Run the file via : node filename.js

Example: You can run the 1_send_message.js with the following command

node examples/appverify/1_send_message.js

Sample Code

After installing the SDK, begin by including the telesign SDK and declaring customerId, apiKey, restEndpoint, and timeout variables.

    var TeleSignSDK = require('telesignsdk');
    var customerId = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890"; // find in portal.telesign.com
    var apiKey = "EXAMPLE----TE8sTgg45yusumoN4BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw==";
    var restEndpoint = "https://rest-api.telesign.com";
    var timeout = 10*1000; // 10 secs

    var telesign = new TeleSignSDK( customerId,
                                    apiKey,
                                    restEndpoint,
                                    timeout // optional
                                  );

Example: Messaging (SMS)

Here is an example to send an SMS

    var phoneNumber = "phone_number"; // Your end user’s phone number, as a string of digits without spaces or
    // punctuation, beginning with the country dialing code (for example, “1” for North America)
    var message = "You're scheduled for a dentist appointment at 2:30PM.";
    var messageType = "ARN"; // ARN = Alerts, Reminders, and Notifications; OTP = One time password; MKT = Marketing
    var referenceId = null; // need this to check status later

    telesign.sms.message(function(err, reply){
            if(err){
                console.log("Error: Could not reach TeleSign's servers");
                console.error(err); // network failure likely cause for error
            }
            else{
                console.log("YAY!, the SMS message is being sent now by TeleSign!");
                console.log(reply);
                referenceId=reply.reference_id; // save the reference_id to check status of the message
            }
        },
        phoneNumber,
        message,
        messageType
    );

Here is how to check the status of your SMS

    telesign.sms.status(function(err, statusResponse) {

        if(err) {
            console.error(err); // network failure likely cause for error
        }
        else{
            console.log(statusResponse);
        }
    }, referenceId); // notice, referenceId was returned when the message was sent

Example: Voice Message

The following code will make a phone call and wait 30 seconds and then check for status the phone call

    var voice = new TeleSignSDK.VoiceClient(customerID, apiKeys, restEndpoint, timeout);
    var language = "en-GB" // British English - full list avail in REST docs ai developer.telesign.com
    var callbackURL = "http://www.test.com/callback";
    var accountLifecycleEvent = "create"; // see options in API docs at developer.telesign.com

    var referenceId = null; // To be used to get call status later

    telesign.voice.call(function(err, callResponse) {
        if(err){
            console.log("Error: Could not reach TeleSign's servers");
            console.error(err); // network failure likely cause for error
        }
        else{
            console.log("YAY!, TeleSign is attempting to call the number provided!");
            console.log(callResponse);
            reference_id=callResponse.reference_id; // save the reference_id to check status of the message
        }
    },  phoneNumber,
        message,
        messageType,
        voice, // optional param - if null, it will select US English
        callbackURL, // optional param
        accountLifecycleEvent); // optional param

Example: PhoneID (Metadata on phone number for fraud risk analysis)

The following code will retreive metadata on a phone number using the PhoneID API

    var phoneid = new TeleSignSDK.PhoneIDClient(customerID, apiKeys, restEndpoint, timeout);
    var accountLifecycleEvent = "create"; // see options in API docs at developer.telesign.com
    var originatingIP = "1.0.0.1";

    telesign.phoneid.phoneID(function(err, phoneidResponse) {
        console.log(phoneidResponse);
    },
    phoneNumber,
    accountLifecycleEvent, // optional param
    originatingIP); // optional param

Example: Score API (Metadata on phone number for fraud risk analysis)

    var score = new TeleSignSDK.ScoreClient(customerID, apiKeys, restEndpoint, 10*1000);
    var accountLifecycleEvent = "create";

    telesign.score.score(function(err, response) {
        console.log(response);
    },  phoneNumber,
        accountLifecycleEvent
        // originatingIP,   // optional param
        // deviceId,       // optional param
        // accountId       // optional param
    );