List available phone numbers

GET /available_phone_numbers

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 availablePhoneNumbers = await client.availablePhoneNumbers.list();

console.log(availablePhoneNumbers.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
)
available_phone_numbers = client.available_phone_numbers.list()
print(available_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"),
	)
	availablePhoneNumbers, err := client.AvailablePhoneNumbers.List(context.TODO(), telnyx.AvailablePhoneNumberListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", availablePhoneNumbers.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.availablephonenumbers.AvailablePhoneNumberListParams;
import com.telnyx.sdk.models.availablephonenumbers.AvailablePhoneNumberListResponse;

public final class Main {
    private Main() {}

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

        AvailablePhoneNumberListResponse availablePhoneNumbers = client.availablePhoneNumbers().list();
    }
}

require "telnyx"

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

available_phone_numbers = telnyx.available_phone_numbers.list

puts(available_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 {
  $availablePhoneNumbers = $client->availablePhoneNumbers->list(
    filter: [
      'administrativeArea' => 'administrative_area',
      'bestEffort' => true,
      'countryCode' => 'country_code',
      'excludeHeldNumbers' => true,
      'features' => ['sms'],
      'limit' => 0,
      'locality' => 'locality',
      'nationalDestinationCode' => 'national_destination_code',
      'phoneNumber' => [
        'contains' => 'contains',
        'endsWith' => 'ends_with',
        'startsWith' => 'starts_with',
      ],
      'phoneNumberType' => 'local',
      'quickship' => true,
      'rateCenter' => 'rate_center',
      'reservable' => true,
    ],
  );

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

telnyx available-phone-numbers list \
  --api-key 'My API Key'

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

200

{
  "data": [
    {
      "record_type": "available_phone_number",
      "phone_number": "[phone]",
      "vanity_format": "",
      "best_effort": false,
      "quickship": true,
      "reservable": true,
      "region_information": [
        {
          "region_type": "country_code",
          "region_name": "US"
        }
      ],
      "cost_information": {
        "upfront_cost": "3.21",
        "monthly_cost": "6.54",
        "currency": "USD"
      },
      "features": [
        {
          "name": "sms"
        },
        {
          "name": "voice"
        }
      ]
    }
  ],
  "meta": {
    "total_results": 100,
    "best_effort_results": 50
  },
  "metadata": {
    "total_results": 100,
    "best_effort_results": 50
  }
}

{
  "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[phone_number], filter[locality], filter[administrative_area], filter[country_code], filter[national_destination_code], filter[rate_center], filter[phone_number_type], filter[features], filter[limit], filter[best_effort], filter[quickship], filter[reservable], filter[exclude_held_numbers]

Show child attributes

Response

200

application/json

Successful response with a list of available phone numbers.

data · object[]

Show child attributes

meta · object

Show child attributes

Example:

{
  "total_results": 100,
  "best_effort_results": 50
}

metadata · object

Show child attributes

Example:

{
  "total_results": 100,
  "best_effort_results": 50
}