Status Callback (POST)

A transaction callback looks like the JSON object displayed here.

object
reference_id
string

A 32-digit hex value used to identify the web service request. The value is unique to each web service request, is randomly generated by TeleSign, and is returned in the response message immediately following the web service request.

external_id
string

You can mark each of your requests with your own identifier. This identifier is returned as part of a delivery receipt (DLR) callback.

voice
object
user_input
string

If the end user answers a voice call and presses on the keypad after the message plays, you will see this parameter and it will display whatever the end user pressed. If the end user presses multiple digits on the keypad, only the last digit is returned. Additionally, if the end user presses the keypad before the message completes, that information will not be recorded at all.

caller_id
string

If you chose a caller id, this parameter comes back in the response and lists the caller_id that you chose.

status
object
code
string

This code describes the status of your transaction. You can use this to programmatically respond. You are returned two types of codes, either status codes or error codes.

description
string

A text description of the status code.

updated_on
string

This is a timestamp showing when your transaction status was updated last.