List the numbers you own
Retrieve all the inbound numbers associated with your Vonage account.
get/account/numbers
Query parameters
application_idstring
The Application that you want to return the numbers for.
has_applicationboolean
Set this optional field to true to restrict your results to numbers associated with an Application (any Application). Set to false to find all numbers not associated with any Application. Omit the field to avoid filtering on whether or not the number is assigned to an Application.
countrystring
The two character country code in ISO 3166-1 alpha-2 format
Example:GB
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
sizeinteger
Page size
indexinteger
Page index
Response
OK
Example response
{
"count": 1,
"numbers": [
{
"country": "GB",
"features": [
"VOICE",
"SMS",
"MMS"
],
"messagesCallbackType": "app",
"messagesCallbackValue": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab",
"moHttpUrl": "https://example.com/webhooks/inbound-sms",
"msisdn": "447700900000",
"type": "mobile-lvn",
"voiceCallbackType": "app",
"voiceCallbackValue": "aaaaaaaa-bbbb-cccc-dddd-0123456789ab"
}
]
}