Search available numbers
Retrieve inbound numbers that are available for the specified country.
get/number/search
Query parameters
countrystring required
The two character country code in ISO 3166-1 alpha-2 format
Example:GB
The two character country code to filter on (in ISO 3166-1 alpha-2 format)
type'landline' | 'mobile-lvn' | 'landline-toll-free'
Set this parameter to filter the type of number, such as mobile or landline
patternstring
The number pattern you want to search for. Use in conjunction with search_pattern.
search_pattern0 | 1 | 2
The strategy you want to use for matching:
- 0 - Search for numbers that start with pattern (Note: all numbers are in E.164 format, so the starting pattern includes the country code, such as 1 for USA)
- 1 - Search for numbers that contain pattern
- 2 - Search for numbers that end with pattern
features'SMS' | 'VOICE' | 'SMS,VOICE' | 'MMS' | 'SMS,MMS' | 'VOICE,MMS' | 'SMS,MMS,VOICE'
Available features are SMS, VOICE and MMS. To look for numbers that support multiple features, use a comma-separated value: SMS,MMS,VOICE.
sizeinteger
Page size
indexinteger
Page index
Response
OK
Example response
{
"count": 1234,
"numbers": [
{
"cost": "1.25",
"country": "GB",
"features": [
"VOICE",
"SMS",
"MMS"
],
"msisdn": "447700900000",
"type": "mobile-lvn"
}
]
}