跳到主要内容

按会话设置免打扰

设置会话的消息免打扰状态​

方法​

即时通讯业务用户为指定会话或超级群设置免打扰级别，支持单聊、群聊、超级群会话。

TypeScript

changeConversationNotificationLevel(
  type: RCIMIWConversationType, 
  targetId: string, 
  channelId: string, 
  level: RCIMIWPushNotificationLevel, 
  callback: IRCIMIWChangeConversationNotificationLevelCallback
): Promise<number>;

参数说明​

参数名参数类型描述
typeRCIMIWConversationType会话类型。请注意以下限制：
  • 超级群会话类型：如在 2022.09.01 之前开通超级群业务，默认不支持为单个超级群会话所有消息设置免打扰级别（“所有消息”指所有频道中的消息和不属于任何频道的消息）。该接口仅设置指定超级群会话（targetId）中不属于任何频道的消息的免打扰状态级别。如需修改请提交工单。
  • 聊天室会话类型：不支持，因为聊天室消息默认不支持消息推送提醒。
targetIdstring会话 ID
channelIdstring超级群的会话频道 ID。其他类型传 null 即可。
  • 如果传入频道 ID，则针对该指定频道设置消息免打扰级别。如果不指定频道 ID，则对所有超级群消息生效。
  • 注意：2022.09.01 之前开通超级群业务的客户，如果不指定频道 ID，则默认传 "" 空字符串，即仅针对指定超级群会话（targetId）中不属于任何频道的消息设置免打扰状态级别。如需修改请提交工单。
levelRCIMIWPushNotificationLevel消息通知级别
callbackIRCIMIWChangeConversationNotificationLevelCallback接口调用结果回调。

返回值​

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

代码示例​

TypeScript

const callback = {
    onConversationNotificationLevelChanged: (code: number) => {
        //...
    },
};
let code = await engine.changeConversationNotificationLevel(type, targetId, channelId, level, callback);

获取会话的免打扰状态​

查询当前用户为指定会话设置的免打扰级别

方法​

TypeScript

getConversationNotificationLevel(
  type: RCIMIWConversationType, 
  targetId: string, 
  channelId: string, 
  callback: IRCIMIWGetConversationNotificationLevelCallback
): Promise<number>;

参数说明​

参数名参数类型描述
typeRCIMIWConversationType会话类型。请注意以下限制：
  • 超级群会话类型：如在 2022.09.01 之前开通超级群业务，默认不支持为单个超级群会话所有消息设置免打扰级别（“所有消息”指所有频道中的消息和不属于任何频道的消息）。该接口仅设置指定超级群会话（targetId）中不属于任何频道的消息的免打扰状态级别。如需修改请提交工单。
  • 聊天室会话类型：不支持，因为聊天室消息默认不支持消息推送提醒。
targetIdstring会话 ID
channelIdstring超级群的会话频道 ID。其他类型传 null 即可。
  • 如果传入频道 ID，则针对该指定频道设置消息免打扰级别。如果不指定频道 ID，则对所有超级群消息生效。
  • 注意：2022.09.01 之前开通超级群业务的客户，如果不指定频道 ID，则默认传 "" 空字符串，即仅针对指定超级群会话（targetId）中不属于任何频道的消息设置免打扰状态级别。如需修改请提交工单。
callbackIRCIMIWGetConversationNotificationLevelCallback接口调用结果回调。

返回值​

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

代码示例​

TypeScript

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

获取免打扰状态列表​

获取所有设置了消息免打扰的会话列表。

方法​

TypeScript

getBlockedConversations(
  conversationTypes: Array<RCIMIWConversationType>, 
  channelId: string, 
  callback: IRCIMIWGetBlockedConversationsCallback
): Promise<number>;

参数说明​

TypeScript

getBlockedConversations(
  conversationTypes: Array<RCIMIWConversationType>, 
  channelId: string, 
  callback: IRCIMIWGetBlockedConversationsCallback
): Promise<number>;

返回值​

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

代码示例​

TypeScript

const callback = {
    onSuccess: (t: Array<RCIMIWConversation>) => {
        //...
    },
    onError: (code: number) => {
        //...
    },
};
let code = await engine.getBlockedConversations(conversationTypes, channelId, callback);

最后于 更新