Sign in

v10

latestSwagger 2.02026-07-13203270.7 KB
Find and purchase available phone numbers

Gets a phone number search result by search id.

get/availablePhoneNumbers/searchResults/{searchId}

Path parameters

searchIdstring required

The search Id.

Query parameters

api-versionstring required

Version of API to invoke

Response

Success

searchIdstring required

The search id.

phoneNumbersstring[] required

The phone numbers that are available. Can be fewer than the desired search quantity.

phoneNumberType'geographic' | 'tollFree' | 'mobile' required

The phone number's type, e.g. geographic, tollFree, mobile.

assignmentType'person' | 'application' required

Phone number's assignment type.

searchExpiresBystring date-time required

The date that this search result expires and phone numbers are no longer on hold. A search result expires in less than 15min, e.g. 2020-11-19T16:31:49.048Z.

isAgreementToNotResellRequiredboolean

Indicates if do not resell agreement is required. If true, the phone numbers cannot be acquired unless the customer provides explicit agreement to not resell them.

errorCodeinteger

The error code of the search.

error'NoError' | 'UnknownErrorCode' | 'OutOfStock' | 'AuthorizationDenied' | 'MissingAddress' | 'InvalidAddress' | 'InvalidOfferModel' | 'NotEnoughLicenses' | 'NoWallet' | 'NotEnoughCredit' | 'NumbersPartiallyAcquired' | 'AllNumbersNotAcquired' | 'ReservationExpired' | 'PurchaseFailed' | 'BillingUnavailable' | 'ProvisioningFailed' | 'UnknownSearchError'

Mapping Error Messages to Codes