清除单个会话消息未读数
GET
https://zim-api.zego.im/
本接口可为指定用户清除指定会话的消息未读数。
说明
本接口默认仅适用于用户最新的 1000 个会话。如需适用于更多会话，请联系 ZEGO 技术支持。
客户端将通过 ZIM SDK 的回调接口，接收会话的未读数变化。
| iOS | Android | macOS | Windows |
|---|---|---|---|
| conversationChanged | onConversationChanged | conversationChanged | onConversationChanged |
| Web | 小程序 | Flutter | React Native |
|---|---|---|---|
| conversationChanged | conversationChanged | onConversationChanged | conversationChanged |
| Unity3D | uni-app | uni-app x | HarmonyOS |
|---|---|---|
| OnConversationChanged | conversationChanged | conversationChanged |
说明
调用频率限制：20 次/秒。
Request
Query Parameters
Action string必填
可选值: [ClearConversationUnread]
接口原型参数
https://zim-api.zego.im/?Action=ClearConversationUnread
AppId uint32必填
💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。
SignatureNonce string必填
💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考 签名示例。
Timestamp int64必填
💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考 签名示例，最多允许 10 分钟的误差。
SignatureVersion string必填
可选值: [2.0]
默认值: 2.0
💡公共参数。签名版本号。
Signature string必填
💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。
FromUserId string必填
可选值: <= 32 characters
目标用户 ID（已注册）。本接口为该用户清除一个会话的消息未读数。
ConvId string必填
可选值: <= 32 characters
目标会话 ID。单聊为用户 ID，群聊为群组 ID。
ConvType int32必填
可选值: [0, 2]
会话类型：0 单聊；2 群聊。
Responses
- 200
OK
- application/json
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
ZEGO 签名生成器
RESPONSE清除
点击上方 “发送” 按钮，在此处查看响应。