Skip to main content
GET
/
porting_orders
/
{porting_order_id}
/
phone_number_blocks
JavaScript
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 portingPhoneNumberBlock of client.portingOrders.phoneNumberBlocks.list(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
)) {
  console.log(portingPhoneNumberBlock.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.porting_orders.phone_number_blocks.list(
porting_order_id="182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
)
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.PortingOrders.PhoneNumberBlocks.List(
context.TODO(),
"182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
telnyx.PortingOrderPhoneNumberBlockListParams{},
)
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.portingorders.phonenumberblocks.PhoneNumberBlockListPage;
import com.telnyx.sdk.models.portingorders.phonenumberblocks.PhoneNumberBlockListParams;

public final class Main {
private Main() {}

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

PhoneNumberBlockListPage page = client.portingOrders().phoneNumberBlocks().list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e");
}
}
require "telnyx"

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

page = telnyx.porting_orders.phone_number_blocks.list("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")

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->portingOrders->phoneNumberBlocks->list(
'182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
filter: [
'activationStatus' => 'Active',
'phoneNumber' => ['+12003151212'],
'portabilityStatus' => 'confirmed',
'portingOrderID' => ['f3575e15-32ce-400e-a4c0-dd78800c20b0'],
'status' => 'in-process',
'supportKey' => 'sr_a12345',
],
pageNumber: 0,
pageSize: 0,
sort: ['value' => 'created_at'],
);

var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}
telnyx porting-orders:phone-number-blocks list \
--api-key 'My API Key' \
--porting-order-id 182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e
curl --request GET \
--url https://api.telnyx.com/v2/porting_orders/{porting_order_id}/phone_number_blocks \
--header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "f24151b6-3389-41d3-8747-7dd8c681e5e2",
      "country_code": "DE",
      "phone_number_type": "local",
      "phone_number_range": {
        "start_at": "+4930244999901",
        "end_at": "+4930244999910"
      },
      "activation_ranges": [
        {
          "start_at": "+4930244999901",
          "end_at": "+4930244999910"
        }
      ],
      "record_type": "porting_phone_number_block",
      "created_at": "2021-03-19T10:07:15.527Z",
      "updated_at": "2021-03-19T10:07:15.527Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

porting_order_id
string<uuid>
required

Identifies the Porting Order associated with the phone number blocks

Query Parameters

filter
object

Consolidated filter parameter (deepObject style). Originally: filter[porting_order_id], filter[support_key], filter[status], filter[phone_number], filter[activation_status], filter[portability_status]

page
object

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

sort
object

Consolidated sort parameter (deepObject style). Originally: sort[value]

Response

Successful response

data
object[]
meta
object