Package com.ringcentral.definitions

Class AccountPhoneNumberInfo

java.lang.Object

com.ringcentral.definitions.AccountPhoneNumberInfo

public class AccountPhoneNumberInfo
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
String	activationStatus	Phone number activation status.
Boolean	byocNumber
String	callerIdName	Caller ID Name
ContactCenterProvider	contactCenterProvider
AccountPhoneNumberInfoExtension	extension	Reference to the extension this number is assigned to.
Boolean	hotDeskNumber	Indicates whether the phone number belongs to a Hot Desk device if applicable.
String	id	Internal unique identifier of a phone number Required Example: 1162820004
String	label	Custom user-defined name of a phone number, if any
Boolean	mobileNumber
String	phoneNumber	Phone number in e.164 format (with '+' prefix) Required Example: +16501234567
Boolean	primary	Indicates if a phone number is primary, i.e.
String	providerId	Internal identifier of a phone provider
String	status	Status of a phone number.
String	tollType	Indicates if a number is toll or toll-free Required Example: Toll Enum: Toll, TollFree
String	type	Type of a phone number Enum: VoiceFax, VoiceOnly, FaxOnly
String	usageType	Usage type of a phone number Required Enum: MainCompanyNumber, DirectNumber, Inventory, InventoryPartnerBusinessMobileNumber, InventoryFmcBusinessMobileNumber, PartnerBusinessMobileNumber, AdditionalCompanyNumber, CompanyNumber, PhoneLine, CompanyFaxNumber, ForwardedNumber, ForwardedCompanyNumber, ContactCenterNumber, ConferencingNumber, MeetingsNumber, NumberStorage, BusinessMobileNumber, FmcBusinessMobileNumber, ELIN, InventoryMobileNumber

Constructor Summary

Constructors

Constructor	Description
AccountPhoneNumberInfo()

Method Summary

Modifier and Type	Method	Description
AccountPhoneNumberInfo	activationStatus(String activationStatus)
AccountPhoneNumberInfo	byocNumber(Boolean byocNumber)
AccountPhoneNumberInfo	callerIdName(String callerIdName)
AccountPhoneNumberInfo	contactCenterProvider(ContactCenterProvider contactCenterProvider)
AccountPhoneNumberInfo	extension(AccountPhoneNumberInfoExtension extension)
AccountPhoneNumberInfo	hotDeskNumber(Boolean hotDeskNumber)
AccountPhoneNumberInfo	id(String id)
AccountPhoneNumberInfo	label(String label)
AccountPhoneNumberInfo	mobileNumber(Boolean mobileNumber)
AccountPhoneNumberInfo	phoneNumber(String phoneNumber)
AccountPhoneNumberInfo	primary(Boolean primary)
AccountPhoneNumberInfo	providerId(String providerId)
AccountPhoneNumberInfo	status(String status)
AccountPhoneNumberInfo	tollType(String tollType)
AccountPhoneNumberInfo	type(String type)
AccountPhoneNumberInfo	usageType(String usageType)

Methods inherited from class java.lang.Object

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

Field Details

activationStatus

public String activationStatus

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

id

public String id

Internal unique identifier of a phone number Required Example: 1162820004

phoneNumber

public String phoneNumber

Phone number in e.164 format (with '+' prefix) Required Example: +16501234567

type

public String type

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

tollType

public String tollType

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

usageType

public String usageType

Usage type of a phone number Required Enum: MainCompanyNumber, DirectNumber, Inventory, InventoryPartnerBusinessMobileNumber, InventoryFmcBusinessMobileNumber, PartnerBusinessMobileNumber, AdditionalCompanyNumber, CompanyNumber, PhoneLine, CompanyFaxNumber, ForwardedNumber, ForwardedCompanyNumber, ContactCenterNumber, ConferencingNumber, MeetingsNumber, NumberStorage, BusinessMobileNumber, FmcBusinessMobileNumber, ELIN, InventoryMobileNumber

byocNumber

public Boolean byocNumber

mobileNumber

public Boolean mobileNumber

hotDeskNumber

public Boolean hotDeskNumber

Indicates whether the phone number belongs to a Hot Desk device if applicable.

contactCenterProvider

public ContactCenterProvider contactCenterProvider

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 Required Enum: Normal, Pending, PortedIn, Temporary, Unknown

callerIdName

public String callerIdName

Caller ID Name

label

public String label

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

primary

public Boolean primary

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

extension

public AccountPhoneNumberInfoExtension extension

Reference to the extension this number is assigned to. Omitted for company numbers

providerId

public String providerId

Internal identifier of a phone provider

Constructor Details

AccountPhoneNumberInfo

public AccountPhoneNumberInfo()

Method Details

activationStatus

public AccountPhoneNumberInfo activationStatus(String activationStatus)

id

public AccountPhoneNumberInfo id(String id)

phoneNumber

public AccountPhoneNumberInfo phoneNumber(String phoneNumber)

type

public AccountPhoneNumberInfo type(String type)

tollType

public AccountPhoneNumberInfo tollType(String tollType)

usageType

public AccountPhoneNumberInfo usageType(String usageType)

byocNumber

public AccountPhoneNumberInfo byocNumber(Boolean byocNumber)

mobileNumber

public AccountPhoneNumberInfo mobileNumber(Boolean mobileNumber)

hotDeskNumber

public AccountPhoneNumberInfo hotDeskNumber(Boolean hotDeskNumber)

contactCenterProvider

public AccountPhoneNumberInfo contactCenterProvider(ContactCenterProvider contactCenterProvider)

status

public AccountPhoneNumberInfo status(String status)

callerIdName

public AccountPhoneNumberInfo callerIdName(String callerIdName)

label

public AccountPhoneNumberInfo label(String label)

primary

public AccountPhoneNumberInfo primary(Boolean primary)

extension

public AccountPhoneNumberInfo extension(AccountPhoneNumberInfoExtension extension)

providerId

public AccountPhoneNumberInfo providerId(String providerId)