Retrieve a number reservation

GET 
/number_reservations/:number_reservation_id

Gets a single phone number reservation.

Request

Path Parameters

number_reservation_id stringrequired

The number reservation ID.

Responses

200: Successful response with details about a number reservation.

application/json

• Schema
• Example (from schema)

Schema

data

NumberReservation

id uuid

record_type string

phone_numbers

ReservedPhoneNumber[]

Array [

id uuid

record_type string

phone_number e164_phone_number

status string

Possible values: [pending, success, failure]

The status of the phone number's reservation.

created_at datetime

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

updated_at datetime

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

expired_at datetime

An ISO 8901 datetime string for when the individual number reservation is going to expire

]

status string

Possible values: [pending, success, failure]

The status of the entire reservation.

customer_reference string

A customer reference string for customer look ups.

created_at datetime

An ISO 8901 datetime string denoting when the numbers reservation was created.

updated_at datetime

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

{
  "data": {
    "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
    "record_type": "number_reservation",
    "phone_numbers": [
      {
        "id": "12ade33a-21c0-473b-b055-b3c836e1c292",
        "record_type": "reserved_phone_number",
        "phone_number": "+19705555098",
        "status": "pending",
        "created_at": "2018-01-01T00:00:00.000000Z",
        "updated_at": "2018-01-01T00:00:00.000000Z",
        "expired_at": "2018-01-01T00:00:00.000000Z",
        "errors": ""
      }
    ],
    "status": "pending",
    "customer_reference": "MY REF 001",
    "created_at": "2018-01-01T00:00:00.000000Z",
    "updated_at": "2018-01-01T00:00:00.000000Z"
  }
}

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...