TeleSign

Info:	For more information, visit the TeleSign web site. For the latest source code, visit the TeleSign github repository.
Author:	Telesign Corp.

TeleSign Web Services: Java SDK

TeleSign Web Services conform to the REST Web Service Design Model. Services are exposed as URI-addressable resources through the set of RESTful procedures in our TeleSign REST API.

The TeleSign Java SDK is a Java library that provides an interface to TeleSign Web Services.

Authentication

You will need a Customer ID and API Key in order to use TeleSign’s REST API. If you are already a customer and need an API Key, you can generate one in the Client Portal. If you are not a customer and would like to get an API Key, please contact support@telesign.com

You supply your credentials to the API by passing them in during class initialization.

>>>
  String customer_id = "CUSTOMER_ID_GOES_HERE";
  String secret_key = "SECRECT_KEY_GOES_HERE";
  Verify verify = new Verify(customer_id, secret_key);

The Java Classes

With just two classes, telesign.api abstracts much of the complexity of the TeleSign REST API.

Java Class	Description
com.telesign.phoneid.PhoneId	The PhoneId class exposes three services that each provide information about a specified phone number. standard Retrieves the standard set of details about the specified phone number. This includes the type of phone (e.g., land line or mobile), and it's approximate geographic location. score Retrieves a score for the specified phone number. This ranks the phone number's "risk level" on a scale from 0 to 1000, so you can code your web application to handle particular use cases (e.g., to stop things like chargebacks, identity theft, fraud, and spam). contact In addition to the information retrieved by standard, this service provides the Name & Address associated with the specified phone number. live In addition to the information retrieved by standard, this service provides actionable data associated with the specified phone number.
com.telesign.verify.Verify	The Verify class exposes two services for sending users a verification token (a three to five-digit number). You can use this mechanism to simply test whether you can reach users at the phone number they supplied, or you can have them use the token to authenticate themselves with your web application. In addition, this class also exposes a service that allows you to confirm the result of the authentication. You can use this verification factor in combination with username & password to provide two-factor authentication for higher security. call Calls the specified phone number, and using speech synthesis—speaks the verification code to the user. sms Send a text message containing the verification code to the specified phone number (supported for mobile phones only). status Retrieves the verification result. You make this call in your web application after users complete the authentication transaction (using either a call or sms).

Java Code Example: To Verify a Call

Here's a basic code example.

>>>
  String customer_id = "CUSTOMER_ID_GOES_HERE";
  String secret_key = "SECRECT_KEY_GOES_HERE";
  Verify verify = new Verify(customer_id, secret_key);
  VerifyResponse ret = verify.call("13103409700");

{"reference_id":"013C8CC050DF040BE4D412D700002101","resource_uri":"/v1/verify/013C8CC050DF040BE4D412D700002101","sub_resource":"call","errors":[],"status":{"updated_on":"2013-01-30T18:37:59.444100Z","code":103,"description":"Call in progress"},"verify":{"code_state":"UNKNOWN","code_entered":""}}

Builds

Build the jar using ant jar. Generated jar can be found in the build/jar/ directory.

Documentation

Documentation can be generated by running ant doc. Generated documentation can be found in the doc/build/ directory.

Detailed documentation for TeleSign™ REST APIs is available in the Client Portal

Testing

You will need junit installed to generate run the tests. You can execute the test by running ant junit.

The easiest way to run the tests is to install junit Tests are located in the test/ directory.

Support and Feedback

For more information about the Phone Verify and PhoneID Standard services, please contact your TeleSign representative:

Email: support@telesign.com