---
name: "getGroupDeviceNum"
mode: "kit"
versionRequirements:
  - { name: "DeviceKit", version: "2.4.0" }
  - { name: "@ray-js/ray", version: "0.6.23" }
platform:
  - "iOS"
  - "Android"
async: true
title: "getGroupDeviceNum - 获取群组下设备数量"
---

## getGroupDeviceNum

> [VERSION] DeviceKit >= 2.4.0 | @ray-js/ray >= 0.6.23

> [PLATFORM] iOS, Android

> ⚡ **支持 Promise 调用** — 不传 success / fail / complete 回调时，该方法返回 Promise。

### 描述

获取群组下设备数量

### 参数

| 属性 | 类型 | 必填 | 默认值 | 最低版本 | 描述 |
| --- | --- | --- | --- | --- | --- |
| `groupId` | `string` | 是 | - | `2.4.0` | 群组id |
| `complete` | `() => void` | 否 | - | - | 接口调用结束的回调函数（调用成功、失败都会执行） |
| `success` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用成功的回调函数 |
| `fail` | `(params: Object) => void` ↓见下方 | 否 | - | - | 接口调用失败的回调函数 |

#### success 回调参数

| 属性 | 类型 | 最低版本 | 描述 |
| --- | --- | --- | --- |
| `groupId` | `string` | `3.3.0` | groupId 群组id |
| `deviceNum` | `number` | `4.13.1` | deviceNum 设备数量 |
| `devieNum` | `number` | `3.3.0` | devieNum 设备数量 |

#### fail 回调参数

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorMsg` | `string` | 错误信息 |
| `errorCode` | `string \| number` | 错误码 |
| `innerError` | `Object` | 错误扩展 |

##### fail(params).innerError 的属性

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `errorCode` | `string \| number` | 错误扩展码 |
| `errorMsg` | `string` | 错误扩展信息 |


### 示例代码

#### 基础调用

```tsx
import { device } from '@ray-js/ray'

const { getGroupDeviceNum } = device;

getGroupDeviceNum({
  groupId: 'example',
  success: (result) => {
    console.log('getGroupDeviceNum success', result);
  },
  fail: (error) => {
    console.log('getGroupDeviceNum fail', error.errorMsg);
  },
});
```