Skip to main content

Overview

Clears unread counts for specified conversations.

Request

Authentication: Add authentication headers to the request. See Authentication.

Method: POST

Rate limit: 100 requests/second

Endpoint: https://API domain/apigateway/convers/clearunread

Content-Type: application/json

Request Parameters

ParameterData TypeRequiredDescription
user_idstringYesID of the user whose unread counts are cleared. Maximum length: 32 characters.
itemsarrayYesConversations whose unread counts are cleared.
items[].target_idstringYesConversation target ID. Maximum length: 32 characters.
items[].channel_typeintYesConversation type.

Request Example

POST /apigateway/convers/clearunread HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json

{
"user_id":"userid1",
"items":[
{
"target_id":"userid2",
"channel_type":1
},
{
"target_id":"groupid1",
"channel_type":2
}
]
}

Response Example

{
"code":0,
"msg":"sucess"
}