[**RongIMLib**](../README.md)

***

[RongIMLib](../globals.md) / subscribeUserStatus

# Function: subscribeUserStatus()

> **subscribeUserStatus**(`userIds`, `subscribeType`, `expiry`): `Promise`\<[`RCResult`](../interfaces/RCResult.md)\<`string`[]\>\>

订阅用户状态

## Parameters

### userIds

`string`[]

被订阅用户 ID 列表，一次最多订阅 200 个用户

### subscribeType

[`SubscribeType`](../enumerations/SubscribeType.md)

订阅类型

### expiry

`number`

订阅有效期，取值范围为 [60,2592000]（单位：秒）

## Returns

`Promise`\<[`RCResult`](../interfaces/RCResult.md)\<`string`[]\>\>

返回一个 [RCResult](../interfaces/RCResult.md) 类型 Promise，订阅错误为 26021 时返回被订阅达上限（用户最多可以被 5000 个用户订阅）的用户 ID 列表

## Description

此方法用于订阅一组用户的状态。当这些用户的状态发生变化时，将通过回调接口通知调用者
**注意**：
1. 一次订阅用户的上限为 200 个，订阅的用户数最多为 1000 个，一个用户最多可以被 5000 个用户订阅
2. 订阅用户在线状态能力需要开通服务，开通路径：IM 服务 > IM 服务管理 > 客户端用户在线状态订阅

## Since

5.9.8

## Example

**订阅用户状态示例：**

```ts
const userIds = ['user1', 'user2'];
const subscribeType = RongIMLib.SubscribeType.ONLINE_STATUS;
// 设置订阅时间，取值范围为 [60,2592000]（单位：秒）。
const expiry = 60;
const res = await RongIMLib.subscribeUserStatus(userIds, subscribeType, expiry);
console.log('订阅用户状态结果：', res);
```