Skip to main content
GET
/
number_order_phone_numbers
JavaScript
import Telnyx from 'telnyx';

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

const numberOrderPhoneNumbers = await client.numberOrderPhoneNumbers.list();

console.log(numberOrderPhoneNumbers.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_numbers = client.number_order_phone_numbers.list()
print(number_order_phone_numbers.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"),
)
numberOrderPhoneNumbers, err := client.NumberOrderPhoneNumbers.List(context.TODO(), telnyx.NumberOrderPhoneNumberListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", numberOrderPhoneNumbers.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.NumberOrderPhoneNumberListParams;
import com.telnyx.sdk.models.numberorderphonenumbers.NumberOrderPhoneNumberListResponse;

public final class Main {
private Main() {}

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

NumberOrderPhoneNumberListResponse numberOrderPhoneNumbers = client.numberOrderPhoneNumbers().list();
}
}
require "telnyx"

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

number_order_phone_numbers = telnyx.number_order_phone_numbers.list

puts(number_order_phone_numbers)
<?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 {
$numberOrderPhoneNumbers = $client->numberOrderPhoneNumbers->list(
filter: ['countryCode' => 'US']
);

var_dump($numberOrderPhoneNumbers);
} catch (APIException $e) {
echo $e->getMessage();
}
telnyx number-order-phone-numbers list \
--api-key 'My API Key'
curl --request GET \
--url https://api.telnyx.com/v2/number_order_phone_numbers \
--header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "dc8e4d67-33a0-4cbb-af74-7b58f05bd494",
      "record_type": "number_order_phone_number",
      "phone_number": "+19705555098",
      "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
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}
{
"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.

Query Parameters

filter
object

Consolidated filter parameter (deepObject style). Originally: filter[country_code]

Response

Successful response with a list of number order phone numbers.

data
object[]
meta
object