Lookup phone number data

Returns information about the provided phone number.

GET /number_lookup/{phone_number}

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const numberLookup = await client.numberLookup.retrieve('[phone]');

console.log(numberLookup.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
number_lookup = client.number_lookup.retrieve(
    phone_number="[phone]",
)
print(number_lookup.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	numberLookup, err := client.NumberLookup.Get(
		context.TODO(),
		"[phone]",
		telnyx.NumberLookupGetParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", numberLookup.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.numberlookup.NumberLookupRetrieveParams;
import com.telnyx.sdk.models.numberlookup.NumberLookupRetrieveResponse;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        NumberLookupRetrieveResponse numberLookup = client.numberLookup().retrieve("[phone]");
    }
}

require "telnyx"

telnyx = Telnyx::Client.new(api_key: "My API Key")

number_lookup = telnyx.number_lookup.retrieve("[phone]")

puts(number_lookup)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $numberLookup = $client->numberLookup->retrieve(
    '[phone]', type: 'carrier'
  );

  var_dump($numberLookup);
} catch (APIException $e) {
  echo $e->getMessage();
}

telnyx number-lookup retrieve \
  --api-key 'My API Key' \
  --phone-number [phone]

curl --request GET \
  --url https://api.telnyx.com/v2/number_lookup/{phone_number} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "record_type": "number_lookup",
    "country_code": "US",
    "national_format": "[phone]",
    "phone_number": "[phone]",
    "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"
    }
  }
}

{
  "errors": [
    {
      "code": "<string>",
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      },
      "meta": {}
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      },
      "meta": {}
    }
  ]
}

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:

"[phone]"

Query Parameters

type · enum<string>

Specifies the type of number lookup to be performed

Available options: carrier, caller-name

Response

200

application/json

Successful response

data · NumberLookup · object

Show child attributes