Using an HTTP Request

GET 
/Lookup/:tn

Gets switchData object with the request telephone number (tn). Requires an authorization header or IP Auth setup through the portal

Request

Path Parameters

tn ^[\d]{10}required

10 digit telephone number

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

tn stringrequired
ocn string

Carrier number of block owner

carrier_name string

Carrier name of block owner

mapped_svtype string

0 -> Wireline , 1 -> Wireless , 2 -> VOIP

lata_id string

Local Access and Transport Area ID

lata string

Local Access and Transport Area Name

locality string

Locality of number (A single city could be composed of multiple localities)

localitystate string

State of locality

ratecenter string

Rate center name of the number

{
  "tn": "string",
  "ocn": "string",
  "carrier_name": "string",
  "mapped_svtype": "string",
  "lata_id": "string",
  "lata": "string",
  "locality": "string",
  "localitystate": "string",
  "ratecenter": "string"
}

400: Bad request with invalid/missing tn

application/json

• Schema
• Example (from schema)

Schema

error string

Error parsing TN

{
  "error": "string"
}

401: Unauthorized request

application/json

• Schema
• Example (from schema)

Schema

error string

Unauthorized request

{
  "error": "string"
}

Request samples

• cURL

---

curl -L 'https://switchdata.telnyx.com/v1/Lookup/:tn' \
-H 'Accept: application/json'

Response samples

• 200
• 400
• 401

---

{
  "tn": "string",
  "ocn": "string",
  "carrier_name": "string",
  "mapped_svtype": "string",
  "lata_id": "string",
  "lata": "string",
  "locality": "string",
  "localitystate": "string",
  "ratecenter": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}