Telnyx

{ "data": { "record_type": "number_lookup", "country_code": "US", "national_format": "(0312) 945-7420", "phone_number": "+13129457420", "fraud": null, "carrier": { "mobile_country_code": "US", "mobile_network_code": "0866", "name": "Telnyx/4", "type": "voip", "error_code": null, "normalized_carrier": "AT&T" }, "caller_name": { "caller_name": "TELNYX LLC", "error_code": "10001" }, "portability": { "lrn": "2245701999", "ported_status": "Y", "ported_date": "2017-10-20", "ocn": "073H", "line_type": "voip", "spid": "073H", "spid_carrier_name": "Telnyx/4", "spid_carrier_type": "3", "altspid": "073H", "altspid_carrier_name": "Telnyx/4", "altspid_carrier_type": "3", "city": "WAUKEGAN", "state": "Illinois" } } }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

phone_number

string

required

The phone number to be looked up

Example:

"+18665552368"

Query Parameters

type

enum<string>

Specifies the type of number lookup to be performed

Available options:

carrier,

caller-name

Response

Successful response

data

NumberLookup · object

Show child attributes

data.record_type

string

Identifies the type of record

Example:

"number_lookup"

data.country_code

string

Region code that matches the specific country calling code

Example:

"US"

data.national_format

string

Hyphen-separated national number, preceded by the national destination code (NDC), with a 0 prefix, if an NDC is found

Example:

"(0312) 945-7420"

data.phone_number

string

E164-formatted phone number

Example:

"+13129457420"

data.fraud

string

Unused

Example:

null

data.carrier

object

Show child attributes

data.carrier.mobile_country_code

string

Region code that matches the specific country calling code if the requested phone number type is mobile

Example:

"US"

data.carrier.mobile_network_code

string

National destination code (NDC), with a 0 prefix, if an NDC is found and the requested phone number type is mobile

Example:

"0866"

data.carrier.name

string

SPID (Service Provider ID) name, if the requested phone number has been ported; otherwise, the name of carrier who owns the phone number block

Example:

"Telnyx/4"

data.carrier.type

enum<string>

A phone number type that identifies the type of service associated with the requested phone number

Available options:

fixed line,

mobile,

voip,

fixed line or mobile,

toll free,

premium rate,

shared cost,

personal number,

pager,

uan,

voicemail,

unknown

Example:

"voip"

data.carrier.error_code

string

Unused

Example:

null

data.carrier.normalized_carrier

string

If known to Telnyx and applicable, the primary network carrier.

Example:

"AT&T"

data.caller_name

object

Show child attributes

data.caller_name.caller_name

string

The name of the requested phone number's owner as per the CNAM database

Example:

"TELNYX LLC"

data.caller_name.error_code

string

A caller-name lookup specific error code, expressed as a stringified 5-digit integer

Example:

"10001"

data.portability

object

Show child attributes

data.portability.lrn

string

Local Routing Number, if assigned to the requested phone number

Example:

"2245701999"

data.portability.ported_status

enum<string>

Indicates whether or not the requested phone number has been ported

Available options:

Y,

N,

Example:

"Y"

data.portability.ported_date

string

ISO-formatted date when the requested phone number has been ported

Example:

"2017-10-20"

data.portability.ocn

string

Operating Company Name (OCN) as per the Local Exchange Routing Guide (LERG) database

Example:

"073H"

data.portability.line_type

string

Type of number

Example:

"voip"

data.portability.spid

string

SPID (Service Provider ID)

Example:

"073H"

data.portability.spid_carrier_name

string

Service provider name

Example:

"Telnyx/4"

data.portability.spid_carrier_type

string

Service provider type

Example:

"3"

data.portability.altspid

string

Alternative SPID (Service Provider ID). Often used when a carrier is using a number from another carrier

Example:

"073H"

data.portability.altspid_carrier_name

string

Alternative service provider name

Example:

"Telnyx/4"

data.portability.altspid_carrier_type

string

Alternative service provider type

Example:

"3"

data.portability.city

string

City name extracted from the locality in the Local Exchange Routing Guide (LERG) database

Example:

"WAUKEGAN"

data.portability.state

string

Example:

"Illinois"

OAuth Discovery

IP Addresses

IP Ranges

SIM Cards

Addresses

Advanced Number Orders

Assistants

Audio

Chat

Clusters

Conversations

Embeddings

Fine Tuning

Integrations

MCP Servers

Audit Logs

Authentication Providers

Phone Number Search

Billing

Billing Groups

Brands

SIM Card Actions

Bundles

User Bundles

Call Control Applications

Debugging

Call Commands

Call Information

Campaign

Voice Channels

API Reference

Phone Number Orders

Conference Commands

Connections

Country Coverage

Credential Connections

Call Recordings

Customer Service Record

Detail Records

Dialogflow Integration

Documents

Dynamic Emergency Addresses

Dynamic Emergency Endpoints

Enum

External Connections

Programmable Fax Applications

Programmable Fax Commands

FQDN Connections

FQDNs

Global IPs

Inexplicit Number Orders

Integration Secrets

Inventory Level

IP Connections

IPs

Reports

MDR Detailed Reports

Speech to Text Batch Reports

CDR Reports

MDR Usage Reports

Telco Data Usage Reports

Speech to text Usage Reports

CDR Usage Reports

Managed Accounts

Media Storage API

Messages

RCS messaging

Messaging Hosted Number

Number Configurations

Advanced OptIn/OptOut

Messaging Profiles

Messaging Tollfree Verification

Messaging URL Domains

Mobile Network Operators

Push Credentials

Coverage

Networks

Notifications

Phone Number Block Orders

Number Lookup