var TeleSignSDK = require('telesignsdk');

const customerId = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890"; // Todo: find in portal.telesign.com
const apiKey = "EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=="; // Todo: find in portal.telesign.com
const rest_endpoint = "https://rest-api.telesign.com"; // Todo: Enterprise customer, change this!
const timeout = 10*1000; // 10 secs

const client = new TeleSignSDK( customerId,
    apiKey,
    rest_endpoint,
    timeout // optional
    // userAgent
);

const phoneNumber = "phone_number";
const messageType = "ARN";
const verifyCode = "32658";
const message = "Your code is " + verifyCode;

console.log("## MessagingClient.message ##");

function messageCallback(error, responseBody) {
    if (error === null) {
        console.log(`Messaging response for messaging phone number: ${phoneNumber}` +
            ` => code: ${responseBody['status']['code']}` +
            `, description: ${responseBody['status']['description']}`);
    } else {
        console.error("Unable to send message. " + error);
    }
}

client.sms.message(messageCallback, phoneNumber, message, messageType);

function prompt(question, callback) {
    const stdin = process.stdin,
        stdout = process.stdout;

    stdin.resume();
    stdout.write(question);

    stdin.once('data', function (data) {
        callback(data.toString().trim());
    });
}

prompt('Enter the verification code received:\n', function (input) {
    if (input === verifyCode) {
        console.log('Your code is correct.');
    } else {
        console.log('Your code is incorrect. input: ' + input + ", code: " + verifyCode);
    }
    process.exit();
});

This tutorial describes how to use TeleSign SDKs to send an SMS message with a verification code.

This tutorial includes the following sections:

Requirements

For this tutorial, the following is required:

  • customer ID - obtain from your account by logging in to portal.telesign.com (referred to as customer_id/customerId in this document)
  • API key - obtain from your account by logging in to portal.telesign.com (referred to as api_key/apiKey in this document)
  • SDK - Access to TeleSign’s GitHub repository for your selected language:
  • Node.js
  • Java
  • Python
  • Ruby
  • PHP
  • C#
  • Language Version
  • Node.js - 6+
  • Java - 7+
  • Python - 2.7+
  • Ruby - 2+
  • PHP - 5.6+
  • C# - 4.5+
  • Verified Phone Number - To use TeleSign’s free trial, you must verify a phone number before using it.
NOTE:

If you do not have a customer ID, sign up for TeleSign’s Free Trial.

Install the SDK

  1. Obtain your customer ID and API key.
  2. Log in to GitHub and choose the SDK in your preferred language:
  3. Download or clone the repository. If you download it, extract the repository from the .ZIP file.
  4. To install the SDK for use, do the following:

Send SMS Message with a Verification Code

This section explains how to send an SMS message containing a verification code using the Messaging API. The sample code is provided as a single block first, and then broken out into pieces and explained below.

In this code sample, you provide your customer ID and API key to authenticate yourself with TeleSign. Then you generate a verification code and insert it into the text of your message. You create a MessagingClient object and use the message method to send an SMS containing your message and verification code. The steps below explain the code sample with more detail.

  1. Begin by adding the appropriate import statements.
var TeleSignSDK = require('telesignsdk');
  1. Insert values for each of the items from customer_id through to message_type.
    • customer_id/customerId - Your TeleSign assigned customer ID, available in your account information in the portal.
    • api_key/apiKey - Your TeleSign assigned API key, available in your account information in the portal.
    • phone_number/phoneNumber - The phone number you want to use for the example. If you are doing a free trial, the phone number must be verified (verifying the number is not required if you are a paying customer). When you provide the number, it should be a string with no spaces or special characters. Include the complete number. For example, if you are doing a phone number for America, you would include the country code and the area code with the number. For example 16505551212.
    • message_type/messageType - Label the type of message you are sending. You have three choices (each is a string): OTP - One time passwords, ARN - Alerts, reminders, and notifications, and MKT - Marketing traffic

For Node.js, you choose a verification code rather than generating a random one.

const customerId = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890"; // Todo: find in portal.telesign.com
const apiKey = "EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=="; // Todo: find in portal.telesign.com
const rest_endpoint = "https://rest-api.telesign.com"; // Todo: Enterprise customer, change this!
const timeout = 10*1000; // 10 secs

const client = new TeleSignSDK( customerId,
    apiKey,
    rest_endpoint,
    timeout // optional
    // userAgent
);

const phoneNumber = "Your test phone number with no special characters or spaces goes here.";
const messageType = "ARN";
const verifyCode = "32658";
const message = "Your code is " + verifyCode;
  1. Generate a random number to use as a verification code. For SMS verification codes, TeleSign recommends limiting the code to five to seven digits maximum. Here you are generating a random five digit number. For Node.js, you do not generate a random code.
//Step does not apply for Node.js example
  1. Insert your verification code into the text of your message. For the node.js example, use this step to set up your console and create a function that will be used to check the results of sending an end user an SMS message with a verification code.
console.log("## MessagingClient.message ##");

function messageCallback(error, responseBody) {
    if (error === null) {
        console.log(`Messaging response for messaging phone number: ${phoneNumber}` +
            ` => code: ${responseBody['status']['code']}` +
            `, description: ${responseBody['status']['description']}`);
    } else {
        console.error("Unable to send message. " + error);
    }
}
  1. Instantiate a MessagingClient object containing your customer_id/customerId and api_key/apiKey. Send an SMS to the phone number containing the message and message type you provided. Store the response in response.
client.sms.message(messageCallback, phoneNumber, message, messageType);
  1. Prompt for the verification code and enter the code you receive via SMS message. You probably will set up the way you prompt the person differently, this is just to show you how it works.
function prompt(question, callback) {
    const stdin = process.stdin,
        stdout = process.stdout;

    stdin.resume();
    stdout.write(question);

    stdin.once('data', function (data) {
        callback(data.toString().trim());
    });
}
  1. Check the code entered by the end user against the verification code you generated.
prompt('Enter the verification code received:\n', function (input) {
    if (input === verifyCode) {
        console.log('Your code is correct.');
    } else {
        console.log('Your code is incorrect. input: ' + input + ", code: " + verifyCode);
    }
    process.exit();
});
  1. If everything works, you should be able to generate and send a verification code via SMS message using this code sample. When you receive the verification code, you are prompted to enter it. If you enter it correctly, you get a message back on your computer saying the code is correct. Otherwise you get a message saying the code is incorrect.

Code it Without the SDK

If you want to write all your own code, you will need to handle authentication yourself. You’ll need the following documents: