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

## getGroupDeviceNum

> [VERSION] DeviceKit >= 2.4.0

> [PLATFORM] iOS, Android

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

### Description

Get the number of devices in a group

### Parameters

| Property | Type | Required | Default | Since | Description |
| --- | --- | --- | --- | --- | --- |
| `groupId` | `string` | Yes | - | `2.4.0` | Group ID |
| `complete` | `() => void` | No | - | - | Completion callback (called on success or failure) |
| `success` | `(params: Object) => void` ↓see below | No | - | - | Success callback |
| `fail` | `(params: Object) => void` ↓see below | No | - | - | Failure callback |

#### success callback parameters

| Property | Type | Since | Description |
| --- | --- | --- | --- |
| `groupId` | `string` | `3.3.0` | groupId Group ID |
| `deviceNum` | `number` | `4.13.1` | deviceNum Number of devices |
| `devieNum` | `number` | `3.3.0` | devieNum Number of devices |

#### 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 message |