v10

latestSwagger 2.02026-07-13203270.7 KB
Browse, reserve and purchase available phone numbers

Starts the purchase of all phone numbers in the reservation.

Starts a long running operation to purchase all of the phone numbers in the reservation. Purchase can only be started for active reservations that at least one phone number. If any of the phone numbers in the reservation is from a country where reselling is not permitted, do not resell agreement is required. The response will include an 'Operation-Location' header that can be used to query the status of the operation.

post/availablePhoneNumbers/reservations/{reservationId}/:purchase

Path parameters

reservationIdstring uuid required

The id of the reservation.

Query parameters

api-versionstring required

Version of API to invoke

Request body

agreeToNotResellboolean

The agreement to not resell the phone numbers. Defaults to false if not provided.

Response

The service has accepted the request and will start processing later. It will return 'Accepted' immediately and include an 'Operation-Location' header. Client side should further query the operation status using the URL specified in 'Operation-Location' header.