GetExtensionInfoResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id_ | int | ❌ | Internal identifier of an extension |
| uri | str | ❌ | Canonical URI of an extension |
| account | GetExtensionAccountInfo | ❌ | Account information |
| contact | ContactInfo | ❌ | Detailed contact information |
| cost_center | CostCenterInfo | ❌ | Cost center information. Applicable if Cost Center feature is enabled. The default is root cost center value |
| custom_fields | List[CustomFieldInfo] | ❌ | |
| departments | List[DepartmentInfo] | ❌ | 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 |
| extension_number | str | ❌ | Extension short number |
| extension_numbers | List[str] | ❌ | |
| name | str | ❌ | Extension name. For user extension types the value is a combination of the specified first name and last name |
| partner_id | str | ❌ | 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 | ExtensionPermissions | ❌ | Extension permissions, corresponding to the Service Web permissions 'Admin' and 'InternationalCalling' |
| profile_image | ProfileImageInfo | ❌ | Information on profile image |
| references | List[ReferenceInfo] | ❌ | List of non-RC internal identifiers assigned to an extension |
| roles | List[Roles] | ❌ | |
| regional_settings | RegionalSettings | ❌ | Regional data (timezone, home country, language) of an extension/account. The default is Company (Auto-Receptionist) settings |
| service_features | List[ExtensionServiceFeatureInfo] | ❌ | Extension service features is returned in response only when the logged-in user requests their own extension info, see also Extension Service Features |
| setup_wizard_state | SetupWizardStateForUpdateEnum | ❌ | Initial configuration wizard state |
| status | GetExtensionInfoResponseStatus | ❌ | Extension current state. If 'Unassigned' is specified, then extensions without extensionNumber are returned. If not specified, then all extensions are returned |
| status_info | ExtensionStatusInfo | ❌ | Status information (reason, comment). Returned for 'Disabled' status only |
| type_ | GetExtensionInfoResponseType | ❌ | Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology |
| sub_type | GetExtensionInfoResponseSubType | ❌ | Extension subtype, if applicable. For any unsupported subtypes the Unknown value will be returned |
| call_queue_info | CallQueueExtensionInfo | ❌ | For Call Queue extension type only. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology |
| hidden | bool | ❌ | Hides extension from showing in company directory. Supported for extensions of User type only |
| site | ProvisioningSiteInfo | ❌ | Site 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 |
| assigned_country | AssignedCountryInfo | ❌ | Information on a country assigned to an extension user. Returned for the User extension type only |
GetExtensionInfoResponseStatus
Extension current state. If 'Unassigned' is specified, then extensions without extensionNumber are returned. If not specified, then all extensions are returned
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| ENABLED | str | ✅ | "Enabled" |
| DISABLED | str | ✅ | "Disabled" |
| FROZEN | str | ✅ | "Frozen" |
| NOTACTIVATED | str | ✅ | "NotActivated" |
| UNASSIGNED | str | ✅ | "Unassigned" |
GetExtensionInfoResponseType
Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| USER | str | ✅ | "User" |
| FAXUSER | str | ✅ | "FaxUser" |
| FLEXIBLEUSER | str | ✅ | "FlexibleUser" |
| VIRTUALUSER | str | ✅ | "VirtualUser" |
| DIGITALUSER | str | ✅ | "DigitalUser" |
| DEPARTMENT | str | ✅ | "Department" |
| ANNOUNCEMENT | str | ✅ | "Announcement" |
| VOICEMAIL | str | ✅ | "Voicemail" |
| SHAREDLINESGROUP | str | ✅ | "SharedLinesGroup" |
| PAGINGONLY | str | ✅ | "PagingOnly" |
| IVRMENU | str | ✅ | "IvrMenu" |
| APPLICATIONEXTENSION | str | ✅ | "ApplicationExtension" |
| PARKLOCATION | str | ✅ | "ParkLocation" |
| BOT | str | ✅ | "Bot" |
| ROOM | str | ✅ | "Room" |
| ROOMCONNECTOR | str | ✅ | "RoomConnector" |
| LIMITED | str | ✅ | "Limited" |
| SITE | str | ✅ | "Site" |
| PROXYADMIN | str | ✅ | "ProxyAdmin" |
| DELEGATEDLINESGROUP | str | ✅ | "DelegatedLinesGroup" |
| GROUPCALLPICKUP | str | ✅ | "GroupCallPickup" |
GetExtensionInfoResponseSubType
Extension subtype, if applicable. For any unsupported subtypes the Unknown value will be returned
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| VIDEOPRO | str | ✅ | "VideoPro" |
| VIDEOPROPLUS | str | ✅ | "VideoProPlus" |
| DIGITALSIGNAGE | str | ✅ | "DigitalSignage" |
| UNKNOWN | str | ✅ | "Unknown" |
| EMERGENCY | str | ✅ | "Emergency" |
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs