Want to provide feedback?

Write to docs@telesign.com.

Get Started with the Completion API

The Completion API is a lightweight API that is ideal for submitting completion rate information on high volumes of transactions. Completion rate information for a transaction is a way of telling TeleSign that you received a voice or SMS message, indicating that the transaction was completed. Providing this information allows TeleSign to monitor route quality and provide the fastest, most high quality routes for your messages.

The Completion API allows you to inform TeleSign that a transaction completed without providing a verification code, which is required when using the Get Status API to provide completion data. Unlike the Get Status API, responses from the Completion API provide information about completion status only. If you want detailed status information about your transactions, you should continue using the Get Status API.

Contents of This Page:

General Requirements

  • Base URL: rest-ww.telesign.com
  • Protocols: https
  • Authentication: Basic (easiest to implement) or Digest
  • Encoding: Accepts only UTF-8 unicode characters as inputs.
  • Responds With: application/json

Send Completion Data

For details about how to send completion data, refer to the Send Completion Data page.

If you want to review available parameters and responses for the Completion API, refer to the PUT /v1/verify/completion page.

Completion API Examples

PUT

A PUT request to the Completion API looks like this:

Example Request
PUT /v1/verify/completion/0123456789ABCDEF0123456789ABCDEF HTTP/1.1
Authorization: Basic 12345678-9ABC-DEF0-1234-56789ABCDEF0:Uak4fcLTTH/Tv8c/Q6QMwl5t4ck= 
Host: rest-ww.telesign.com

The body of the response from the Completion API looks like this:

Example Response
{
  "reference_id": "ABCDEF0123456789ABCDEF0123456789",
  "sub_resource": "sms|voice|push|two_way_sms",
  "errors":[],
  "status": {
     "code": 1900,
     "updated_on": "2014-10-14T18:07:26.078515Z",
     "description": "Verify completion successfully recorded"
  },
}

Next Steps

This section offers some suggestions for next steps to take.