Using an HTTP Request

GET 
/caller-information

Returns the caller information (if found) for a telephone number.

A sample response might look like:

{
  "callerInformation": "Telnyx,LLC"
}

Request

Query Parameters

tn ^[\d]{10,15}required

The requested telephone number in E.164 format, may or may not begin with "1"

Responses

200: Successful call

application/json

• Schema
• Example (from schema)
• response

Schema

callerInformation string

{
  "callerInformation": "string"
}

{
  "callerInformation": "Telnyx,LLC"
}

401: Unauthorized

404: No caller information found for the input number

application/json

• Schema
• Example (from schema)

Schema

reason string

{
  "reason": "string"
}

406: Missing required parameters or invalid phone number

application/json

• Schema
• Example (from schema)

Schema

reason string

{
  "reason": "string"
}

Loading...