Package com.vonage.client.numbers

Class NumbersClient

java.lang.Object

com.vonage.client.numbers.NumbersClient

public class NumbersClient
extends java.lang.Object

A client for accessing the Vonage API calls that manage phone numbers.

Constructor Summary

Constructors

Constructor	Description
NumbersClient(HttpWrapper httpWrapper)

Method Summary

Modifier and Type	Method	Description
void	buyNumber(java.lang.String country, java.lang.String msisdn)	Start renting a Vonage Virtual Number.
void	cancelNumber(java.lang.String country, java.lang.String msisdn)	Stop renting a Vonage Virtual Number.
void	linkNumber(java.lang.String msisdn, java.lang.String country, java.lang.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(java.lang.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 httpWrapper)

Method Details

listNumbers

public ListNumbersResponse listNumbers() throws VonageResponseParseException, VonageClientException

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

Returns:

A ListNumbersResponse containing the first 10 phone numbers

Throws:

VonageResponseParseException - if the response from the API could not be parsed.

VonageClientException - if an error is returned by the server.

listNumbers

public ListNumbersResponse listNumbers(ListNumbersFilter filter) throws VonageResponseParseException, VonageClientException

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:

VonageResponseParseException - if the response from the API could not be parsed.

VonageClientException - if an error is returned by the server.

searchNumbers

public SearchNumbersResponse searchNumbers(java.lang.String country) throws VonageResponseParseException, VonageClientException

Search for available Vonage Virtual Numbers.

Throws:

VonageResponseParseException - if the response from the API could not be parsed.

VonageClientException - if an error is returned by the server.

searchNumbers

public SearchNumbersResponse searchNumbers(SearchNumbersFilter filter) throws VonageResponseParseException, VonageClientException

Search for available Vonage Virtual Numbers.

Throws:

VonageResponseParseException - if the response from the API could not be parsed.

VonageClientException - if an error is returned by the server.

buyNumber

public void buyNumber(java.lang.String country, java.lang.String msisdn) throws VonageResponseParseException, VonageClientException

Start renting a Vonage Virtual Number.

Parameters:

country - A String containing a 2-character ISO country code.

msisdn - The phone number to be bought.

Throws:

VonageResponseParseException - if the response from the API could not be parsed.

VonageClientException - if an error is returned by the server.

cancelNumber

public void cancelNumber(java.lang.String country, java.lang.String msisdn) throws VonageResponseParseException, VonageClientException

Stop renting a Vonage Virtual Number.

Parameters:

country - A String containing a 2-character ISO country code.

msisdn - The phone number to be cancelled.

Throws:

VonageResponseParseException - if the response from the API could not be parsed.

VonageClientException - if an error is returned by the server.

updateNumber

public void updateNumber(UpdateNumberRequest request) throws VonageResponseParseException, VonageClientException

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:

VonageResponseParseException - if the response from the API could not be parsed.

VonageClientException - if an error is returned by the server.

linkNumber

public void linkNumber(java.lang.String msisdn, java.lang.String country, java.lang.String appId) throws VonageResponseParseException, VonageClientException

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 ID for the Vonage Application to be associated with the number.

Throws:

VonageResponseParseException - if the response from the API could not be parsed.

VonageClientException - if an error is returned by the server.