清除单个会话消息未读数

描述

本接口可为指定用户清除指定会话的消息未读数。

说明

本接口默认仅适用于用户最新的 1000 个会话。如需适用于更多会话，请联系 ZEGO 技术支持。

客户端将通过 ZIM SDK 的回调接口，接收会话的未读数变化。

iOS	Android	macOS	Windows
conversationChanged	onConversationChanged	conversationChanged	onConversationChanged
HarmonyOS	Web	小程序	Flutter
conversationChanged	conversationChanged	conversationChanged	onConversationChanged
React Native	uni-app	Unity3D
conversationChanged	conversationChanged	OnConversationChanged

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式 - 公共请求参数。

参数	类型	是否必选	描述
FromUserId	String	是	目标用户 ID（已注册）。本接口为该用户清除一个会话的消息未读数。
ConvId	String	是	目标会话 ID。
ConvType	Number	是	会话类型： 0：单聊。 2：群聊。

说明

FromUserId 仅支持数字，英文字符和 '!'，'#'，'$'，'%'，'&'，'('，')'，'+'，''，':'，';'，'<'，'='，'.'，'>'，'?'，'@'，'['，']'，'^'，'_'，' '，'{'，'}'，'|'，'~'。

Untitled

https://zim-api.zego.im/?Action=ClearConversationUnread
&FromUserId=user1
&ConvId=user2
&ConvType=0
&<公共请求参数>

Copied!

Untitled

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782"
}

Copied!

以下仅列出了接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	说明	处理建议
660800002	会话不存在，或者该会话不适用此接口（不属于最新的 1000 个会话）。	请确认会话 ID 是否正确。