Skip to main content

Retrieve a number order

GET 
/origination/number_orders/:order_request_id

Retrieves the details of an existing number order.

Request ​

Path Parameters

    order_request_id stringrequired

    Order request id

Responses ​

200: Number Order Response

Schema

    order_request_id string

    uuid.

    numbers_count double

    Count of requested numbers associated to the order.

    date_created string

    Timestamp of resource creation.

    date_due string

    Timestamp of due date for requirements if needed to be met.

    requirements_met boolean

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

    requested_numbers

    object[]

  • Array [

    • number string

    phone number.

    status string

    Status of the requested number: pending, success, failure.

    allocated boolean

    True if successfully purchased, false otherwise.

    customer_name string

    The value of the customer_name requirement if provided at the time of purchase.

    customer_phone string

    The value of the customer_phone requirement if provided at the time of purchase.

    tax_id string

    The value of the tax_id requirement if provided at the time of purchase.

    requirements_met boolean

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

    requirements object[]

    provided_documents

    object

    address_proof_file_ids string[]

    List of Number Document ids.

    identification_file_ids string[]

    List of Number Document ids.

    reg_form_file_ids string[]

    List of Number Document ids.

  • ]

    • requested_inexplicit_numbers

    object[]

  • Array [

    • region_name string
    region_type string
    national_destination_code string
    country_iso string
    quantity number
    allocated_telephone_numbers string[]

    List of phone numbers that have been allocated so far.

    customer_name string

    The value of the customer_name requirement if provided at the time of purchase.

    customer_phone string

    The value of the customer_phone requirement if provided at the time of purchase.

    tax_id string

    The value of the tax_id requirement if provided at the time of purchase.

    requirements_met boolean

    True if all requirements are met, false otherwise.

    requirements object[]

    provided_documents

    object

    address_proof_file_ids string[]

    List of Number Document ids.

    identification_file_ids string[]

    List of Number Document ids.

    reg_form_file_ids string[]

    List of Number Document ids.

  • ]

    • connection_id string

    ID of connection associated to phone numbers in the order.

401: Unauthorized

404: Resource not found

Request samples

curl -L 'https://api.telnyx.com/origination/number_orders/:order_request_id' \
-H 'Accept: application/json'

Response samples

{
  "order_request_id": "7e610e23-d1f2-4f90-b5b7-3ddd7b32ad7c",
  "numbers_count": 1,
  "date_created": "2018-02-08T18:49:22.998023Z",
  "date_due": "2018-02-08T18:49:22.998023Z",
  "requirements_met": true,
  "requested_numbers": [
    {
      "number": "string",
      "status": "success",
      "allocated": true,
      "customer_name": "string",
      "customer_phone": "string",
      "tax_id": "string",
      "requirements_met": true,
      "requirements": [
        {}
      ],
      "provided_documents": {
        "address_proof_file_ids": [
          "string"
        ],
        "identification_file_ids": [
          "string"
        ],
        "reg_form_file_ids": [
          "string"
        ]
      }
    }
  ],
  "requested_inexplicit_numbers": [
    {
      "region_name": "string",
      "region_type": "string",
      "national_destination_code": "string",
      "country_iso": "string",
      "quantity": 0,
      "allocated_telephone_numbers": [
        "string"
      ],
      "customer_name": "string",
      "customer_phone": "string",
      "tax_id": "string",
      "requirements_met": true,
      "requirements": [
        {}
      ],
      "provided_documents": {
        "address_proof_file_ids": [
          "string"
        ],
        "identification_file_ids": [
          "string"
        ],
        "reg_form_file_ids": [
          "string"
        ]
      }
    }
  ],
  "connection_id": "string"
}