PhoneNumbersClient Class

Package:

com.azure.communication.phonenumbers

Maven Artifact:

com.azure:azure-communication-phonenumbers:1.1.10

• java.lang.Object
• • com.azure.communication.phonenumbers.PhoneNumbersClient

public final class PhoneNumbersClient

Synchronous client for Communication service phone number operations.

Instantiating a synchronous Phone Numbers Client

PhoneNumbersClient phoneNumberClient = new PhoneNumbersClientBuilder()
     .endpoint(endpoint)
     .credential(keyCredential)
     .httpClient(httpClient)
     .buildClient();

Method Summary

Modifier and Type	Method and Description
SyncPoller<PhoneNumberOperation,PurchasePhoneNumbersResult>	beginPurchasePhoneNumbers(String searchId) Starts the purchase of the phone number(s) in the search result associated with a given id.
SyncPoller<PhoneNumberOperation,PurchasePhoneNumbersResult>	beginPurchasePhoneNumbers(String searchId, Context context) Starts the purchase of the phone number(s) in the search result associated with a given id.
SyncPoller<PhoneNumberOperation,ReleasePhoneNumberResult>	beginReleasePhoneNumber(String phoneNumber) Starts the update of capabilities for a purchased phone number.
SyncPoller<PhoneNumberOperation,ReleasePhoneNumberResult>	beginReleasePhoneNumber(String phoneNumber, Context context) Starts the update of capabilities for a purchased phone number.
SyncPoller<PhoneNumberOperation,PhoneNumberSearchResult>	beginSearchAvailablePhoneNumbers(String countryCode, PhoneNumberType phoneNumberType, PhoneNumberAssignmentType assignmentType, PhoneNumberCapabilities capabilities) Starts the search for available phone numbers to purchase.
SyncPoller<PhoneNumberOperation,PhoneNumberSearchResult>	beginSearchAvailablePhoneNumbers(String countryCode, PhoneNumberType phoneNumberType, PhoneNumberAssignmentType assignmentType, PhoneNumberCapabilities capabilities, PhoneNumberSearchOptions searchOptions, Context context) Starts the search for available phone numbers to purchase.
SyncPoller<PhoneNumberOperation,PurchasedPhoneNumber>	beginUpdatePhoneNumberCapabilities(String phoneNumber, PhoneNumberCapabilities capabilities) Update capabilities of a purchased phone number.
SyncPoller<PhoneNumberOperation,PurchasedPhoneNumber>	beginUpdatePhoneNumberCapabilities(String phoneNumber, PhoneNumberCapabilities capabilities, Context context) Update capabilities of a purchased phone number.
PurchasedPhoneNumber	getPurchasedPhoneNumber(String phoneNumber) Gets information about a purchased phone number.
Response<PurchasedPhoneNumber>	getPurchasedPhoneNumberWithResponse(String phoneNumber, Context context) Gets information about a purchased phone number with response.
PagedIterable<PhoneNumberCountry>	listAvailableCountries() Gets the list of the available countries.
PagedIterable<PhoneNumberCountry>	listAvailableCountries(Context context) Gets the list of the purchased phone numbers with context.
PagedIterable<PhoneNumberAreaCode>	listAvailableGeographicAreaCodes(String countryCode, PhoneNumberAssignmentType assignmentType, String locality, String administrativeDivision) Gets the list of the available Geographic area codes for a given country and locality.
PagedIterable<PhoneNumberAreaCode>	listAvailableGeographicAreaCodes(String countryCode, PhoneNumberAssignmentType assignmentType, String locality, String administrativeDivision, Context context) Gets the list of the available Geographic area codes for a given country and locality.
PagedIterable<PhoneNumberLocality>	listAvailableLocalities(String countryCode, String administrativeDivision) Gets the list of the available localities.
PagedIterable<PhoneNumberLocality>	listAvailableLocalities(String countryCode, String administrativeDivision, Context context) Gets the list of the available localities.
PagedIterable<PhoneNumberOffering>	listAvailableOfferings(String countryCode, PhoneNumberType phoneNumberType, PhoneNumberAssignmentType assignmentType) Gets the list of the available phone number offerings for the given country.
PagedIterable<PhoneNumberOffering>	listAvailableOfferings(String countryCode, PhoneNumberType phoneNumberType, PhoneNumberAssignmentType assignmentType, Context context) Gets the list of the available phone number offerings for the given country.
PagedIterable<PhoneNumberAreaCode>	listAvailableTollFreeAreaCodes(String countryCode) Gets the list of the available Toll-Free area codes for a given country.
PagedIterable<PhoneNumberAreaCode>	listAvailableTollFreeAreaCodes(String countryCode, Context context) Gets the list of the available Toll-Free area codes for a given country.
PagedIterable<PurchasedPhoneNumber>	listPurchasedPhoneNumbers() Gets the list of the purchased phone numbers.
PagedIterable<PurchasedPhoneNumber>	listPurchasedPhoneNumbers(Context context) Gets the list of the purchased phone numbers with context.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

beginPurchasePhoneNumbers

public SyncPoller beginPurchasePhoneNumbers(String searchId)

Starts the purchase of the phone number(s) in the search result associated with a given id. This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.

Code Samples

PollResponse<PhoneNumberOperation> purchaseResponse =
     phoneNumberClient.beginPurchasePhoneNumbers(searchId).waitForCompletion();
 System.out.println("Purchase phone numbers is complete: " + purchaseResponse.getStatus());

Parameters:

searchId - ID of the search

Returns:

A SyncPoller<T,U> object with PurchasePhoneNumbersResult.

beginPurchasePhoneNumbers

public SyncPoller beginPurchasePhoneNumbers(String searchId, Context context)

Starts the purchase of the phone number(s) in the search result associated with a given id. This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.

Code Samples

PollResponse<PhoneNumberOperation> purchaseResponse = phoneNumberClient
         .beginPurchasePhoneNumbers(searchId, Context.NONE).waitForCompletion();
 System.out.println("Purchase phone numbers is complete: " + purchaseResponse.getStatus());

Parameters:

searchId - ID of the search

context - A Context representing the request context.

Returns:

A SyncPoller<T,U> object with PurchasePhoneNumbersResult.

beginReleasePhoneNumber

public SyncPoller beginReleasePhoneNumber(String phoneNumber)

Starts the update of capabilities for a purchased phone number. This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.

Code Samples

PollResponse<PhoneNumberOperation> releaseResponse =
     phoneNumberClient.beginReleasePhoneNumber("+18001234567").waitForCompletion();
 System.out.println("Release phone number is complete: " + releaseResponse.getStatus());

Parameters:

phoneNumber - The phone number id in E.164 format. The leading plus can be either + or encoded as %2B.

Returns:

A SyncPoller<T,U> object with ReleasePhoneNumberResult.

beginReleasePhoneNumber

public SyncPoller beginReleasePhoneNumber(String phoneNumber, Context context)

Starts the update of capabilities for a purchased phone number. This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.

Code Samples

PollResponse<PhoneNumberOperation> releaseResponse = phoneNumberClient
         .beginReleasePhoneNumber("+18001234567", Context.NONE).waitForCompletion();
 System.out.println("Release phone number is complete: " + releaseResponse.getStatus());

Parameters:

phoneNumber - The phone number id in E.164 format. The leading plus can be either + or encoded as %2B.

context - A Context representing the request context.

Returns:

A SyncPoller<T,U> object with ReleasePhoneNumberResult.

beginSearchAvailablePhoneNumbers

public SyncPoller beginSearchAvailablePhoneNumbers(String countryCode, PhoneNumberType phoneNumberType, PhoneNumberAssignmentType assignmentType, PhoneNumberCapabilities capabilities)

Starts the search for available phone numbers to purchase. This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.

Code Samples

PhoneNumberCapabilities capabilities = new PhoneNumberCapabilities()
         .setCalling(PhoneNumberCapabilityType.INBOUND)
         .setSms(PhoneNumberCapabilityType.INBOUND_OUTBOUND);

 SyncPoller<PhoneNumberOperation, PhoneNumberSearchResult> poller = phoneNumberClient
         .beginSearchAvailablePhoneNumbers("US", PhoneNumberType.TOLL_FREE,
                 PhoneNumberAssignmentType.APPLICATION, capabilities);
 PollResponse<PhoneNumberOperation> response = poller.waitForCompletion();
 String searchId = "";

 if (LongRunningOperationStatus.SUCCESSFULLY_COMPLETED == response.getStatus()) {
     PhoneNumberSearchResult searchResult = poller.getFinalResult();
     searchId = searchResult.getSearchId();
     System.out.println("Searched phone numbers: " + searchResult.getPhoneNumbers());
     System.out.println("Search expires by: " + searchResult.getSearchExpiresBy());
     System.out.println("Phone number costs:" + searchResult.getCost().getAmount());
 }

Parameters:

countryCode - The ISO 3166-2 country code.

phoneNumberType - PhoneNumberType The phone number type.

assignmentType - PhoneNumberAssignmentType The phone number assignment type.

capabilities - PhoneNumberCapabilities The phone number capabilities.

Returns:

A SyncPoller<T,U> object with the reservation result.

beginSearchAvailablePhoneNumbers

public SyncPoller beginSearchAvailablePhoneNumbers(String countryCode, PhoneNumberType phoneNumberType, PhoneNumberAssignmentType assignmentType, PhoneNumberCapabilities capabilities, PhoneNumberSearchOptions searchOptions, Context context)

Starts the search for available phone numbers to purchase. This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.

Code Samples

PhoneNumberCapabilities capabilities = new PhoneNumberCapabilities()
         .setCalling(PhoneNumberCapabilityType.INBOUND)
         .setSms(PhoneNumberCapabilityType.INBOUND_OUTBOUND);
 PhoneNumberSearchOptions searchOptions = new PhoneNumberSearchOptions().setAreaCode("800").setQuantity(1);

 SyncPoller<PhoneNumberOperation, PhoneNumberSearchResult> poller = phoneNumberClient
         .beginSearchAvailablePhoneNumbers("US", PhoneNumberType.TOLL_FREE,
                 PhoneNumberAssignmentType.APPLICATION, capabilities, searchOptions, Context.NONE);
 PollResponse<PhoneNumberOperation> response = poller.waitForCompletion();
 String searchId = "";

 if (LongRunningOperationStatus.SUCCESSFULLY_COMPLETED == response.getStatus()) {
     PhoneNumberSearchResult searchResult = poller.getFinalResult();
     searchId = searchResult.getSearchId();
     System.out.println("Searched phone numbers: " + searchResult.getPhoneNumbers());
     System.out.println("Search expires by: " + searchResult.getSearchExpiresBy());
     System.out.println("Phone number costs:" + searchResult.getCost().getAmount());
 }

Parameters:

countryCode - The ISO 3166-2 country code.

phoneNumberType - PhoneNumberType The phone number type.

assignmentType - PhoneNumberAssignmentType The phone number assignment type.

capabilities - PhoneNumberCapabilities The phone number capabilities.

searchOptions - The phone number search options.

context - A Context representing the request context.

Returns:

A SyncPoller<T,U> object with the reservation result.

beginUpdatePhoneNumberCapabilities

public SyncPoller beginUpdatePhoneNumberCapabilities(String phoneNumber, PhoneNumberCapabilities capabilities)

Update capabilities of a purchased phone number. This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.

Code Samples

PhoneNumberCapabilities capabilities = new PhoneNumberCapabilities();
 capabilities
         .setCalling(PhoneNumberCapabilityType.INBOUND)
         .setSms(PhoneNumberCapabilityType.INBOUND_OUTBOUND);

 SyncPoller<PhoneNumberOperation, PurchasedPhoneNumber> poller = phoneNumberClient
         .beginUpdatePhoneNumberCapabilities("+18001234567", capabilities);
 PollResponse<PhoneNumberOperation> response = poller.waitForCompletion();

 if (LongRunningOperationStatus.SUCCESSFULLY_COMPLETED == response.getStatus()) {
     PurchasedPhoneNumber phoneNumber = poller.getFinalResult();
     System.out.println("Phone Number Calling capabilities: " + phoneNumber.getCapabilities().getCalling());
     System.out.println("Phone Number SMS capabilities: " + phoneNumber.getCapabilities().getSms());
 }

Parameters:

phoneNumber - The phone number id in E.164 format. The leading plus can be either + or encoded as %2B.

capabilities - Update capabilities of a purchased phone number.

Returns:

A SyncPoller<T,U> object with purchased phone number.

beginUpdatePhoneNumberCapabilities

public SyncPoller beginUpdatePhoneNumberCapabilities(String phoneNumber, PhoneNumberCapabilities capabilities, Context context)

Update capabilities of a purchased phone number. This function returns a Long Running Operation poller that allows you to wait indefinitely until the operation is complete.

Code Samples

PhoneNumberCapabilities capabilities = new PhoneNumberCapabilities();
 capabilities
         .setCalling(PhoneNumberCapabilityType.INBOUND)
         .setSms(PhoneNumberCapabilityType.INBOUND_OUTBOUND);

 SyncPoller<PhoneNumberOperation, PurchasedPhoneNumber> poller = phoneNumberClient
         .beginUpdatePhoneNumberCapabilities("+18001234567", capabilities, Context.NONE);
 PollResponse<PhoneNumberOperation> response = poller.waitForCompletion();

 if (LongRunningOperationStatus.SUCCESSFULLY_COMPLETED == response.getStatus()) {
     PurchasedPhoneNumber phoneNumber = poller.getFinalResult();
     System.out.println("Phone Number Calling capabilities: " + phoneNumber.getCapabilities().getCalling());
     System.out.println("Phone Number SMS capabilities: " + phoneNumber.getCapabilities().getSms());
 }

Parameters:

phoneNumber - The phone number id in E.164 format. The leading plus can be either + or encoded as %2B.

capabilities - Update capabilities of a purchased phone number.

context - A Context representing the request context.

Returns:

A SyncPoller<T,U> object with purchased phone number.

getPurchasedPhoneNumber

public PurchasedPhoneNumber getPurchasedPhoneNumber(String phoneNumber)

Gets information about a purchased phone number.

Code Samples

PurchasedPhoneNumber phoneNumber = phoneNumberClient.getPurchasedPhoneNumber("+18001234567");
 System.out.println("Phone Number Value: " + phoneNumber.getPhoneNumber());
 System.out.println("Phone Number Country Code: " + phoneNumber.getCountryCode());

Parameters:

phoneNumber - The phone number id in E.164 format. The leading plus can be either + or encoded as %2B.

Returns:

PurchasedPhoneNumber representing the purchased telephone number.

getPurchasedPhoneNumberWithResponse

public Response getPurchasedPhoneNumberWithResponse(String phoneNumber, Context context)

Gets information about a purchased phone number with response.

Code Samples

Response<PurchasedPhoneNumber> response = phoneNumberClient
         .getPurchasedPhoneNumberWithResponse("+18001234567", Context.NONE);
 PurchasedPhoneNumber phoneNumber = response.getValue();
 System.out.println("Phone Number Value: " + phoneNumber.getPhoneNumber());
 System.out.println("Phone Number Country Code: " + phoneNumber.getCountryCode());

Parameters:

phoneNumber - The phone number id in E.164 format. The leading plus can be either + or encoded as %2B.

context - A Context representing the request context.

Returns:

PurchasedPhoneNumber representing the purchased telephone number.

listAvailableCountries

public PagedIterable listAvailableCountries()

Gets the list of the available countries.

Returns:

A PagedIterable<T> of PhoneNumberCountry instances representing available countries.

listAvailableCountries

public PagedIterable listAvailableCountries(Context context)

Gets the list of the purchased phone numbers with context.

Parameters:

context - A Context representing the request context.

Returns:

A PagedIterable<T> of PhoneNumberCountry instances representing purchased telephone numbers.

listAvailableGeographicAreaCodes

public PagedIterable listAvailableGeographicAreaCodes(String countryCode, PhoneNumberAssignmentType assignmentType, String locality, String administrativeDivision)

Gets the list of the available Geographic area codes for a given country and locality.

Parameters:

countryCode - The ISO 3166-2 country code.

assignmentType - PhoneNumberAssignmentType The phone number assignment type.

locality - The name of the locality (e.g. city or town name) in which to fetch area codes.

administrativeDivision - An optional parameter. The name of the administrative division (e.g. state or province) of the locality.

Returns:

A PagedIterable<T> of PhoneNumberAreaCode instances representing purchased telephone numbers.

listAvailableGeographicAreaCodes

public PagedIterable listAvailableGeographicAreaCodes(String countryCode, PhoneNumberAssignmentType assignmentType, String locality, String administrativeDivision, Context context)

Gets the list of the available Geographic area codes for a given country and locality.

Parameters:

countryCode - The ISO 3166-2 country code.

assignmentType - PhoneNumberAssignmentType The phone number assignment type.

locality - The name of the locality (e.g. city or town name) in which to fetch area codes.

administrativeDivision - An optional parameter. The name of the administrative division (e.g. state or province) of the locality.

