ClearConversationUnread
https://zim-api.zego.im/
This API can clear the unread message count of a specified conversation for a specified user.
The client will receive changes in the unread count of the conversation through the following ZIM SDK callback:
| iOS | Android | macOS | Windows |
|---|---|---|---|
| conversationChanged | onConversationChanged | conversationChanged | onConversationChanged |
| Web | Mini Program | Flutter | React Native |
|---|---|---|---|
| conversationChanged | conversationChanged | onConversationChanged | conversationChanged |
| Unity3D | uni-app | uni-app x | HarmonyOS |
|---|---|---|
| OnConversationChanged | conversationChanged | conversationChanged |
Request
Query Parameters
- 0 for one-on-one;
- 2 for group.
Possible values: [ClearConversationUnread]
API prototype parameter
https://zim-api.zego.im/?Action=ClearConversationUnread
💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.
💡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature example for how to generate.
💡Public parameter. Current Unix timestamp, in seconds. Refer to Signature example for how to generate, with a maximum error of 10 minutes.
Possible values: [2.0]
Default value: 2.0
💡Public parameter. Signature version number.
💡Public parameter. Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate an API request signature.
Possible values: <= 32 characters
Target user ID (registered). This API clears the unread message count of a conversation for this user.
Possible values: <= 32 characters
Target conversation ID. For one-on-one chats, it is the user ID; for group chats, it is the group ID.
Possible values: [0, 2]
Conversation type:
Responses
- 200
- application/json