---
name: "getDeviceListByDevIds"
mode: "kit"
versionRequirements:
  - { name: "DeviceKit", version: "3.3.0" }
platform:
  - "iOS"
  - "Android"
async: true
---

## getDeviceListByDevIds

> [VERSION] DeviceKit >= 3.3.0

> [PLATFORM] iOS, Android

> ⚡ **Supports Promise** — Returns a Promise when success / fail / complete callbacks are omitted.

### Description

Get the device info list by a list of device IDs

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `deviceIds` | `string[]` | Yes | - | `3.3.0` | deviceId Device IDs |
| `complete` | `() => void` | No | - | - | Callback invoked when the API call finishes (runs on both success and failure) |
| `success` | `(params: Object) => void` ↓see below | No | - | - | Callback invoked on successful API call |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Callback invoked on failed API call |

#### success callback parameters

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `deviceInfos` | `DeviceInfo[]` | `3.3.0` | Device info list |

#### fail callback parameters

| Property | Type | Description |
| --- | --- | --- |
| `errorMsg` | `string` | Error message |
| `errorCode` | `string \| number` | Error code |
| `innerError` | `Object` | Error extension |

##### fail(params).innerError properties

| Property | Type | Description |
| --- | --- | --- |
| `errorCode` | `string \| number` | Extended error code |
| `errorMsg` | `string` | Extended error information |


### Referenced Types

