Package com.vonage.client.numbers

Class NumbersClient

java.lang.Object

com.vonage.client.numbers.NumbersClient

public class NumbersClient
extends Object

A client for accessing the Vonage API calls that manage phone numbers. The standard way to obtain an instance of this class is to use VonageClient.getNumbersClient().

Constructor Summary

Constructors

Constructor	Description
NumbersClient(HttpWrapper wrapper)

Method Summary

Modifier and Type	Method	Description
void	buyNumber(String country, String msisdn)	Start renting a Vonage Virtual Number.
void	buyNumber(String country, String msisdn, String targetApiKey)	Start renting a Vonage Virtual Number.
void	cancelNumber(String country, String msisdn)	Stop renting a Vonage Virtual Number.
void	cancelNumber(String country, String msisdn, String targetApiKey)	Stop renting a Vonage Virtual Number.
void	linkNumber(String msisdn, String country, String appId)	Link a given Vonage Virtual Number to a Vonage Application with the given ID.
ListNumbersResponse	listNumbers()	Get the first page of phone numbers assigned to the authenticated account.
ListNumbersResponse	listNumbers(ListNumbersFilter filter)	Get a filtered set of numbers assigned to the authenticated account.
SearchNumbersResponse	searchNumbers(SearchNumbersFilter filter)	Search for available Vonage Virtual Numbers.
SearchNumbersResponse	searchNumbers(String country)	Search for available Vonage Virtual Numbers.
void	updateNumber(UpdateNumberRequest request)	Update the callbacks and/or application associations for a given Vonage Virtual Number.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NumbersClient

public NumbersClient(HttpWrapper wrapper)

Method Details

listNumbers

public ListNumbersResponse listNumbers()
                                throws NumbersResponseException

Get the first page of phone numbers assigned to the authenticated account.

Returns:

A ListNumbersResponse containing the first 10 phone numbers

Throws:

NumbersResponseException - If the API call returned an unsuccessful (4xx or 5xx) response.

listNumbers

public ListNumbersResponse listNumbers(ListNumbersFilter filter)
                                throws NumbersResponseException

Get a filtered set of numbers assigned to the authenticated account.

Parameters:

filter - A ListNumbersFilter describing the filters to be applied to the request.

Returns:

A ListNumbersResponse containing phone numbers matching the supplied filter.

Throws:

NumbersResponseException - If the API call returned an unsuccessful (4xx or 5xx) response.

searchNumbers

public SearchNumbersResponse searchNumbers(String country)
                                    throws NumbersResponseException

Search for available Vonage Virtual Numbers.

Parameters:

country - Country to search available numbers from.

Returns:

Available Vonage Virtual Numbers.

Throws:

NumbersResponseException - If the API call returned an unsuccessful (4xx or 5xx) response.

searchNumbers

public SearchNumbersResponse searchNumbers(SearchNumbersFilter filter)
                                    throws NumbersResponseException

Search for available Vonage Virtual Numbers.

Parameters:

filter - search for available Vonage Virtual Number with filters

Returns:

The available Vonage Virtual Numbers.

Throws:

NumbersResponseException - If the API call returned an unsuccessful (4xx or 5xx) response.

buyNumber

public void buyNumber(String country,
 String msisdn)
               throws NumbersResponseException

Start renting a Vonage Virtual Number.

Parameters:

country - The two character country code in ISO 3166-1 alpha-2 format.

msisdn - The phone number to be bought in E.164 format.

Throws:

NumbersResponseException - If the API call returned an unsuccessful (4xx or 5xx) response.

buyNumber

public void buyNumber(String country,
 String msisdn,
 String targetApiKey)
               throws NumbersResponseException

Start renting a Vonage Virtual Number.

Parameters:

country - The two character country code in ISO 3166-1 alpha-2 format.

msisdn - The phone number to be bought in E.164 format.

targetApiKey - If you’d like to perform an action on a subaccount, provide the API key of that account here. If you’d like to perform an action on your own account, you do not need to provide this field.

Throws:

NumbersResponseException - If the API call returned an unsuccessful (4xx or 5xx) response.

Since:

8.10.0

See Also:

• buyNumber(String, String)

cancelNumber

public void cancelNumber(String country,
 String msisdn)
                  throws NumbersResponseException

Stop renting a Vonage Virtual Number.

Parameters:

country - The two character country code in ISO 3166-1 alpha-2 format.

msisdn - The phone number to be cancelled in E.164 format.

Throws:

NumbersResponseException - If the API call returned an unsuccessful (4xx or 5xx) response.

cancelNumber

public void cancelNumber(String country,
 String msisdn,
 String targetApiKey)
                  throws NumbersResponseException

Stop renting a Vonage Virtual Number.

Parameters:

country - The two character country code in ISO 3166-1 alpha-2 format.

msisdn - The phone number to be cancelled in E.164 format.

targetApiKey - If you’d like to perform an action on a subaccount, provide the API key of that account here. If you’d like to perform an action on your own account, you do not need to provide this field.

Throws:

NumbersResponseException - If the API call returned an unsuccessful (4xx or 5xx) response.

Since:

8.10.0

See Also:

• cancelNumber(String, String)

updateNumber

public void updateNumber(UpdateNumberRequest request)
                  throws NumbersResponseException

Update the callbacks and/or application associations for a given Vonage Virtual Number.

Parameters:

request - Details of the updates to be made to the number association.

Throws:

NumbersResponseException - If the API call returned an unsuccessful (4xx or 5xx) response.

linkNumber

public void linkNumber(String msisdn,
 String country,
 String appId)
                throws NumbersResponseException

Link a given Vonage Virtual Number to a Vonage Application with the given ID.

Parameters:

msisdn - The Vonage Virtual Number to be updated.

country - The country for the given msisdn.

appId - The UUID for the Vonage Application to be associated with the number.

Throws:

NumbersResponseException - If the API call returned an unsuccessful (4xx or 5xx) response.