Transaction Callback Service

This page explains how to set up and use a Transaction Callback Service to receive status updates about your requests to some Telesign services. This architecture is only supported for the Messaging, SMS, SMS Verify, Voice, Voice Verify, and Inbound SMS products.

Key features

  • Controlled by you: This is a web service that you set up and control.
  • Compound queries: A Transaction Callback Service notification can be used to learn the status of multiple transactions at the same time, unlike an API request to get status.
  • Efficient: Makes more efficient use of network system resources (for example, bandwidth or server load) when making compound queries. This may be a significant advantage if you have a high volume of transactions.

Service setup

  1. Create a web service with a private URL for receiving callback notifications from Telesign. Notifications are sent as web requests to this service.

General requirements

  • Base URL: Any URL that you control.
  • Protocols: https
  • Ports: 443 (The default standard port for HTTPS)
  • Authentication: Authentication is optional, but recommended. See Authentication for more details.
  • Accepts: application/json
  • Responds With: application/json

📘

NOTE:

For mission-critical applications, Telesign recommends that you provide redundancy by implementing two URLs instead of one.

Request body

Note that the schema for a callback varies depending on which Telesign service it comes from. Below is the general schema; the documentation for each product explains any variations from this schema.

ParameterTypeDescriptionExampleRequired?
statusobjectContains properties related to the request status.
status.updated_onstringAn RFC 3339 timestamp indicating when the delivery status was last updated.2020-08-27T17:28:49.559307Z
status.codeintegerA numeric code indicating the status of the transaction.200
status.descriptionstringText describing the delivery status of the transaction.Delivered to handset
submit_timestampstringAn ISO 8601 UTC timestamp indicating when the request was received.2016-01-01T01:01:01.010101Z
errorsarray of objectsContains an object for each error that occurs, describing that error.
errors.{}objectContains properties related to an error that occurred during processing of the request.
errors.{}.codeintegerA numeric code specifying which error occurred.-10001
errors.{}.descriptionstringText describing the error that occurred.Invalid Request: PhoneNumber Parameter
reference_idstringA unique, 32-digit hex value randomly generated by Telesign to identify this request.35C8B5D509BC10689196FED2AD551B8A

Example notification

This example is for an SMS Verify transaction. Product-specific parameters that are not part of the general schema are highlighted in the code.

Example Callback Notification

POST /callback_endpoint HTTP/1.1
Host: your-callback-url.com
{ 
  "status": { 
     "updated_on": "2016-07-08T20:52:46.417428Z", 
     "code": 200,
     description": "Delivered to handset" 
   }, 
   "submit_timestamp": "2016-07-08T20:52:41.203000Z", 
   "errors": [], 
   "verify": { 
     "code_state": "VALID", 
     "code_entered": null 
   }, 
   "sub_resource": "sms", 
   "reference_id": "2557312299CC1304904080F4BE17BFB4" 
}
  1. If you have a self-service account, enter your callback URL in the Settings section of the portal for each product. If you have a full-service account, send your callback URL to Telesign Customer Support.
  2. Allow up to one business day for setup to be completed.
  3. You will receive callback notifications after both of the following occur:
    • A transaction completes.
    • Telesign determines the final status of the transaction (refer to the section Transaction Status Codes on the Codes, Languages, and Timezones page for a list of status codes that may be returned).
  4. If Telesign is unable to deliver your callback notification on the first attempt, the Telesign server tries again. If the second attempt fails, the server makes a third and final attempt.

Here is a diagram of what the notification flow looks like, using SMS Verify for the example. The flow is similar for other products.

561561

Authentication

Telesign sends callbacks with headers that can be used for Digest authentication. Just as you must digitally sign all your requests to Telesign when using Digest authentication, Telesign signs all of its requests to your Transaction Callback Service. The details of the signature are slightly different however from those used when sending a request to Telesign.

How to authenticate

To authenticate the callback, follow these steps:

  1. Make your Customer ID and API Key accessible to your integration code. For help finding these items, see the support article How do I find my Customer ID and API Key?.
  • Example Customer ID: FFFFFFFF-EEEE-DDDD-1234-AB1234567890
  • Example API Key: TE8sTgg45yusumoN6BYsBVkh+yRJ5czgsnCehZaOYldPJdmFh6NeX8kunZ2zU1YWaUw/0wV6xfw==
  1. Save the value of one of two headers from the request from Telesign (both are always included):
  • Authorization
  • x-ts-authorization
  1. Convert the body of the request to a string (decode using UTF-8 for a JSON payload) and save it to use in a later step. This is your string-to-sign.

📘

NOTE:

Unlike when you make a request to Telesign, this signature only includes the body of the message.

  1. Encode your string-to-sign using UTF-8 encoding.
  2. Base-64 decode your API Key.
  3. Save the hashing method ("auth_method") you are using to authenticate. Currently only "HMAC-SHA256" is supported. It can be either upper-cased or lower-cased.
  4. Create a new HMAC object using your decoded API Key, your string-to-sign, and the same "auth_method" string you saved earlier. Here's an example of how you might do that in Python:
hmac_obj = hmac.new(decoded_api_key, encoded_string_to_sign, digestmod=auth_method)
  1. Create a digest from this HMAC object.
  2. Decode this digest with UTF-8 encoding.
  3. Based-64 encode the decoded digest. This is your expected signature.
  4. Parse the signature from the Authorization or x-ts-authorization header value you saved earlier. The header value has the format "TSA" + a space + Customer ID + ":" + signature. Split the value into two parts using the space (" ") character. Save the second part.
  5. Split that string again using the ":" character. Save the second part. This is the signature.
  6. Compare the signature to the expected signature. Here is an example of how to do that using Python:
hmac.compare_digest(signature, expected_signature)

Sample code

Feel free to copy this code for authenticating requests from Telesign and adapt it to your integration: