Retrieve a single phone number within a number order.

Get an existing phone number in number order.

GET /number_order_phone_numbers/{number_order_phone_number_id}

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 numberOrderPhoneNumber = await client.numberOrderPhoneNumbers.retrieve(
  'number_order_phone_number_id',
);

console.log(numberOrderPhoneNumber.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_order_phone_number = client.number_order_phone_numbers.retrieve(
    "number_order_phone_number_id",
)
print(number_order_phone_number.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"),
	)
	numberOrderPhoneNumber, err := client.NumberOrderPhoneNumbers.Get(context.TODO(), "number_order_phone_number_id")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", numberOrderPhoneNumber.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.numberorderphonenumbers.NumberOrderPhoneNumberRetrieveParams;
import com.telnyx.sdk.models.numberorderphonenumbers.NumberOrderPhoneNumberRetrieveResponse;

public final class Main {
    private Main() {}

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

        NumberOrderPhoneNumberRetrieveResponse numberOrderPhoneNumber = client.numberOrderPhoneNumbers().retrieve("number_order_phone_number_id");
    }
}

require "telnyx"

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

number_order_phone_number = telnyx.number_order_phone_numbers.retrieve("number_order_phone_number_id")

puts(number_order_phone_number)

<?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 {
  $numberOrderPhoneNumber = $client->numberOrderPhoneNumbers->retrieve(
    'number_order_phone_number_id'
  );

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

telnyx number-order-phone-numbers retrieve \
  --api-key 'My API Key' \
  --number-order-phone-number-id number_order_phone_number_id

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

200

{
  "data": {
    "id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
    "record_type": "number_order_phone_number",
    "phone_number": "[phone]",
    "order_request_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd495",
    "sub_number_order_id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd496",
    "country_code": "US",
    "phone_number_type": "local",
    "regulatory_requirements": [
      {
        "record_type": "phone_number_regulatory_requirement",
        "requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
        "field_type": "address",
        "field_value": "45f45a04-b4be-4592-95b1-9306b9db2b21"
      }
    ],
    "requirements_met": true,
    "bundle_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
    "locality": "San Francisco",
    "deadline": "2024-05-31T11:14:00Z",
    "is_block_number": false
  }
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "<string>"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10009",
      "title": "Authentication failed",
      "detail": "Could not understand the provided credentials.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10009"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "<string>"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "<string>"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10007",
      "title": "Unexpected error",
      "detail": "An unexpected error occured.",
      "source": {
        "pointer": "/base",
        "parameter": "<string>"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

number_order_phone_number_id · string · required

The number order phone number ID.

Response

200

application/json

Successful response with details about a number order phone number.

data · object

Show child attributes