Phone Number Reservations

Retrieve a number reservation

Changed on

Returns the details of a single phone number reservation, including its status and the reserved numbers.

get/number_reservations/{number_reservation_id}

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/number_reservations/{number_reservation_id}
  • Auth: HTTP bearer

Path parameters

number_reservation_idstring required

The number reservation ID.

Response

Successful response with details about a number reservation.

Example response

{
  "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": "Number is already on hold"
      }
    ],
    "status": "pending",
    "customer_reference": "MY REF 001",
    "created_at": "2018-01-01T00:00:00.000000Z",
    "updated_at": "2018-01-01T00:00:00.000000Z"
  }
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status