--- title: "List Extension Devices" method: GET path: "/restapi/v1.0/account/{accountId}/extension/{extensionId}/device" tags: ["Devices"] --- # List Extension Devices `GET /restapi/v1.0/account/{accountId}/extension/{extensionId}/device` Returns devices of an extension or multiple extensions by their ID(s). Batch request is supported. ## Path parameters - `accountId` string, required - `extensionId` string, required ## Query parameters - `page` integer - `perPage` integer - `linePooling` 'Host' | 'Guest' | 'None' - `feature` 'BLA' | 'CommonPhone' | 'Intercom' | 'Paging' | 'HELD' — Device feature - `type` 'HardPhone' | 'SoftPhone' | 'OtherPhone' | 'MobileDevice' | 'BLA' | 'Paging' | 'WebPhone' | 'WebRTC' | 'Room' - `lineType` 'Unknown' | 'Standalone' | 'StandaloneFree' | 'BlaPrimary' | 'BlaSecondary' — The type of phone line ## Response `200` Extension devices information - GetExtensionDevicesResponse - `uri` string, uri — Link to a list of extension devices - `records` DeviceResource[], required — List of extension devices - `id` string — Internal identifier of a device - `uri` string, uri — Canonical URI of a device - `sku` string — Device identification number (SKU, Stock Keeping Unit) in the format TP-ID [-AT-AC], where TP is device type (HP for RC desk phones, DV for all other devices including soft phones); ID - device model ID; AT - add-on type ID; AC - add-on count (if any). For example 'HP-56-2-2' - `type` 'BLA' | 'SoftPhone' | 'OtherPhone' | 'HardPhone' | 'WebPhone' | 'Paging' | 'Room' | 'WebRTC' — Device type - `name` string — Device name. Mandatory if ordering SoftPhone or OtherPhone. Optional for HardPhone. If not specified for HardPhone, then a device model is used as a device name - `serial` string — Serial number for HardPhone (is returned only when the phone is shipped and provisioned); endpoint ID for SoftPhone and mobile applications - `status` 'Offline' | 'Online' — Device status - `computerName` string — Computer name (for devices of `SoftPhone` type only) - `model` ModelInfo — HardPhone model information - `id` string — Internal identifier of a HardPhone device model - `name` string — Device name - `addons` AddonInfo[] — Add-ons description - `id` string - `name` string - `count` integer - `deviceClass` string - `features` DeviceFeatureEnum[] — Device feature or multiple features supported - `lineCount` integer — Max supported count of phone lines - `extension` ExtensionInfoIntId — This attribute can be omitted for unassigned devices - `id` integer — Internal identifier of an extension - `uri` string, uri — Canonical URI of an extension - `extensionNumber` string — Number of extension - `partnerId` string — For 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 - `emergency` DeviceEmergencyInfo — Device emergency settings - `address` CommonEmergencyLocationAddressInfoDefault - `country` string — Country name - `countryId` string — Internal identifier of a country - `countryIsoCode` string — ISO code of a country - `countryName` string — Full name of a country - `state` string — State/Province name. Mandatory for the USA, the UK and Canada - `stateId` string — Internal identifier of a state - `stateIsoCode` string — ISO code of a state - `stateName` string — Full name of a state - `city` string — City name - `street` string — First line address - `street2` string — Second line address (apartment, suite, unit, building, floor, etc.) - `zip` string — Postal (Zip) code - `customerName` string — Customer name - `location` DeviceEmergencyLocationInfo — Company emergency response location details - `id` string — Internal identifier of the emergency response location - `name` string — Location name - `addressFormatId` string — Address format ID - `outOfCountry` boolean — Specifies if emergency address is out of country - `addressStatus` 'Valid' | 'Invalid' | 'Provisioning' — Emergency address status - `visibility` 'Private' | 'Public' — Visibility of an emergency response location. If `Private` is set, then location is visible only for the restricted number of users, specified in `owners` array - `syncStatus` 'Verified' | 'Updated' | 'Deleted' | 'NotRequired' | 'Unsupported' | 'Failed' — Resulting status of the emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to `true` - `addressEditableStatus` 'MainDevice' | 'AnyDevice' — Ability to register new emergency address for a phone line using devices sharing this line or only main device (line owner) - `emergencyServiceAddress` EmergencyServiceAddressResource — Address for emergency cases. The same emergency address is assigned to all the numbers of one device - `street` string - `street2` string - `city` string - `zip` string - `customerName` string - `state` string — State/province name - `stateId` string — Internal identifier of a state - `stateIsoCode` string — ISO code of a state - `stateName` string — Full name of a state - `countryId` string — Internal identifier of a country - `countryIsoCode` string — ISO code of a country - `country` string — Country name - `countryName` string — Full name of a country - `outOfCountry` boolean — Specifies if emergency address is out of country - `syncStatus` 'Verified' | 'Updated' | 'Deleted' | 'NotRequired' | 'Unsupported' | 'Failed' — Resulting status of emergency address synchronization. Returned if `syncEmergencyAddress` parameter is set to `true` - `additionalCustomerName` string — Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia. - `customerEmail` string, email — Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia. - `additionalCustomerEmail` string, email — Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia. - `customerPhone` string — Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia - `additionalCustomerPhone` string — Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia. - `lineProvisioningStatus` 'Provisioning' | 'Valid' | 'Invalid' — Status of digital line provisioning - `taxId` string — Internal identifier of a tax - `phoneLines` PhoneLinesInfo[] — Phone lines information - `id` string — Internal identifier of a phone line - `lineType` 'Unknown' | 'Standalone' | 'StandaloneFree' | 'BlaPrimary' | 'BlaSecondary' — The type of phone line - `phoneInfo` PhoneNumberInfoIntId — Phone number information - `id` integer — Internal identifier of a phone number - `country` PhoneNumberCountryInfo — Brief information on a phone number country - `id` string — Internal identifier of a home country - `uri` string, uri — Canonical URI of a home country - `name` string — Official name of a home country - `extension` DeviceProvisioningExtensionInfo — Information on the extension, to which the phone number is assigned. Returned only for the request of Account phone number list - `id` string — Internal identifier of an extension - `uri` string, uri — Canonical URI of an extension - `extensionNumber` string — Number of extension - `partnerId` string — For 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 - `label` string — Custom user-defined name of a phone number, if any - `location` string — Location (City, State). Filled for local US numbers - `paymentType` 'External' | 'Local' — Payment type. 'External' is returned for forwarded numbers which are not terminated in the RingCentral phone system - `phoneNumber` string — Phone number - `status` string — 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 - `type` 'VoiceFax' | 'FaxOnly' | 'VoiceOnly' — Phone number type - `usageType` 'MainCompanyNumber' | 'AdditionalCompanyNumber' | 'CompanyNumber' | 'DirectNumber' | 'CompanyFaxNumber' | 'ForwardedNumber' | 'ForwardedCompanyNumber' | 'ContactCenterNumber' — Usage type of the phone number - `emergencyAddress` EmergencyAddress - `required` boolean — If set to `true` then specifying emergency address is required - `localOnly` boolean — If set to `true` then only local emergency address can be specified - `lineProvisioningStatus` 'Valid' | 'Provisioning' | 'Invalid' — This status is associated with a phone line provision state - `shipping` ShippingInfo — Shipping information, according to which devices (in case of HardPhone) or e911 stickers (in case of SoftPhone and OtherPhone) will be delivered to the customer - `status` 'Initial' | 'Accepted' | 'Shipped' — Order item shipping status. It is set to `Initial` when the order is submitted. Then it is changed to `Accepted` when a distributor starts processing the order. Finally, it is changed to `Shipped` which means that the distributor has shipped the device. - `carrier` string — Shipping carrier name. Appears only if the device status is 'Shipped' - `trackingNumber` string — Carrier-specific tracking number. Appears only if the device status is 'Shipped' - `method` ShippingMethodInfo — Devices shipping method. It is required if devices are ordered. Availability of different shipping methods depends on package definition. - `id` '1' | '2' | '3', required — Shipping method ID: - "1" - Ground Shipping (5-7 business days) - "2" - Expedited Shipping (2-days) - "3" - Overnight Shipping - `name` 'Ground' | '2 Day' | 'Overnight' — Method name, corresponding to the identifier - `address` ShippingAddressInfo — Shipping address for the order. If it coincides with the Emergency Service Address, then can be omitted. By default, the same value as the emergencyServiceAddress. Multiple addresses can be specified; in case an order contains several devices, they can be delivered to different addresses - `customerName` string — Name of a primary contact person (receiver) - `additionalCustomerName` string — Name of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia. - `customerEmail` string, email — Email of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia. - `additionalCustomerEmail` string, email — Email of an additional contact person. Should be specified for countries except the US, Canada, the UK and Australia. - `customerPhone` string — Phone number of a primary contact person (receiver). Should be specified for countries except the US, Canada, the UK and Australia - `additionalCustomerPhone` string — Phone number of an additional contact person. Should be specified for countries except the US, Canada, the UK & Australia. - `street` string — Street address, line 1 - street address, P.O. box, company name, c/o - `street2` string — Street address, line 2 - apartment, suite, unit, building, floor, etc. - `city` string — City name - `state` string — State/province name - `stateId` string — Internal identifier of a state - `stateIsoCode` string — ISO code of a state - `stateName` string — Full name of a state - `countryId` string — Internal identifier of a country - `countryIsoCode` string — ISO code of a country - `country` string — Country name - `countryName` string — Full name of a country - `zip` string — Zip code - `taxId` string — National taxpayer identification number. Should be specified for Brazil (CNPJ/CPF number) and Argentina (CUIT number). - `boxBillingId` integer — Box billing identifier of a device. Applicable only for devices of `HardPhone` type. It is an alternative way to identify the device to be ordered. Either `model` structure, or `boxBillingId` must be specified - `useAsCommonPhone` boolean — Supported only for devices assigned to Limited extensions. If true, enables users to log in to this phone as a common phone. - `hotDeskDevice` boolean — This flag indicates whether this device is used for hot desking or not - `inCompanyNet` boolean — Network location status. `true` if the device is located in the configured corporate network (On-Net); `false` for Off-Net location. Parameter is not returned if `EmergencyAddressAutoUpdate` feature is not enabled for the account/user, or if device network location is not determined - `site` DeviceSiteInfo — Site data - `id` string — Internal identifier of a site - `name` string — Name of a site - `lastLocationReportTime` string, date-time — Date/time of receiving last location report in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format including timezone, for example *2016-03-10T18:07:52.534Z - `linePooling` 'Host' | 'Guest' | 'None' — Pooling type of device: - `Host` - device with a standalone paid phone line which can be linked to soft phone client instance; - `Guest` - device with a linked phone line; - `None` - device without a phone line or with a specific line (free, BLA, etc.) - `billingStatement` BillingStatementInfo — Billing information. Returned for device update request if `prestatement` query parameter is set to 'true' - `currency` string — Currency code complying with [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217) standard - `charges` BillingStatementCharges[] - `description` string - `amount` number, double - `feature` string - `freeServiceCredit` number, double - `fees` BillingStatementFees[] - `description` string - `amount` number, double - `freeServiceCredit` number, double - `totalCharged` number, double - `totalCharges` number, double - `totalFees` number, double - `subtotal` number, double - `totalFreeServiceCredit` number, double - `navigation` PageNavigationModel, required — Links to other pages of the current result set - `firstPage` PageNavigationUri - `uri` string, uri — Canonical URI to retrieve the particular page of the result set - `nextPage` PageNavigationUri - `uri` string, uri — Canonical URI to retrieve the particular page of the result set - `previousPage` PageNavigationUri - `uri` string, uri — Canonical URI to retrieve the particular page of the result set - `lastPage` PageNavigationUri - `uri` string, uri — Canonical URI to retrieve the particular page of the result set - `paging` EnumeratedPagingModel, required - `perPage` integer, required — Current page size, describes how many items are in each page. Matches "perPage" parameter from the request. - `page` integer — The current page number. 1-indexed, so the first page is 1 by default. May be omitted if result is empty (because non-existent page was specified or perPage=0 was requested) - `pageStart` integer — The zero-based number of the first element on the current page. Omitted if the page is omitted or result is empty - `pageEnd` integer — The zero-based index of the last element on the current page. Omitted if the page is omitted or result is empty - `totalPages` integer — The total number of pages in a dataset. May be omitted for some resources due to performance reasons - `totalElements` integer — The total number of elements in a dataset. May be omitted for some resource due to performance reasons --- [API](https://skmtc.net/ringcentral/apis/ringcentral-api.md) · [All operations](https://skmtc.net/ringcentral/apis/ringcentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ringcentral/ringcentral-api/revisions/8d602198ec97/schema)