Package com.ringcentral.definitions

Class UserPhoneNumberInfo

java.lang.Object

com.ringcentral.definitions.UserPhoneNumberInfo

public class UserPhoneNumberInfo
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	callerIdName	Caller ID Name
ContactCenterProvider	contactCenterProvider
CountryInfoBasicModel	country
UserPhoneNumberExtensionInfo	extension
String[]	features	List of features of a phone number Enum: CallerId, SmsSender, A2PSmsSender, MmsSender, InternationalSmsSender, Delegated
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	Indicates if a phone number is primary, i.e.
String	status	Status of a phone number.
String	subType	Extension subtype, if applicable.
String	type	Type of a phone number Enum: VoiceFax, VoiceOnly, FaxOnly
String	uri	Link to the user phone number resource Format: uri
String	usageType	Usage type of a phone number.

Constructor Summary

Constructors

Constructor	Description
UserPhoneNumberInfo()

Method Summary

Modifier and Type	Method	Description
UserPhoneNumberInfo	callerIdName(String callerIdName)
UserPhoneNumberInfo	contactCenterProvider(ContactCenterProvider contactCenterProvider)
UserPhoneNumberInfo	country(CountryInfoBasicModel country)
UserPhoneNumberInfo	extension(UserPhoneNumberExtensionInfo extension)
UserPhoneNumberInfo	features(String[] features)
UserPhoneNumberInfo	id(Long id)
UserPhoneNumberInfo	label(String label)
UserPhoneNumberInfo	location(String location)
UserPhoneNumberInfo	paymentType(String paymentType)
UserPhoneNumberInfo	phoneNumber(String phoneNumber)
UserPhoneNumberInfo	primary(Boolean primary)
UserPhoneNumberInfo	status(String status)
UserPhoneNumberInfo	subType(String subType)
UserPhoneNumberInfo	type(String type)
UserPhoneNumberInfo	uri(String uri)
UserPhoneNumberInfo	usageType(String usageType)

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 the user phone number resource Format: uri

id

public Long id

Internal identifier of a phone number Format: int64

country

public CountryInfoBasicModel country

contactCenterProvider

public ContactCenterProvider contactCenterProvider

extension

public UserPhoneNumberExtensionInfo 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

primary

public Boolean primary

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

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

subType

public String subType

Extension subtype, if applicable. For unrecognized subtypes the `Unknown` value is returned Enum: VideoPro, VideoProPlus, DigitalSignageOnlyRooms, Unknown, Emergency

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

features

public String[] features

List of features of a phone number Enum: CallerId, SmsSender, A2PSmsSender, MmsSender, InternationalSmsSender, Delegated

callerIdName

public String callerIdName

Caller ID Name

Constructor Details

UserPhoneNumberInfo

public UserPhoneNumberInfo()

Method Details

uri

public UserPhoneNumberInfo uri(String uri)

id

public UserPhoneNumberInfo id(Long id)

country

public UserPhoneNumberInfo country(CountryInfoBasicModel country)

contactCenterProvider

public UserPhoneNumberInfo contactCenterProvider(ContactCenterProvider contactCenterProvider)

extension

public UserPhoneNumberInfo extension(UserPhoneNumberExtensionInfo extension)

label

public UserPhoneNumberInfo label(String label)

location

public UserPhoneNumberInfo location(String location)

paymentType

public UserPhoneNumberInfo paymentType(String paymentType)

phoneNumber

public UserPhoneNumberInfo phoneNumber(String phoneNumber)

primary

public UserPhoneNumberInfo primary(Boolean primary)

status

public UserPhoneNumberInfo status(String status)

type

public UserPhoneNumberInfo type(String type)

subType

public UserPhoneNumberInfo subType(String subType)

usageType

public UserPhoneNumberInfo usageType(String usageType)

features

public UserPhoneNumberInfo features(String[] features)

callerIdName

public UserPhoneNumberInfo callerIdName(String callerIdName)