get

/v1/phoneid/live/{complete_phone_number}

Use this action to get insights about a phone number such as whether it is active or disconnected, whether its associated device is reachable or unreachable, and its associated device’s roaming status.

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.
  • Accepts: application/x-www-form-urlencoded
  • Responds With: application/json
  • Required Headers: Content-Type - application/x-www-form-urlencoded

Frequency of Same Number Requests

Sending too many request to the API for the same phone number within a short period of time may result in an error, even if data is available for that number. If you receive a -60001 error in the response after making consecutive requests for the same phone number, consider limiting your request rate.

Request Parameters

1 Path Parameter
1 Query 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
300 Transaction successfully completed The system was able to obtain all of the requested data for PhoneID.
301 Transaction partially completed The system was able to obtain some of the data for PhoneID, but not all of it.
Error Code Associated Text String Description
-60001 PhoneID Live Data Not Found Unable to return data for this phone number, for this request.
Schema
object
reference_id
string

A 32-digit hex value used to identify the web service requests. 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.

sub_resource
string

A string displaying the subresource accessed. It is set to contact.

errors
object

A JSON object that contains information on error conditions that might have resulted from the request, in an array of propery value pairs. If multiple errors occur, a pair is returned for each error.

Value Description
code A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred.
description A string that describes the type of error that occurred. If no errors occur, then this array is empty.
phone_type
object

An object containing details about the phone type.

status
object

An object containing details about the request status.

numbering
object

An object containing details about the numbering attributes of the specified phone number.

location
object

An object containing geographical location information associated with the phone number.

carrier
object

An object containing information about the company that provides telecommunications services for the phone number.

live
object

A JSON object containing details about a subscriber and subscriber’s device.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
complete_phone_number
$$.env
1 variable not set
host