Platform APIEnterprise

Mark a conversation read through a Seq

Advance a user's read position in a conversation to the specified message Seq. Use this for read-state migration or correction when the exact read boundary is known.

HTTP request

POST {API_ADDRESS}/msg/mark_conversation_read

Request example

curl --request POST "${API_ADDRESS}/msg/mark_conversation_read" \
  --header "Content-Type: application/json; charset=utf-8" --header "operationID: ${OPERATION_ID}" --header "token: ${TOKEN}" \
  --data-raw '{"conversationID":"si_user_001_user_002","userID":"user_001","seq":125}'

Request body

Parameter	Required	Type	Description
conversationID	Yes	string	OpenIM conversation ID.
userID	Yes	string	User whose read position is updated.
seq	Yes	int	Last message Seq treated as read.

Response

The common response has errCode: 0 when the read position was updated successfully.

Errors

See Error codes.

Permissions and limits

Available only in OpenIM Enterprise.
Validate that the Seq belongs to the specified conversation before changing imported state.

Set a conversation unread count

Was this page helpful?