Get Transaction Status

This page explains how to retrieve transaction status for TeleSign SMS, SMS Verify, or Voice Verify. If you implemented SMS Verify or Voice Verify so that you choose your own verification codes, you need to go to the Get Status with Completion Data page.

The fastest way to get started is to try the Get Status API Explorer below. You need a reference ID from a transaction from one of the supported products listed above. If you have not made a request and saved the reference ID, navigate to one of the pages below and send your first transaction:

NOTE:

If you expect a high volume of service requests, TeleSign recommends setting up the Transaction Callback Service instead. Read about setting up this service and available features on the Transaction Callback Service page.

Try It

Get Status API Explorer
NOTE: When using the Get Status 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 Get Status 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.

Steps

  1. Click the Auth [basic] tab.
  2. In the Username field, put your Customer ID.
  3. In the Password field, put your API key.
  4. Click the Variables tab.
  5. In the reference_id field, enter the reference ID for the transaction you want to retrieve the status for. (If you do not have a reference ID, go to the Send a Voice Message with a Verification Code page or the Send an SMS with a Verification Code page. Get the reference ID from the response after you send a request. (See the API reference page - GET /v1/verify/{reference_id}.)
  6. Click Send.
  7. If you want the code for your request, click the Code Generation tab and use the Language and Library drop-downs to choose the language you want your code snippet in. The Language drop-down shows you what languages you can generate code in, and the Library drop-down shows you what libraries you could use to create the code.

Congratulations! You’ve retrieved status information about a transaction and generated a code snippet.

You can see more about available parameters for requests as well as response information on the GET /v1/verify/reference_id) page.

After a transaction occurs, you have 12 hours to obtain status results for the transaction. TeleSign recommends that you wait 3-5 minutes after a transaction occurs to send a Get Status request about the transaction.

Example

Request
HTTPS
GET https://rest-ww.telesign.com/v1/verify/0123456789ABCDEF0123456789ABCDEF HTTP/1.1
Accept-Encoding: gzip,deflate
Authorization: Basic 12345678-9ABC-DEF0-1234-56789ABCDEF0:Uak4fcLTTH/Tv8c/Q6QMwl5t4ck=
User-Agent: CERN-LineMode/2.15 libwww/2.17b3
Host: rest-ww.telesign.com
Response
HTTPS
HTTP/1.1 200 OK
Date: Wed, 29 May 2013 00:09:08 UTC
Server: CERN/3.0 libwww/2.17
Content-Length: 314
Allow: GET,POST,HEAD
Content-Type: application/json
{
   "reference_id" : "ABCDEF0123456789ABCDEF0123456789",
   "sub_resource" : "sms",
   "errors": [],
   "status" : {
      "updated_on" : "2015-04-17T22:26:43.784963Z",
      "code" : 290,
      "description" : "Message in progress"
   },
   "verify" : {
      "code_state" : "UNKNOWN",
      "code_entered" : ""
   },
   "number_deactivation_status" : {
      "error_code" : "0",
      "description" : "Number Deactivation check succeeded",
      "last_deactivated" : "2015-02-02T10:41:55.464231Z"
   },
   "additional_info": {
      "code_entered": null,
      "message_parts_count" : 1
   }
}

Next Steps

Check out these related pages: