Package com.ringcentral.definitions

Class ListAccountPhoneNumbersV2Parameters

java.lang.Object

com.ringcentral.definitions.ListAccountPhoneNumbersV2Parameters

public class ListAccountPhoneNumbersV2Parameters
extends Object

Query parameters for operation listAccountPhoneNumbersV2

Field Summary

Fields

Modifier and Type	Field	Description
String	extensionStatus	Extension status Enum: Enabled, Disabled, Frozen, NotActivated, Unassigned
Long	page	The result set page number (1-indexed) to return Maximum: 1000 Minimum: 1 Format: int32 Example: 1 Default: 1
Long	perPage	The number of items per page.
String	phoneNumber	Phone number in e.164 format to be searched for.
String	status	Status of a phone number.
String	tollType	Indicates if a number is toll or toll-free Example: Toll Enum: Toll, TollFree
String[]	type	Types of phone numbers to be returned Enum: VoiceFax, VoiceOnly, FaxOnly
String[]	usageType	Usage type(s) of phone numbers to be returned Enum: MainCompanyNumber, DirectNumber, Inventory, InventoryPartnerBusinessMobileNumber, PartnerBusinessMobileNumber, AdditionalCompanyNumber, CompanyNumber, PhoneLine, CompanyFaxNumber, ForwardedNumber, ForwardedCompanyNumber, ContactCenterNumber, ConferencingNumber, MeetingsNumber, BusinessMobileNumber, ELIN

Constructor Summary

Constructors

Constructor	Description
ListAccountPhoneNumbersV2Parameters()

Method Summary

Modifier and Type	Method	Description
ListAccountPhoneNumbersV2Parameters	extensionStatus(String extensionStatus)
ListAccountPhoneNumbersV2Parameters	page(Long page)
ListAccountPhoneNumbersV2Parameters	perPage(Long perPage)
ListAccountPhoneNumbersV2Parameters	phoneNumber(String phoneNumber)
ListAccountPhoneNumbersV2Parameters	status(String status)
ListAccountPhoneNumbersV2Parameters	tollType(String tollType)
ListAccountPhoneNumbersV2Parameters	type(String[] type)
ListAccountPhoneNumbersV2Parameters	usageType(String[] usageType)

Methods inherited from class java.lang.Object

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

Field Details

page

public Long page

The result set page number (1-indexed) to return Maximum: 1000 Minimum: 1 Format: int32 Example: 1 Default: 1

perPage

public Long perPage

The number of items per page. If provided value in the request is greater than a maximum, the maximum value is applied Maximum: 1000 Minimum: 1 Format: int32 Example: 100 Default: 100

type

public String[] type

Types of phone numbers to be returned Enum: VoiceFax, VoiceOnly, FaxOnly

usageType

public String[] usageType

Usage type(s) of phone numbers to be returned Enum: MainCompanyNumber, DirectNumber, Inventory, InventoryPartnerBusinessMobileNumber, PartnerBusinessMobileNumber, AdditionalCompanyNumber, CompanyNumber, PhoneLine, CompanyFaxNumber, ForwardedNumber, ForwardedCompanyNumber, ContactCenterNumber, ConferencingNumber, MeetingsNumber, BusinessMobileNumber, ELIN

status

public String status

Status of a phone number. If the value is 'Normal', the phone number is ready to be used. Otherwise, it is an external number not yet ported to RingCentral Enum: Normal, Pending, PortedIn, Temporary, Unknown

tollType

public String tollType

Indicates if a number is toll or toll-free Example: Toll Enum: Toll, TollFree

extensionStatus

public String extensionStatus

Extension status Enum: Enabled, Disabled, Frozen, NotActivated, Unassigned

phoneNumber

public String phoneNumber

Phone number in e.164 format to be searched for. Parameter value can include wildcards (e.g. "+165012345**") or be an exact number "+16501234500" - single number is searched in that case. Make sure you escape the "+" in the URL as "%2B"

Constructor Details

ListAccountPhoneNumbersV2Parameters

public ListAccountPhoneNumbersV2Parameters()

Method Details

page

public ListAccountPhoneNumbersV2Parameters page(Long page)

perPage

public ListAccountPhoneNumbersV2Parameters perPage(Long perPage)

type

public ListAccountPhoneNumbersV2Parameters type(String[] type)

usageType

public ListAccountPhoneNumbersV2Parameters usageType(String[] usageType)

status

public ListAccountPhoneNumbersV2Parameters status(String status)

tollType

public ListAccountPhoneNumbersV2Parameters tollType(String tollType)

extensionStatus

public ListAccountPhoneNumbersV2Parameters extensionStatus(String extensionStatus)

phoneNumber

public ListAccountPhoneNumbersV2Parameters phoneNumber(String phoneNumber)