List all porting orders

Returns a list of your porting order.

GET /porting_orders

JavaScript

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 portingOrder of client.portingOrders.list()) {
  console.log(portingOrder.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.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.PortingOrders.List(context.TODO(), telnyx.PortingOrderListParams{})
	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.PortingOrderListPage;
import com.telnyx.sdk.models.portingorders.PortingOrderListParams;

public final class Main {
    private Main() {}

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

        PortingOrderListPage page = client.portingOrders().list();
    }
}

require "telnyx"

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

page = telnyx.porting_orders.list

puts(page)

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;
use Telnyx\PortingOrders\PortingOrderType;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $page = $client->portingOrders->list(
    filter: [
      'activationSettings' => [
        'fastPortEligible' => true,
        'focDatetimeRequested' => [
          'gt' => '2021-03-25T10:00:00.000Z', 'lt' => '2021-03-25T10:00:00.000Z'
        ],
      ],
      'customerGroupReference' => 'customer_group_reference',
      'customerReference' => 'customer_reference',
      'endUser' => [
        'admin' => [
          'authPersonName' => 'auth_person_name', 'entityName' => 'entity_name'
        ],
      ],
      'misc' => ['type' => PortingOrderType::FULL],
      'parentSupportKey' => 'parent_support_key',
      'phoneNumbers' => [
        'carrierName' => 'carrier_name',
        'countryCode' => 'country_code',
        'phoneNumber' => ['contains' => 'contains'],
      ],
    ],
    includePhoneNumbers: true,
    pageNumber: 0,
    pageSize: 0,
    sort: ['value' => 'created_at'],
  );

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

telnyx porting-orders list \
  --api-key 'My API Key'

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

200

{
  "data": [
    {
      "id": "f1486bae-f067-460c-ad43-73a92848f902",
      "customer_reference": "Acct 123abc",
      "customer_group_reference": "Group-456",
      "created_at": "2021-03-19T10:07:15.527Z",
      "updated_at": "2021-03-19T10:07:15.527Z",
      "status": {
        "details": [
          {
            "code": "ENTITY_NAME_MISMATCH",
            "description": "Entity name does not match that on the CSR"
          }
        ],
        "value": "ported"
      },
      "support_key": "sr_123abc",
      "parent_support_key": "pr_123abc",
      "porting_phone_numbers_count": 1,
      "old_service_provider_ocn": "Unreal Communications",
      "phone_numbers": [
        {
          "porting_order_status": "in-process",
          "phone_number_type": "local",
          "phone_number": "13035550987",
          "porting_order_id": "f1486bae-f067-460c-ad43-73a92848f902",
          "support_key": "sr_a12345",
          "activation_status": "Active",
          "portability_status": "confirmed",
          "requirements_status": "approved",
          "record_type": "porting_phone_number"
        }
      ],
      "documents": {
        "loa": "64ffb720-04c7-455b-92d6-20fcca92e935",
        "invoice": "ce74b771-d23d-4960-81ec-8741b3862146"
      },
      "misc": {
        "type": "full",
        "remaining_numbers_action": "disconnect",
        "new_billing_phone_number": "<string>"
      },
      "end_user": {
        "admin": {
          "entity_name": "Porter McPortersen",
          "auth_person_name": "Porter McPortersen II",
          "billing_phone_number": "13035551234",
          "account_number": "123abc",
          "tax_identifier": "1234abcd",
          "pin_passcode": "1234",
          "business_identifier": "abc123"
        },
        "location": {
          "street_address": "600 Congress Avenue",
          "extended_address": "14th Floor",
          "locality": "Austin",
          "administrative_area": "TX",
          "postal_code": "78701",
          "country_code": "US"
        }
      },
      "activation_settings": {
        "foc_datetime_requested": "2021-03-19T10:07:15.527Z",
        "foc_datetime_actual": "2021-03-19T10:07:15.527Z",
        "fast_port_eligible": true,
        "activation_status": "Active"
      },
      "phone_number_configuration": {
        "billing_group_id": "f1486bae-f067-460c-ad43-73a92848f902",
        "connection_id": "f1486bae-f067-460c-ad43-73a92848f902",
        "messaging_profile_id": "f1486bae-f067-460c-ad43-73a92848f901",
        "emergency_address_id": "f1486bae-f067-460c-ad43-73a92848f902",
        "tags": [
          "abc",
          "123"
        ]
      },
      "phone_number_type": "local",
      "description": "FP Telnyx",
      "requirements": [
        {
          "field_type": "document",
          "field_value": "9787fb5f-cbe5-4de4-b765-3303774ee9fe",
          "requirement_type_id": "59b0762a-b274-4f76-ac32-4d5cf0272e66",
          "record_type": "porting_requirement"
        }
      ],
      "requirements_met": false,
      "user_feedback": {
        "user_rating": 5,
        "user_comment": "I loved my experience porting numbers with Telnyx"
      },
      "user_id": "40d68ba2-0847-4df2-be9c-b0e0cb673e75",
      "webhook_url": "https://example.com/porting_webhooks",
      "record_type": "porting_order",
      "messaging": {
        "messaging_capable": true,
        "enable_messaging": true,
        "messaging_port_status": "pending",
        "messaging_port_completed": false
      },
      "additional_steps": []
    }
  ],
  "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.

Query Parameters

page · object

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

Show child attributes

include_phone_numbers · boolean · default: true

Include the first 50 phone number objects in the results

filter · object

Consolidated filter parameter (deepObject style). Originally: filter[customer_reference], filter[customer_group_reference], filter[parent_support_key], filter[phone_numbers.country_code], filter[phone_numbers.carrier_name], filter[misc.type], filter[end_user.admin.entity_name], filter[end_user.admin.auth_person_name], filter[activation_settings.fast_port_eligible], filter[activation_settings.foc_datetime_requested][gt], filter[activation_settings.foc_datetime_requested][lt], filter[phone_numbers.phone_number][contains]

Show child attributes

sort · object

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

Show child attributes

Response

200

application/json

Successful response

data · object[]

Show child attributes

meta · object

Show child attributes