List number orders

GET 
/number_orders

Get a paginated list of number orders.

Request

Query Parameters

filter[status] string

Filter number orders by status.

filter[created_at][gt] string

Filter number orders later than this value.

filter[created_at][lt] string

Filter number orders earlier than this value.

filter[phone_numbers_count] string

Filter number order with this amount of numbers

filter[customer_reference] string

Filter number orders via the customer reference set.

filter[requirements_met] boolean

Filter number orders by requirements met.

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page

Responses

200: Successful response with a list of number orders.

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

id uuid

record_type string

phone_numbers_count integer

The count of phone numbers in the number order.

connection_id string

Identifies the connection associated with this phone number.

messaging_profile_id string

Identifies the messaging profile associated with the phone number.

billing_group_id string

Identifies the messaging profile associated with the phone number.

phone_numbers

PhoneNumbersJobPhoneNumber[]

Array [

phone_number e164

The phone number in e164 format.

id int64

The phone number's ID

]

sub_number_orders_ids string[]

status string

Possible values: [pending, success, failure]

The status of the order.

customer_reference string

A customer reference string for customer look ups.

created_at datetime

An ISO 8901 datetime string denoting when the number order was created.

updated_at datetime

An ISO 8901 datetime string for when the number order was updated.

requirements_met boolean

True if all requirements are met for every phone number, false otherwise.

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "data": [
    {
      "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
      "record_type": "number_order",
      "phone_numbers_count": 1,
      "connection_id": "346789098765567",
      "messaging_profile_id": "abc85f64-5717-4562-b3fc-2c9600",
      "billing_group_id": "abc85f64-5717-4562-b3fc-2c9600",
      "phone_numbers": [
        {
          "phone_number": "+19705555000",
          "id": "string"
        }
      ],
      "sub_number_orders_ids": [
        "string"
      ],
      "status": "pending",
      "customer_reference": "MY REF 001",
      "created_at": "2018-01-01T00:00:00.000000Z",
      "updated_at": "2018-01-01T00:00:00.000000Z",
      "requirements_met": true
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code integerrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta

object

url string

URL with additional information on the error.

]

{
  "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"
      }
    }
  ]
}

Loading...