Package com.ringcentral.definitions

Class GetExtensionInfoResponse

java.lang.Object

com.ringcentral.definitions.GetExtensionInfoResponse

public class GetExtensionInfoResponse
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
GetExtensionAccountInfo	account
AssignedCountryInfo	assignedCountry
CallQueueExtensionInfo	callQueueInfo
ContactInfo	contact
CostCenterInfo	costCenter
CustomFieldInfo[]	customFields
DepartmentInfo[]	departments	Information on department extension(s), to which the requested extension belongs.
String	extensionNumber	Extension short number
String[]	extensionNumbers
Boolean	hidden	Hides extension from showing in company directory.
Long	id	Internal identifier of an extension Format: int64
String	name	Extension name.
String	partnerId	For Partner Applications Internal identifier of an extension created by partner.
ExtensionPermissions	permissions
ProfileImageInfo	profileImage
ReferenceInfo[]	references	List of non-RC internal identifiers assigned to an extension
RegionalSettings	regionalSettings
Roles[]	roles
ExtensionServiceFeatureInfo[]	serviceFeatures	Extension service features is returned in response only when the logged-in user requests their own extension info, see also Extension Service Features
String	setupWizardState	Specifies extension configuration wizard state (web service setup) Default: NotStarted Enum: NotStarted, Incomplete, Completed
ProvisioningSiteInfo	site
String	status	Extension current state.
ExtensionStatusInfo	statusInfo
String	subType	Extension subtype, if applicable.
String	type	Extension type.
String	uri	Canonical URI of an extension Format: uri

Constructor Summary

Constructors

Constructor	Description
GetExtensionInfoResponse()

Method Summary

Modifier and Type	Method	Description
GetExtensionInfoResponse	account(GetExtensionAccountInfo account)
GetExtensionInfoResponse	assignedCountry(AssignedCountryInfo assignedCountry)
GetExtensionInfoResponse	callQueueInfo(CallQueueExtensionInfo callQueueInfo)
GetExtensionInfoResponse	contact(ContactInfo contact)
GetExtensionInfoResponse	costCenter(CostCenterInfo costCenter)
GetExtensionInfoResponse	customFields(CustomFieldInfo[] customFields)
GetExtensionInfoResponse	departments(DepartmentInfo[] departments)
GetExtensionInfoResponse	extensionNumber(String extensionNumber)
GetExtensionInfoResponse	extensionNumbers(String[] extensionNumbers)
GetExtensionInfoResponse	hidden(Boolean hidden)
GetExtensionInfoResponse	id(Long id)
GetExtensionInfoResponse	name(String name)
GetExtensionInfoResponse	partnerId(String partnerId)
GetExtensionInfoResponse	permissions(ExtensionPermissions permissions)
GetExtensionInfoResponse	profileImage(ProfileImageInfo profileImage)
GetExtensionInfoResponse	references(ReferenceInfo[] references)
GetExtensionInfoResponse	regionalSettings(RegionalSettings regionalSettings)
GetExtensionInfoResponse	roles(Roles[] roles)
GetExtensionInfoResponse	serviceFeatures(ExtensionServiceFeatureInfo[] serviceFeatures)
GetExtensionInfoResponse	setupWizardState(String setupWizardState)
GetExtensionInfoResponse	site(ProvisioningSiteInfo site)
GetExtensionInfoResponse	status(String status)
GetExtensionInfoResponse	statusInfo(ExtensionStatusInfo statusInfo)
GetExtensionInfoResponse	subType(String subType)
GetExtensionInfoResponse	type(String type)
GetExtensionInfoResponse	uri(String uri)

Methods inherited from class java.lang.Object

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

Field Details

id

public Long id

Internal identifier of an extension Format: int64

uri

public String uri

Canonical URI of an extension Format: uri

account

public GetExtensionAccountInfo account

contact

public ContactInfo contact

costCenter

public CostCenterInfo costCenter

customFields

public CustomFieldInfo[] customFields

departments

public DepartmentInfo[] departments

Information on department extension(s), to which the requested extension belongs. Returned only for user extensions, members of department, requested by single extensionId. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology

extensionNumber

public String extensionNumber

Extension short number

extensionNumbers

public String[] extensionNumbers

name

public String name

Extension name. For user extension types the value is a combination of the specified first name and last name

partnerId

public String partnerId

For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using `pid=XXX` clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension

permissions

public ExtensionPermissions permissions

profileImage

public ProfileImageInfo profileImage

references

public ReferenceInfo[] references

List of non-RC internal identifiers assigned to an extension

roles

public Roles[] roles

regionalSettings

public RegionalSettings regionalSettings

serviceFeatures

public ExtensionServiceFeatureInfo[] serviceFeatures

Extension service features is returned in response only when the logged-in user requests their own extension info, see also Extension Service Features

setupWizardState

public String setupWizardState

Specifies extension configuration wizard state (web service setup) Default: NotStarted Enum: NotStarted, Incomplete, Completed

status

public String status

Extension current state. If 'Unassigned' is specified, then extensions without `extensionNumber` are returned. If not specified, then all extensions are returned Enum: Enabled, Disabled, Frozen, NotActivated, Unassigned

statusInfo

public ExtensionStatusInfo statusInfo

type

public String type

Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology Enum: User, FaxUser, FlexibleUser, VirtualUser, DigitalUser, Department, Announcement, Voicemail, SharedLinesGroup, PagingOnly, IvrMenu, ApplicationExtension, ParkLocation, Bot, Room, RoomConnector, Limited, Site, ProxyAdmin, DelegatedLinesGroup, GroupCallPickup

subType

public String subType

Extension subtype, if applicable. For any unsupported subtypes the `Unknown` value will be returned Enum: VideoPro, VideoProPlus, DigitalSignage, Unknown

callQueueInfo

public CallQueueExtensionInfo callQueueInfo

hidden

public Boolean hidden

Hides extension from showing in company directory. Supported for extensions of User type only

site

public ProvisioningSiteInfo site

assignedCountry

public AssignedCountryInfo assignedCountry

Constructor Details

GetExtensionInfoResponse

public GetExtensionInfoResponse()

Method Details

id

public GetExtensionInfoResponse id(Long id)

uri

public GetExtensionInfoResponse uri(String uri)

account

public GetExtensionInfoResponse account(GetExtensionAccountInfo account)

contact

public GetExtensionInfoResponse contact(ContactInfo contact)

costCenter

public GetExtensionInfoResponse costCenter(CostCenterInfo costCenter)

customFields

public GetExtensionInfoResponse customFields(CustomFieldInfo[] customFields)

departments

public GetExtensionInfoResponse departments(DepartmentInfo[] departments)

extensionNumber

public GetExtensionInfoResponse extensionNumber(String extensionNumber)

extensionNumbers

public GetExtensionInfoResponse extensionNumbers(String[] extensionNumbers)

name

public GetExtensionInfoResponse name(String name)

partnerId

public GetExtensionInfoResponse partnerId(String partnerId)

permissions

public GetExtensionInfoResponse permissions(ExtensionPermissions permissions)

profileImage

public GetExtensionInfoResponse profileImage(ProfileImageInfo profileImage)

references

public GetExtensionInfoResponse references(ReferenceInfo[] references)

roles

public GetExtensionInfoResponse roles(Roles[] roles)

regionalSettings

public GetExtensionInfoResponse regionalSettings(RegionalSettings regionalSettings)

serviceFeatures

public GetExtensionInfoResponse serviceFeatures(ExtensionServiceFeatureInfo[] serviceFeatures)

setupWizardState

public GetExtensionInfoResponse setupWizardState(String setupWizardState)

status

public GetExtensionInfoResponse status(String status)

statusInfo

public GetExtensionInfoResponse statusInfo(ExtensionStatusInfo statusInfo)

type

public GetExtensionInfoResponse type(String type)

subType

public GetExtensionInfoResponse subType(String subType)

callQueueInfo

public GetExtensionInfoResponse callQueueInfo(CallQueueExtensionInfo callQueueInfo)

hidden

public GetExtensionInfoResponse hidden(Boolean hidden)

site

public GetExtensionInfoResponse site(ProvisioningSiteInfo site)

assignedCountry

public GetExtensionInfoResponse assignedCountry(AssignedCountryInfo assignedCountry)