context - A Context representing the request context.

Returns:

A PagedIterable<T> of PhoneNumberAreaCode instances representing purchased telephone numbers.

listAvailableLocalities

public PagedIterable listAvailableLocalities(String countryCode, String administrativeDivision)

Gets the list of the available localities. I.e. cities, towns.

Parameters:

countryCode - The ISO 3166-2 country code.

administrativeDivision - An optional parameter. The name or short name of the state/province within which to list the localities.

Returns:

A PagedIterable<T> of PhoneNumberLocality instances representing available localities with phone numbers.

listAvailableLocalities

public PagedIterable listAvailableLocalities(String countryCode, String administrativeDivision, Context context)

Gets the list of the available localities. I.e. cities, towns.

Parameters:

countryCode - The ISO 3166-2 country code.

administrativeDivision - An optional parameter. The name or short name of the state/province within which to list the localities.

context - A Context representing the request context.

Returns:

A PagedIterable<T> of PhoneNumberLocality instances representing available localities with phone numbers.

listAvailableOfferings

public PagedIterable listAvailableOfferings(String countryCode, PhoneNumberType phoneNumberType, PhoneNumberAssignmentType assignmentType)

Gets the list of the available phone number offerings for the given country.

Parameters:

countryCode - The ISO 3166-2 country code.

phoneNumberType - PhoneNumberType Optional parameter. Restrict the offerings to the phone number type.

assignmentType - PhoneNumberAssignmentType Optional parameter. Restrict the offerings to the assignment type.

Returns:

A PagedIterable<T> of PurchasedPhoneNumber instances representing purchased telephone numbers.

listAvailableOfferings

public PagedIterable listAvailableOfferings(String countryCode, PhoneNumberType phoneNumberType, PhoneNumberAssignmentType assignmentType, Context context)

Gets the list of the available phone number offerings for the given country.

Parameters:

countryCode - The ISO 3166-2 country code.

phoneNumberType - PhoneNumberType Optional parameter. Restrict the offerings to the phone number type.

assignmentType - PhoneNumberAssignmentType Optional parameter. Restrict the offerings to the assignment type.

context - A Context representing the request context.

Returns:

A PagedIterable<T> of PurchasedPhoneNumber instances representing purchased telephone numbers.

listAvailableTollFreeAreaCodes

public PagedIterable listAvailableTollFreeAreaCodes(String countryCode)

Gets the list of the available Toll-Free area codes for a given country.

Parameters:

countryCode - The ISO 3166-2 country code.

Returns:

A PagedIterable<T> of PhoneNumberAreaCode instances representing available area codes.

listAvailableTollFreeAreaCodes

public PagedIterable listAvailableTollFreeAreaCodes(String countryCode, Context context)

Gets the list of the available Toll-Free area codes for a given country.

Parameters:

countryCode - The ISO 3166-2 country code.

context - A Context representing the request context.

Returns:

A PagedIterable<T> of PhoneNumberAreaCode instances representing available area codes.

listPurchasedPhoneNumbers

public PagedIterable listPurchasedPhoneNumbers()

Gets the list of the purchased phone numbers.

Code Samples

PagedIterable<PurchasedPhoneNumber> phoneNumbers = phoneNumberClient.listPurchasedPhoneNumbers();
 PurchasedPhoneNumber phoneNumber = phoneNumbers.iterator().next();
 System.out.println("Phone Number Value: " + phoneNumber.getPhoneNumber());
 System.out.println("Phone Number Country Code: " + phoneNumber.getCountryCode());

Returns:

A PagedIterable<T> of PurchasedPhoneNumber instances representing purchased telephone numbers.

listPurchasedPhoneNumbers

public PagedIterable listPurchasedPhoneNumbers(Context context)

Gets the list of the purchased phone numbers with context.

Code Samples

PagedIterable<PurchasedPhoneNumber> phoneNumbers = phoneNumberClient.listPurchasedPhoneNumbers(Context.NONE);
 PurchasedPhoneNumber phoneNumber = phoneNumbers.iterator().next();
 System.out.println("Phone Number Value: " + phoneNumber.getPhoneNumber());
 System.out.println("Phone Number Country Code: " + phoneNumber.getCountryCode());

Parameters:

context - A Context representing the request context.

Returns:

A PagedIterable<T> of PurchasedPhoneNumber instances representing purchased telephone numbers.