get

/voice/{reference_id}

By passing the reference ID for a transaction in the body of your request, you can receive a response containing details about that transaction. NOTE: If you try this API out using the API Explorer, you will be billed for the transaction as you normally would.

All requests submitted for the Voice API:

  • Can be authenticated with Basic (easiest to implement) and Digest.
  • Use https://rest-api.telesign.com/v1/voice as the base endpoint.
  • Accept only UTF-8 encoded unicode characters as inputs.
  • Use Content-Type application/x-www-form-urlencoded in request headers.

Authorization

basic

Request Parameters

1 Path Parameter

Responses

Your request was fulfilled and resulted in a new resource being created. If you want to code against a response, you should retrieve the status or error code and use that rather than the HTTP status response.

Status Code Associated Text String Description
100 Call answered The call was answered by the end user or voicemail.
101 Not answered No one answered the call.
104 Wrong/invalid phone number The phone number is not correctly formatted in some way, so a call cannot be placed.
106 Call failed The call did not go through. Typically this occurs when TeleSign’s upstream providers fail to complete the call. Sometimes retrying will work.
107 Line busy The line was busy when the call tried to reach the end user’s device.
130 Call blocked by TeleSign TeleSign blocks a message if it is being sent to a phone number that is on a global blocklist.
Schema
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.

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.

required
description
string

A text description of the status code.

required
updated_on
string

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

required
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.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
reference_id
$$.env
2 variables not set
username
password