##### `interface` DeviceInfo

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `roomName` | `string` | `3.6.0` | Device room name |
| `schema` | `Record<string, any>[]` | `3.3.0` | Includes product information, schema, and function definitions |
| `dps` | `Record<string, Record<string, any>>` | `3.3.0` | dps Device function point states. Use the corresponding dpid to get specific state values for business logic. |
| `attribute` | `number` | `3.3.0` | attribute Product attribute definition; the corresponding configuration can be found on the backend-ng platform; managed using bitwise operations |
| `baseAttribute` | `number` | `3.5.0` | baseAttribute Basic product attribute definitions |
| `capability` | `number` | `3.3.0` | capability Product capability value; the corresponding options can be queried on the backend-ng platform; overall business logic is partitioned based on this data Device type classification can also be adjusted based on this attribute; managed using bitwise operations |
| `dpName` | `Record<string, string>` | `3.3.0` | dpName Custom name for a dp, typically used in the panel |
| `ability` | `number` | `3.3.0` | ability Seldom used; distinguishes special device types |
| `icon` | `string` | `3.3.0` | icon Device icon URL |
| `devId` | `string` | `3.3.0` | devId Unique device ID |
| `verSw` | `string` | `3.3.0` | verSw Device firmware version |
| `isShare` | `boolean` | `3.3.0` | isShare Whether it is a shared device; true means shared |
| `bv` | `string` | `3.3.0` | bv Device baseline version |
| `uuid` | `string` | `3.3.0` | uuid Unique firmware identifier |
| `panelConfig` | `Record<string, Record<string, any>>` | `3.3.0` | panelConfig Configuration items in the product panel, typically viewable on the IoT platform |
| `activeTime` | `number` | `3.3.0` | activeTime Device activation time, timestamp |
| `devAttribute` | `number` | `3.3.0` | devAttribute Device business capability extensions, managed via bitwise flags |
| `pcc` | `string` | `3.3.0` | pcc Classification identifier for Thing self-developed Bluetooth mesh products |
| `nodeId` | `string` | `3.3.0` | nodeId Short address of the sub-device |
| `parentId` | `string` | `3.3.0` | parentId Parent node ID. Usually present on sub-devices or Bluetooth Mesh devices; used internally to locate the related gateway or parent model for business processing |
| `category` | `string` | `3.3.0` | category Product category |
| `standSchemaModel` | `Record<string, any>` | `3.3.0` | standSchemaModel Standard product function-set definition model |
| `productId` | `string` | `3.3.0` | productId Product ID associated with the device |
| `productVer` | `string` | `4.3.6` | productVer Version of the associated product |
| `bizAttribute` | `number` | `3.3.0` | bizAttribute Business attribute capabilities |
| `meshId` | `string` | `3.3.0` | meshId Bluetooth Mesh ID of the current device |
| `sigmeshId` | `string` | `3.3.0` | [Deprecated] sigmeshId Bluetooth Mesh ID corresponding to the device's industry attribute |
| `meta` | `Record<string, Record<string, any>>` | `3.3.0` | meta Custom configuration meta attributes of the device, used to store business data |
| `isLocalOnline` | `boolean` | `3.3.0` | isLocalOnline Whether the local network (LAN) is online |
| `isCloudOnline` | `boolean` | `3.3.0` | Cloud online status of the device |
| `isOnline` | `boolean` | `3.3.0` | isOnline Overall online status. If any condition is online, the device is considered online; composite status |
| `name` | `string` | `3.3.0` | name Device name |
| `groupId` | `string` | `3.3.0` | groupId The group ID the device belongs to; empty string if not in a group |
| `dpCodes` | `Record<string, Record<string, any>>` | `3.3.0` | dpCodes Standard function set codes |
| `devTimezoneId` | `string` | `3.3.0` | Time zone information |
| `dpsTime` | `Record<string, Record<string, any>>` | `3.3.0` | Time when the device's function points executed |
| `latitude` | `string` | `3.3.0` | Device latitude |
| `longitude` | `string` | `3.3.0` | Device longitude |
| `ip` | `string` | `3.3.0` | Device IP address |
| `isVirtualDevice` | `boolean` | `3.3.0` | Whether it is a virtual device |
| `isZigbeeInstallCode` | `boolean` | `3.3.0` | Whether this is a Zigbee install-code gateway |
| `protocolAttribute` | `number` | `3.3.0` | Sub-device activation capability flag |
| `connectionStatus` | `number` | `3.3.0` | Connection status, nearby status |
| `mac` | `string` | `3.3.0` | Some devices require MAC address–based unique identification, e.g., Mesh |
| `bluetoothCapability` | `string` | `3.3.0` | Bluetooth device capability value, reported by the device |
| `isTripartiteMatter` | `boolean` | `3.6.0` | Whether it is a third-party Matter device |
| `isGW` | `boolean` | `3.6.0` | Whether it is a gateway device |
| `isSupportGroup` | `boolean` | `3.6.0` | Whether groups are supported |
| `isZigBeeSubDev` | `boolean` | `3.6.0` | Whether it is a Zigbee sub-device |
| `cadv` | `string` | `3.6.0` | cadv version |
| `isSupportOTA` | `boolean` | `3.6.0` | Whether the device supports OTA |
| `iconUrl` | `string` | `3.6.0` | Device icon |
| `hasWifi` | `boolean` | `3.6.0` | Whether the device has a Wi‑Fi module |
| `switchDp` | `number` | `3.7.0` | Quick control DP |
| `switchDps` | `number[]` | `3.7.0` | Quick control DP |
| `wifiEnableState` | `number` | `4.0.0` | Status of the device’s Wi‑Fi module: 1: unavailable, 2: available |
| `configMetas` | `Record<string, Record<string, any>>` | `4.0.0` | Device product configuration |
| `isMatter` | `boolean` | `4.0.0` | Whether it is a Matter device |
| `isSupportLink` | `boolean` | `4.0.0` | Whether the device supports dual-control |
| `isSupportAppleHomeKit` | `boolean` | `4.0.0` | Whether the device supports adding to Apple Home |
| `attributeString` | `string` | `4.0.0` | attribute formatted binary string Product attribute definition; the corresponding configuration can be found on the backend-ng platform; managed using bitwise operations |
| `extModuleType` | `number` | `4.3.4` | Type of the device’s extension module 0: no extension module 1: extension module present; the device is BLE+x 2: extension module is a Wi‑Fi module; the device is BLE+Wi‑Fi |
| `isRelayOpen` | `boolean` | `4.6.1` | Whether the Mesh device’s relay feature is enabled |
| `isProxyOpen` | `boolean` | `4.6.1` | Whether the Mesh device’s proxy feature is enabled |
| `isSupportProxyAndRelay` | `boolean` | `4.6.1` | Whether the Mesh device supports proxy and relay features |
| `yuNetState` | `number` | `4.11.0` | Device Dayu channel user enable status: 0 - disabled, 1 - enabled |