跳到主要内容

获取未读数

超级群业务支持从客户端 SDK 获取未读消息数，具体如下：

  • 当前用户加入的所有超级群、指定超级群、或指定频道未读消息数。
  • 当前用户加入的所有超级群、指定超级群、或指定频道的未读 @ 消息数。
  • 按免打扰级别获取总未读消息数
提示

返回的未读数最大值为 999。如果实际未读数超过 999，接口仍返回 999。

获取所有超级群会话的未读消息数​

获取当前用户加入的所有超级群会话的未读消息数的总和。

方法​

TypeScript

getUltraGroupAllUnreadCount(
  callback: IRCIMIWGetUltraGroupAllUnreadCountCallback
): Promise<number>;

返回值​

返回值描述
number当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

代码示例​

TypeScript

const callback = {
    onSuccess: (t: number) => {
        //...
    },
    onError: (code: number) => {
        //...
    },
};
let code = await engine.getUltraGroupAllUnreadCount(callback);

所有超级群会话中的未读 @ 消息数​

获取当前用户加入的所有超级群会话中的未读 @ 消息数的总和。

方法​

TypeScript

getUltraGroupAllUnreadMentionedCount(
  callback: IRCIMIWGetUltraGroupAllUnreadMentionedCountCallback
): Promise<number>;

返回值​

返回值描述
number当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

代码示例​

TypeScript

const callback = {
    onSuccess: (t: number) => {
        //...
    },
    onError: (code: number) => {
        //...
    },
};
let code = await engine.getUltraGroupAllUnreadMentionedCount(callback);

获取指定会话的未读消息数​

获取当前用户加入的所有超级群会话的未读消息数的总和。

方法​

TypeScript

getUltraGroupUnreadCount(
  targetId: string, 
  callback: IRCIMIWGetUltraGroupUnreadCountCallback
): Promise<number>;

参数说明​

参数名参数类型描述
targetIdstring会话 ID
callbackIRCIMIWGetUltraGroupUnreadCountCallback接口调用结果回调。

返回值​

返回值描述
number当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

代码示例​

TypeScript

const callback = {
    onSuccess: (t: number) => {
        //...
    },
    onError: (code: number) => {
        //...
    },
};
let code = await engine.getUltraGroupUnreadCount(targetId, callback);

获取指定单个超级群的未读 @ 消息数​

获取当前用户在指定超级群中的未读 @ 消息数

方法​

TypeScript

getUltraGroupUnreadMentionedCount(
  targetId: string, 
  callback: IRCIMIWGetUltraGroupUnreadMentionedCountCallback
): Promise<number>;

参数说明​

参数名参数类型描述
targetIdstring会话 ID
callbackIRCIMIWGetUltraGroupUnreadMentionedCountCallback接口调用结果回调。

返回值​

返回值描述
number当次接口操作的状态码。0 代表接口调用成功，具体业务结果需要从接口回调获取，非 0 代表当前接口调用操作失败，不会触发接口回调，详细错误参考错误码

代码示例​

TypeScript

const callback = {
    onSuccess: (t: number) => {
        //...
    },
    onError: (code: number) => {
        //...
    },
};
let code = await engine.getUltraGroupUnreadMentionedCount(targetId, callback);

最后于 更新