v10

latestSwagger 2.02026-07-13203270.7 KB

Browse, reserve and purchase available phone numbers

Gets a reservation by its ID.

Retrieves the reservation with the given ID, including all of the phone numbers associated with it.

get/availablePhoneNumbers/reservations/{reservationId}

Path parameters

reservationIdstring uuid required

The id of the reservation.

Query parameters

api-versionstring required

Version of API to invoke

Response

Successfully retrieved the reservation.

idstring uuid

The id of the reservation.

expiresAtstring date-time

The time at which the reservation will expire. If a reservation is not purchased before this time, all of the reserved phone numbers will be released and made available for others to purchase.

phoneNumbersobject

A dictionary containing the reservation phone numbers. The key is the ID of the phone number (digits only) and values are AvailablePhoneNumber objects. Not populated when retrieving PhoneNumbersReservation collections.

status'active' | 'submitted' | 'completed' | 'expired'

Represents the status of the reservation. Possible values include: 'active', 'submitted', 'completed', 'expired'.