Send an SMS Message

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-ww.telesign.com"; 
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.";
const message = "You're scheduled for a dentist appointment at 2:30PM.";
const messageType = "ARN";

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);

This tutorial describes how to use TeleSign SDKs to send an SMS message. You can use this to send alerts, reminders, and notifications for a variety of situations such as:

  • Weather updates
  • Status of a package being delivered
  • Reminder for appointments or events
  • A notification about a special offer or promotion
  • Notifications about a change in status to an account, for example to let someone know their password changed

This tutorial includes the following sections:

Requirements

For this tutorial, the following is required:

  • customer ID - obtain from your account by logging in to teleportal.telesign.com
  • API key - obtain from your account by logging in to teleportal.telesign.com
  • SDK - Access to TeleSign’s GitHub repository for your selected language (you must request access from your Technical Account Manager, or the links will not work):
  • Language Version
    • Node.js - 6+
    • Java - 7+
    • Python - 2.7+
    • Ruby - 2+
    • PHP - 5.6+
    • C# - 4.5+

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 an SMS Message

This section explains how to send an SMS message using the SMS API. The sample code provided earlier is 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 create a MessagingClient object and use the message method to send an SMS containing the message you specify with the message type you specify. The steps below explain the code sample with more detail.

  1. Begin by adding statements for including the appropriate part of the TeleSign SDK and any additional language specific functions you may need.
var TeleSignSDK = require('telesignsdk');
  1. Insert values for each of the items from customer_id through to message_type. (Through to restEndpoint for Java.)
    • customer_id (customerId for Java/C#) - Your TeleSign assigned customer ID, available in your account information in the portal.
    • api_key (apiKey for Java/C#) - Your TeleSign assigned API key, available in your account information in the portal.
    • phone_number (phoneNumber for Java/C#) - 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 - Provide your message as a string.
    • message_type (messageType for Java/C#) - Label the type of message you are sending. You have three choices: OTP - One time passwords, ARN - Alerts, reminders, and notifications, and MKT - Marketing traffic.
    • restEndpoint - (For Java, you are defining a string with the value of the base endpoint.)
const customerId = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890"; // Todo: find in teleportal.telesign.com
const apiKey = "EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=="; // Todo: find in portal.telesign.com
const rest_endpoint = "https://rest-ww.telesign.com"; 
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.";
const message = "You're scheduled for a dentist appointment at 2:30PM.";
const messageType = "ARN";
  1. Instantiate a MessagingClient object containing your customer ID and API key. Send an SMS to the phone number containing the message and message type you provided. Store the response in response. For node.js, you open a console log and create a messageCallback function to handle the results coming back from the messaging client. Then, you create the messaging client and call the messageCallback function.
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);
  1. You should receive an SMS message containing the message you specified at the phone number you specified. You can examine the result of your phone call by looking at the contents of ‘response’ for Python, Ruby, and PHP, or telesignResponse for Java and C#.

Code it Without the SDK

TeleSign’s SDKs make implementation a lot easier because authentication is handled for you. If you want to write all your own code, you must handle authentication yourself. You’ll need the following documents: