Skip to main content

ExtensionCreationResponse

Properties

NameTypeRequiredDescription
id_intInternal identifier of an extension
uristrCanonical URI of an extension
contactContactInfoDetailed contact information
cost_centerCostCenterInfoCost center information. Applicable if Cost Center feature is enabled. The default is root cost center value
custom_fieldsList[CustomFieldInfo]
extension_numberstrExtension number
namestrExtension name. For user extension types the value is a combination of the specified first name and last name
partner_idstrFor Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the 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
permissionsExtensionPermissionsExtension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling'
profile_imageProfileImageInfoInformation on profile image
referencesList[ReferenceInfo]List of non-RC internal identifiers assigned to an extension
regional_settingsRegionalSettingsRegional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings
service_featuresList[ExtensionServiceFeatureInfo]Extension service features returned in response only when the logged-in user requests his/her own extension info, see also Extension Service Features
setup_wizard_stateSetupWizardStateForUpdateEnumInitial configuration wizard state
siteProvisioningSiteInfoSite data. If multi-site feature is turned on for an account, then ID of a site must be specified. In order to assign a wireless point to the main site (company) the site ID should be set to main-site
statusExtensionCreationResponseStatusExtension current state. If 'Unassigned' is specified, then extensions without extensionNumber are returned. If not specified, then all extensions are returned
status_infoExtensionStatusInfoStatus information (reason, comment). Returned for 'Disabled' status only
type_ExtensionCreationResponseTypeExtension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology
hiddenboolHides an extension from showing in company directory. Supported for extensions of 'User' type only
assigned_countryAssignedCountryInfoInformation on a country assigned to an extension user. Returned for the User extension type only

ExtensionCreationResponseStatus

Extension current state. If 'Unassigned' is specified, then extensions without extensionNumber are returned. If not specified, then all extensions are returned

Properties

NameTypeRequiredDescription
ENABLEDstr"Enabled"
DISABLEDstr"Disabled"
FROZENstr"Frozen"
NOTACTIVATEDstr"NotActivated"
UNASSIGNEDstr"Unassigned"

ExtensionCreationResponseType

Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology

Properties

NameTypeRequiredDescription
USERstr"User"
VIRTUALUSERstr"VirtualUser"
DIGITALUSERstr"DigitalUser"
FLEXIBLEUSERstr"FlexibleUser"
DEPARTMENTstr"Department"
ANNOUNCEMENTstr"Announcement"
VOICEMAILstr"Voicemail"
SHAREDLINESGROUPstr"SharedLinesGroup"
PAGINGONLYstr"PagingOnly"
PARKLOCATIONstr"ParkLocation"
LIMITEDstr"Limited"

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →