Obtain Transaction Status Results

This page describes how you can find out about the status of your request to send a voice message. You have two choices, you can do a status request to TeleSign and ask for the status of a message, or you can set up callbacks. Callbacks are better for high volumes of transactions. If you choose the callback method, TeleSign posts the status results for every transaction to a private URI that you select.

The fastest way to retrieve the status of a request is to try TeleSign’s Voice API Explorer. You will need your TeleSign credentials and the reference ID of a voice transaction. If you do not have a reference ID already, go back to the Send a Voice Message page.

Voice API Explorer
NOTE: When using the Voice 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)
Path Params
1 path param not set
reference_id
$$.env
No $$.env variables are being used in this request.

To get the status of your transaction, do the following:

  1. Click the Query tab.
  2. For the query value field across from reference_id enter the reference ID number for the transaction you want to retrieve status information about.
  3. Click the Auth [basic] tab.
  4. In the Username field, enter your customer ID.
  5. In the Password field, enter your API key.
  6. Click Send.
  7. Congratulations! You’ve just retrieved the status of the SMS request you sent.
  8. To get a code snippet, click the Code Generation tab and choose the language and library you want to use to create the code.

The rest of this page provides details about retrieving transaction status results using the Voice API or callbacks.

Voice API Information

Requests to the Voice API:

  • Can be authenticated with Basic (easiest to implement) and Digest.
  • Use https://rest-ww.telesign.com/v1/voice as the base endpoint.
  • Accept only UTF-8 encoded unicode characters as inputs.
  • Use Content-Type application/x-www-form-urlencoded in request headers.

Status Request (GET)

You can test out doing a GET status request using the Voice API Explorer above. You need your credentials, and you must have sent a voice message and retrieved the reference ID for your request from the response. If you did not already do this, go to the Send a Voce Message page.

Example of a GET Request

An example request looks like this:

GET Request Example
GET https://rest-w.telesign.com/v1/voice/B56A1234567C016489536C10F594029B HTTP/1.1
Authorization: Basic 444444A2-1F7E-11E1-B760-000000000000:lWizTxkdlfhiriwQiCE9FnM44TQ=

Here is an example of a GET response body:

GET Response Body Example
{
"reference_id": "ABCDEF0123456789ABCDEF0123456789",
"status": {
   "code": 100,
   "description": "Call answered",
   "updated_on": "2017-02-28T19:02:31Z",
   },
"voice": {
   "caller_id": "15555551212",
   "user_input": "3"
   }
}

Status Callback (POST)

Delivery results can be obtained by using the transaction callback service (ideal for high volumes of transactions). You provide TeleSign with a URL, and TeleSign posts the results of your transactions to the specified URL. The diagram shows the process flow:

Compliance

For Compliance information, please see the Voice section of the Compliance page.

Next Steps

This section offers some suggestions for next steps to take.