Obtain Transaction Status Results

This page explains how to retrieve transction status results for anonymous SMS sessions created with the Number Masking API.

Contents of this page:

Set up a Transaction Callback Service

To be notified when end users are interacting using your anonymous session and to view the contents of messages exchanged between them, you must set up a transaction callback service.

Requirements

  • Private URI: Your service must be able to receive notifications as HTTP requests from TeleSign on a private URI. Send your TeleSign contact this private URI.
  • Process JSON: Process the JSON payload of these notifications, as described in the Notification Payload section below.
  • Receipt Confirmation: Whenever the service successfully receives a notification from TeleSign, provide us an HTTP 200 OK response to confirm.

Retries

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.

Notification Payload

When end users start transacting in an anonymous SMS session, each message exchanged between them is pushed to your transaction callback service. Notifications from the service have a JSON payload with the following properties:

Notification Schema
JSON
object
submit_timestamp
string

The date and time that the end user’s message was sent.

1 validation
from_phone_number
string

The originating end user’s phone number, including the country code.

1 validation
mo_message
string

The content of the end user’s message that this notification is for.

1 validation
mo_reference_id
string

Unique, 32-digit hex value used to identify the end user’s message that this notification is for.

1 validation
session_reference_id
string

Unqiue 32-digit hex value identifying the anonymous session that the message is associated with.

1 validation
to_phone_number
string
1 validation

Example

The following is an example of what the notification payload looks like.

Notification Payload
JSON
{
  "submit_timestamp": "2018-02-12T14:57:11.765723",
  "from_phone_number": "15551234",
  "mo_message": "I am standing at the corner wearing a blue shirt",
  "mo_reference_id": "SA9WUKGP3TGRCQSRMS78QV5M5REKQ98N",
  "session_reference_id": "B5862A14363C016C8832D53625270015",
  "to_phone_number": "15554567"
}

Next Steps

Check out these related pages: