List sub number orders
Get a paginated list of sub number orders.
GET
/
sub_number_orders
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const subNumberOrders = await client.subNumberOrders.list();
console.log(subNumberOrders.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
)
sub_number_orders = client.sub_number_orders.list()
print(sub_number_orders.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"),
)
subNumberOrders, err := client.SubNumberOrders.List(context.TODO(), telnyx.SubNumberOrderListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", subNumberOrders.Data)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.subnumberorders.SubNumberOrderListParams;
import com.telnyx.sdk.models.subnumberorders.SubNumberOrderListResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
SubNumberOrderListResponse subNumberOrders = client.subNumberOrders().list();
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
sub_number_orders = telnyx.sub_number_orders.list
puts(sub_number_orders)<?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 {
$subNumberOrders = $client->subNumberOrders->list(
filter: [
'countryCode' => 'US',
'orderRequestID' => '12ade33a-21c0-473b-b055-b3c836e1c293',
'phoneNumberType' => 'local',
'phoneNumbersCount' => 1,
'status' => 'status',
],
);
var_dump($subNumberOrders);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx sub-number-orders list \
--api-key 'My API Key'curl --request GET \
--url https://api.telnyx.com/v2/sub_number_orders \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"order_request_id": "12ade33a-21c0-473b-b055-b3c836e1c293",
"country_code": "US",
"phone_number_type": "local",
"user_id": "d70873cd-7c98-401a-81b6-b1ae08246995",
"regulatory_requirements": [
{
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
"field_type": "address"
}
],
"record_type": "sub_number_order",
"phone_numbers_count": 1,
"created_at": "2018-01-01T00:00:00.000000Z",
"updated_at": "2018-01-01T00:00:00.000000Z",
"requirements_met": true,
"customer_reference": "MY REF 001",
"is_block_sub_number_order": 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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Consolidated filter parameter (deepObject style). Originally: filter[status], filter[order_request_id], filter[country_code], filter[phone_number_type], filter[phone_numbers_count]
Show child attributes
Show child attributes
Was this page helpful?
Update requirements for a single phone number within a number order.
Previous
Retrieve a sub number order
Next
⌘I
JavaScript
import Telnyx from 'telnyx';
const client = new Telnyx({
apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});
const subNumberOrders = await client.subNumberOrders.list();
console.log(subNumberOrders.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
)
sub_number_orders = client.sub_number_orders.list()
print(sub_number_orders.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"),
)
subNumberOrders, err := client.SubNumberOrders.List(context.TODO(), telnyx.SubNumberOrderListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", subNumberOrders.Data)
}package com.telnyx.sdk.example;
import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.subnumberorders.SubNumberOrderListParams;
import com.telnyx.sdk.models.subnumberorders.SubNumberOrderListResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
TelnyxClient client = TelnyxOkHttpClient.fromEnv();
SubNumberOrderListResponse subNumberOrders = client.subNumberOrders().list();
}
}require "telnyx"
telnyx = Telnyx::Client.new(api_key: "My API Key")
sub_number_orders = telnyx.sub_number_orders.list
puts(sub_number_orders)<?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 {
$subNumberOrders = $client->subNumberOrders->list(
filter: [
'countryCode' => 'US',
'orderRequestID' => '12ade33a-21c0-473b-b055-b3c836e1c293',
'phoneNumberType' => 'local',
'phoneNumbersCount' => 1,
'status' => 'status',
],
);
var_dump($subNumberOrders);
} catch (APIException $e) {
echo $e->getMessage();
}telnyx sub-number-orders list \
--api-key 'My API Key'curl --request GET \
--url https://api.telnyx.com/v2/sub_number_orders \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "12ade33a-21c0-473b-b055-b3c836e1c292",
"order_request_id": "12ade33a-21c0-473b-b055-b3c836e1c293",
"country_code": "US",
"phone_number_type": "local",
"user_id": "d70873cd-7c98-401a-81b6-b1ae08246995",
"regulatory_requirements": [
{
"record_type": "phone_number_regulatory_requirement",
"requirement_id": "8ffb3622-7c6b-4ccc-b65f-7a3dc0099576",
"field_type": "address"
}
],
"record_type": "sub_number_order",
"phone_numbers_count": 1,
"created_at": "2018-01-01T00:00:00.000000Z",
"updated_at": "2018-01-01T00:00:00.000000Z",
"requirements_met": true,
"customer_reference": "MY REF 001",
"is_block_sub_number_order": 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"
}
}
]
}