Want to provide feedback?

Write to docs@telesign.com.

Try the API Explorer

An API explorer is a tool that allows you to learn about an API in an interactive way. Instead of reading and then setting up cURL or implementing a request, you can use an API explorer right away to see how an API works.

TeleSign’s API explorers allow you to try out almost any of our APIs immediately, provided you have credentials (API key, customer ID) and access to the API you want to try. Additionally, when you set up a request using TeleSign’s API explorers, you can instantly get a code sample for the request in the language of your choice.

Available APIs you can try out include:

  • SMS API
  • SMS Verify API
  • Bulk SMS API
  • Anonymous SMS API
  • Voice Verify API
  • Phone Numbers API
  • PhoneID API (without add-ons)
  • Score API
  • App Verify API
  • Get Status API
  • Completion API

Read about the Explorer in these sections:

How to Use an API Explorer

This section will quickly show you how to send a request for an SMS using TeleSign’s SMS API Explorer. You must have your customer ID and API key, and have the SMS API enabled to try the explorer.

SMS API Explorer
NOTE: When using the SMS API Explorer, you will be charged your contracted rate for each transaction. The time shown in ms is not indicative of regular transmission rates, and only applies to the SMS API Explorer.
Send requests directly from the browser (CORS must be enabled)
$$.env
No $$.env variables are being used in this request.
  1. Under the Variables tab, put your customer ID in the username field and your API key in the password field.
  2. Click the Body tab. In the phone_number field enter the phone number you want to use to try out the Explorer.
  3. Click Send to see your transaction. You will be charged the standard rate for your transaction, and you are subject to all compliance rules as appropriate for your transaction.
  4. If you want you can also click Code Generation and set the drop-downs to have the API Explorer generate a code snippet for you.

Congratulations! You’ve sent your first SMS using TeleSign’s SMS API and generated your first code snippet!

Advanced Tricks for Using TeleSign API Explorers

Each TeleSign API explorer is set up for use with a specific TeleSign API. What you send in the body of a request is customizable. For ease of use, everything for a specific request is pre-populated for you. If you want to experiment you can change the settings. TeleSign recommends reviewing the reference page for an API’s endpoint (these pages begin with a verb for communicating with an HTTP API and then show part of the endpoint, for example for the SMS API, the API reference page is titled POST v1/messaging). You can review what parameters are optional and what parameters are required and add them to the API explorer to create your own request.

Let’s add something to the example from before. This time, imagine you want to add an external ID to your request. The external ID will be a custom identifier you choose. Normally, you would use this if you have a particular way you retrieve delivery receipts from SMS transactions.

SMS API
NOTE: When using the SMS API Explorer, you will be charged your contracted rate for each transaction. The time shown in ms is not indicative of regular transmission rates, and only applies to the SMS API Explorer.
Send requests directly from the browser (CORS must be enabled)
$$.env
No $$.env variables are being used in this request.

The main difference this time through will be after step 2.

  1. Under the Variables tab, put your customer ID in the username field and your API key in the password field.
  2. Click the Body tab. In the phone_number field enter the phone number you want to use to try out the Explorer.
  3. Click Add Property.
  4. In the param name field type external_id. In the param value field directly next to it type a string you want to use as a custom identifier.
  5. Click Send to see your transaction. You will be charged the standard rate for your transaction, and you are subject to all compliance rules as appropriate for your transaction.
  6. In the Body tab in the second window (window directly under the one where you entered parameter information) you can see a response showing that you added an external ID to your request.
  7. If you want you can also click Code Generation and set the drop-downs to have the API Explorer generate a code snippet for you.

On all TeleSign API explorers, you can play with what you send in your request to customize it. The easiest way to do this is review the available parameters and then construct your request in the appropriate API Explorer. You can send the request and see how it works, and you can always generate a code snippet for your request.

For most APIs, TeleSign includes an Explorer that will demonstrate the basic task being described. You can see your options for each API by going to the API Reference, clicking on the title of the API you want to learn about, and then choosing one of the tasks listed under that API. For example, if you click on SMS API, choices open up including ‘Send an SMS’ and ‘Obtain Transaction Status Results’. On each page is an API explorer demonstrating the task described by the title.

NOTE:

You cannot use an API Explorer to see PhoneID add-ons or the new Voice API.