Skip to content

Method: phoneNumbers.search

Searches available phone numbers with the specified filters.

Search returns phone numbers sorted by create_time descending.

The caller must be authenticated.

HTTP request

GET https://numbering.api.enfonica.com/v1beta1/phoneNumbers:search

Query parameters

Parameters  
pageSize number (int32 format)
The maximum number of PhoneNumbers to return in the response. Default value of 10 and maximum value of 100.
pageToken string
A pagination token returned from a previous call to SearchPhoneNumbers that indicates where this listing should continue from.
numberType enum (PhoneNumber.PhoneNumberType)
The type of phone number.
countryCode string
The alpha-2 country code that identifies the country associated with the phone number.
prefix string
The prefix that the number must have after the country code. If the prefix starts with '0', it will be automatically removed.
supportsVoice boolean
If true, the phone number must support voice.
supportsSms boolean
If true, the phone number must support SMS.
supportsMms boolean
If true, the phone number must support MMS.

Request body

The request body must be empty.

Response body

The SearchPhoneNumbers response.

JSON representation
{
  "phoneNumbers": [
    {
      object (PhoneNumber)
    }
  ],
  "nextPageToken": string
}
Fields  
phoneNumbers[] object (PhoneNumber)
A possibly paginated list of PhoneNumbers.
nextPageToken string
A pagination token returned from a previous call to SearchPhoneNumbers that indicates from where listing should continue.