Package com.ringcentral.definitions

Class CompanyPhoneNumberInfo

java.lang.Object

com.ringcentral.definitions.CompanyPhoneNumberInfo

public class CompanyPhoneNumberInfo
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	activationStatus	Phone number activation status.
String	callerIdName	Caller ID Name
ContactCenterProvider	contactCenterProvider
ExtensionInfo	extension
Long	id	Internal identifier of a phone number Format: int64
String	label	Custom user-defined name of a phone number, if any
String	location	Location (City, State).
String	paymentType	Payment type.
String	phoneNumber	Phone number
Boolean	primary	Specifies if a phone number is primary, i.e.
String	status	Status of a phone number.
TemporaryNumberInfo	temporaryNumber
String	type	Type of a phone number Enum: VoiceFax, VoiceOnly, FaxOnly
String	uri	Link to a company phone number resource Format: uri
String	usageType	Usage type of a phone number.
String	vanityPattern	Vanity pattern for this number.

Constructor Summary

Constructors

Constructor	Description
CompanyPhoneNumberInfo()

Method Summary

Modifier and Type	Method	Description
CompanyPhoneNumberInfo	activationStatus(String activationStatus)
CompanyPhoneNumberInfo	callerIdName(String callerIdName)
CompanyPhoneNumberInfo	contactCenterProvider(ContactCenterProvider contactCenterProvider)
CompanyPhoneNumberInfo	extension(ExtensionInfo extension)
CompanyPhoneNumberInfo	id(Long id)
CompanyPhoneNumberInfo	label(String label)
CompanyPhoneNumberInfo	location(String location)
CompanyPhoneNumberInfo	paymentType(String paymentType)
CompanyPhoneNumberInfo	phoneNumber(String phoneNumber)
CompanyPhoneNumberInfo	primary(Boolean primary)
CompanyPhoneNumberInfo	status(String status)
CompanyPhoneNumberInfo	temporaryNumber(TemporaryNumberInfo temporaryNumber)
CompanyPhoneNumberInfo	type(String type)
CompanyPhoneNumberInfo	uri(String uri)
CompanyPhoneNumberInfo	usageType(String usageType)
CompanyPhoneNumberInfo	vanityPattern(String vanityPattern)

Methods inherited from class java.lang.Object

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

Field Details

uri

public String uri

Link to a company phone number resource Format: uri

id

public Long id

Internal identifier of a phone number Format: int64

extension

public ExtensionInfo extension

label

public String label

Custom user-defined name of a phone number, if any

location

public String location

Location (City, State). Filled for local US numbers

paymentType

public String paymentType

Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system Enum: External, TollFree, Local, BusinessMobileNumberProvider, ExternalNumberProvider, ExternalNumberProviderTollFree, Mobile

phoneNumber

public String phoneNumber

Phone number

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

type

public String type

Type of a phone number Enum: VoiceFax, VoiceOnly, FaxOnly

usageType

public String usageType

Usage type of a phone number. Numbers of 'NumberPool' and 'NumberStorage' type are not returned in phone number list requests Enum: MainCompanyNumber, AdditionalCompanyNumber, CompanyNumber, DirectNumber, CompanyFaxNumber, FmcBusinessMobileNumber, InventoryFmcBusinessMobileNumber, ForwardedNumber, ForwardedCompanyNumber, ContactCenterNumber, ConferencingNumber, MeetingsNumber, NumberPool, BusinessMobileNumber, ELIN, PartnerBusinessMobileNumber, NumberPoolPartnerBusinessMobileNumber, NumberStorage, IntegrationNumber, InventoryMobileNumber

temporaryNumber

public TemporaryNumberInfo temporaryNumber

contactCenterProvider

public ContactCenterProvider contactCenterProvider

vanityPattern

public String vanityPattern

Vanity pattern for this number. Returned only when vanity search option is requested. Vanity pattern corresponds to request parameters `nxx` plus `line` or `numberPattern`

primary

public Boolean primary

Specifies if a phone number is primary, i.e. displayed as 'main number' and called by default

activationStatus

public String activationStatus

Phone number activation status. Determine whether phone number migration is completed on the partner side. Enum: Active, Inactive

callerIdName

public String callerIdName

Caller ID Name

Constructor Details

CompanyPhoneNumberInfo

public CompanyPhoneNumberInfo()

Method Details

uri

public CompanyPhoneNumberInfo uri(String uri)

id

public CompanyPhoneNumberInfo id(Long id)

extension

public CompanyPhoneNumberInfo extension(ExtensionInfo extension)

label

public CompanyPhoneNumberInfo label(String label)

location

public CompanyPhoneNumberInfo location(String location)

paymentType

public CompanyPhoneNumberInfo paymentType(String paymentType)

phoneNumber

public CompanyPhoneNumberInfo phoneNumber(String phoneNumber)

status

public CompanyPhoneNumberInfo status(String status)

type

public CompanyPhoneNumberInfo type(String type)

usageType

public CompanyPhoneNumberInfo usageType(String usageType)

temporaryNumber

public CompanyPhoneNumberInfo temporaryNumber(TemporaryNumberInfo temporaryNumber)

contactCenterProvider

public CompanyPhoneNumberInfo contactCenterProvider(ContactCenterProvider contactCenterProvider)

vanityPattern

public CompanyPhoneNumberInfo vanityPattern(String vanityPattern)

primary

public CompanyPhoneNumberInfo primary(Boolean primary)

activationStatus

public CompanyPhoneNumberInfo activationStatus(String activationStatus)

callerIdName

public CompanyPhoneNumberInfo callerIdName(String callerIdName)