List phone numbers

import Telnyx from 'telnyx';

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

// Automatically fetches more pages as needed.
for await (const phoneNumberDetailed of client.phoneNumbers.list()) {
  console.log(phoneNumberDetailed.id);
}

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
page = client.phone_numbers.list()
page = page.data[0]
print(page.id)

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"),
	)
	page, err := client.PhoneNumbers.List(context.TODO(), telnyx.PhoneNumberListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.phonenumbers.PhoneNumberListPage;
import com.telnyx.sdk.models.phonenumbers.PhoneNumberListParams;

public final class Main {
    private Main() {}

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

        PhoneNumberListPage page = client.phoneNumbers().list();
    }
}

require "telnyx"

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

page = telnyx.phone_numbers.list

puts(page)

<?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 {
  $page = $client->phoneNumbers->list(
    filter: [
      'billingGroupID' => '62e4bf2e-c278-4282-b524-488d9c9c43b2',
      'connectionID' => '1521916448077776306',
      'countryISOAlpha2' => 'US',
      'customerReference' => 'customer_reference',
      'emergencyAddressID' => '9102160989215728032',
      'numberType' => ['eq' => 'local'],
      'phoneNumber' => 'phone_number',
      'source' => 'ported',
      'status' => 'active',
      'tag' => 'tag',
      'voiceConnectionName' => [
        'contains' => 'test',
        'endsWith' => 'test',
        'eq' => 'test',
        'startsWith' => 'test',
      ],
      'voiceUsagePaymentMethod' => 'channel',
      'withoutTags' => 'true',
    ],
    handleMessagingProfileError: 'false',
    pageNumber: 0,
    pageSize: 0,
    sort: 'connection_name',
  );

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

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

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

{
  "data": [
    {
      "id": "1293384261075731499",
      "record_type": "phone_number",
      "phone_number": "+19705555098",
      "country_iso_alpha2": "US",
      "status": "active",
      "tags": [
        "tag_1",
        "tag_2"
      ],
      "external_pin": "1234",
      "connection_id": "1293384261075731499",
      "connection_name": "connection-name",
      "customer_reference": "customer-reference",
      "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600000000",
      "messaging_profile_name": "regional-customers",
      "billing_group_id": "86f58db9-0fe3-4adc-9d1f-46e66e6e9323",
      "emergency_enabled": true,
      "emergency_address_id": "1315261609962112019",
      "emergency_status": "active",
      "call_forwarding_enabled": true,
      "cnam_listing_enabled": true,
      "caller_id_name_enabled": true,
      "call_recording_enabled": true,
      "t38_fax_gateway_enabled": true,
      "phone_number_type": "local",
      "inbound_call_screening": "disabled",
      "purchased_at": "2019-10-23T18:10:00.000Z",
      "created_at": "2019-10-23T18:10:00.000Z",
      "updated_at": "2019-10-24T18:10:00.000Z",
      "hd_voice_enabled": true,
      "source_type": "number_order",
      "deletion_lock_enabled": false,
      "activated_at": "2019-10-23T18:10:00.000Z"
    }
  ],
  "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": "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"
      }
    }
  ]
}