SMS API - Tutorial: 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);
package com.telesign.example.messaging;

import com.telesign.MessagingClient;
import com.telesign.RestClient;

public class SendMessage {

    public static void main(String[] args) {

        String customerId = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890";
        String apiKey = "EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw==";

        String phoneNumber = "Your test phone number with no special characters or spaces.";
        String message = "You're scheduled for a dentist appointment at 2:30PM.";
        String messageType = "ARN";
        String restEndpoint = "https://rest-ww.telesign.com";
          
        try {
            MessagingClient messagingClient = new MessagingClient(customerId, apiKey, restEndpoint);
            RestClient.TelesignResponse telesignResponse = messagingClient.message(phoneNumber, message, messageType, null);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
from __future__ import print_function
from telesign.messaging import MessagingClient

customer_id = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890"
api_key = "EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=="

phone_number = "Your test phone number with no special characters or spaces."
message = "You're scheduled for a dentist appointment at 2:30PM."
message_type = "ARN"

messaging = MessagingClient(customer_id, api_key, rest_endpoint="https://rest-ww.telesign.com")
response = messaging.message(phone_number, message, message_type)
require 'telesign'

customer_id = 'FFFFFFFF-EEEE-DDDD-1234-AB1234567890'
api_key = 'EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=='

phone_number = 'Your test phone number with no special characters or spaces.'
message = 'You\'re scheduled for a dentist appointment at 2:30PM.'
message_type = 'ARN'

messaging_client = Telesign::MessagingClient.new(customer_id, api_key, rest_endpoint: 'https://rest-ww.telesign.com')
response = messaging_client.message(phone_number, message, message_type)
<?php
require __DIR__ . "/../../vendor/autoload.php";
use telesign\sdk\messaging\MessagingClient;
$customer_id = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890";
$api_key = "EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw==";
$phone_number = "Your test phone number with no special characters or spaces.";
$message = "You're scheduled for a dentist appointment at 2:30PM.";
$message_type = "ARN";
$messaging = new MessagingClient($customer_id, $api_key, $rest_endpoint = "https://rest-ww.telesign.com");
$response = $messaging->message($phone_number, $message, $message_type);
using System;

namespace Telesign.Example.Messaging
{
    class SendMessage
    {
        static void Main(string[] args)
        {
            string customerId = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890";
            string apiKey = "EXAMPLETE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw==";

            string phoneNumber = "Your test phone number with no special characters or spaces.";

            string message = "You're scheduled for a dentist appointment at 2:30PM.";
            string messageType = "ARN";

            try
            {
                MessagingClient messagingClient = new MessagingClient(customerId, apiKey, restEndpoint: "https://rest-ww.telesign.com");
                RestClient.TelesignResponse telesignResponse = messagingClient.Message(phoneNumber, message, messageType);
            }
            catch (Exception e)
            {
                Console.WriteLine(e);
            }

            Console.WriteLine("Press any key to quit.");
            Console.ReadKey();
        }
    }
}
curl -X POST https://rest-ww.telesign.com/v1/messaging \
-d phone_number=XXXXXXXX \
-d message="You have a dentist appointment at 2:15pm" \
-d message_type="ARN" \
-u "CUSTOMER_ID":"API_KEY"

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

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 - Download the SDK from TeleSign’s GitHub repository for your selected language:
  • 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 (see Requirements above).
  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:
npm install telesignsdk -save
compile files('path/to/jar/telesignenterprise-(insert latest version).jar')
<dependency>
    <groupId>com.telesign</groupId>
    <artifactId>telesign</artifactId>
    <version>[current_version]</version>
</dependency>
# From a terminal run:
pip install telesign

shell Ruby

From a terminal run:

gem install telesign

# From a terminal run:
composer require telesign/telesign
```shell C#
$ nuget pack .\Path\To\csharp_telesign_enterprise\TelesignEnterprise\TelesignEnterprise.csproj
$ Install-Package .\Path\To\TelesignEnterprise-(insert latest version).nupkg

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');
package com.telesign.example.messaging;

import com.telesign.MessagingClient;
import com.telesign.RestClient;
from __future__ import print_function
from telesign.messaging import MessagingClient

#If you are working with a version of Python 3, you do not need the first import #statement (`from __future__ import print_function`).
require 'telesign'
<?php
require __DIR__ . "/../../vendor/autoload.php";
use telesign\sdk\messaging\MessagingClient;
using System;
  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";
public class SendMessage {

    public static void main(String[] args) {

        String customerId = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890";
        String apiKey = "EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw==";

        String phoneNumber = "Your test phone number with no special characters or spaces.";
        String message = "You're scheduled for a dentist appointment at 2:30PM.";
        String messageType = "ARN";
        String restEndpoint = "https://rest-ww.telesign.com";
customer_id = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890"
api_key = "EXAMPLE----TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw=="

phone_number = "The phone number you want to send an SMS to goes here."
message = "You're scheduled for a dentist appointment at 2:30PM."
message_type = "ARN"
customer_id = 'Your TeleSign Customer ID goes here.'
secret_key = 'Your TeleSign API key goes here.'

phone_number = 'The phone number you want to send an SMS to goes here.'
message = 'You\'re scheduled for a dentist appointment at 2:30PM.'
message_type = 'ARN'
$customer_id = "Your TeleSign Customer ID goes here.";
$secret_key = "Your TeleSign API key goes here.";
$phone_number = "The phone number you want to send an SMS to goes here.";
$message = "You're scheduled for a dentist appointment at 2:30PM.";
$message_type = "ARN";
namespace Telesign.Example.Messaging
{
    class SendMessage
    {
        static void Main(string[] args)
        {
            string customerId = "FFFFFFFF-EEEE-DDDD-1234-AB1234567890";
            string apiKey = "EXAMPLETE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw==";

            string phoneNumber = "Your test phone number with no special characters or spaces.";

            string message = "You're scheduled for a dentist appointment at 2:30PM.";
            string 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);
try {
            MessagingClient messagingClient = new MessagingClient(customerId, apiKey, restEndpoint);
            RestClient.TelesignResponse telesignResponse = messagingClient.message(phoneNumber, message, messageType, null);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}
messaging = MessagingClient(customer_id, api_key, rest_endpoint="https://rest-ww.telesign.com")
response = messaging.message(phone_number, message, message_type)
messaging_client = Telesign::MessagingClient.new(customer_id, api_key, rest_endpoint: 'https://rest-ww.telesign.com')
response = messaging_client.message(phone_number, message, message_type)
$messaging = new MessagingClient($customer_id, $api_key, $rest_endpoint = "https://rest-ww.telesign.com");
$response = $messaging->message($phone_number, $message, $message_type);
try
            {
                MessagingClient messagingClient = new MessagingClient(customerId, apiKey, restEndpoint: "https://rest-ww.telesign.com");
                RestClient.TelesignResponse telesignResponse = messagingClient.Message(phoneNumber, message, messageType);
            }
            catch (Exception e)
            {
                Console.WriteLine(e);
            }

            Console.WriteLine("Press any key to quit.");
            Console.ReadKey();
        }
    }
}
  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:


Did this page help you?