In-app Chat
ZIMAudio
On this page

GroupReadReceipt

2026-04-29
POST

https://zim-api.zego.im/

Use this API to set read receipts for group messages sent by a specific user.

Note
Rate limit: 20 requests/second.

Request

Query Parameters

    Action stringrequired

    Possible values: [GroupReadReceipt]

    API prototype parameter

    https://zim-api.zego.im/?Action=GroupReadReceipt

    AppId uint32required

    💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.

    SignatureNonce stringrequired

    💡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature example for how to generate.

    Timestamp int64required

    💡Public parameter. Current Unix timestamp, in seconds. Refer to Signature example for how to generate, with a maximum error of 10 minutes.

    SignatureVersion stringrequired

    Possible values: [2.0]

    Default value: 2.0

    💡Public parameter. Signature version number.

    Signature stringrequired

    💡Public parameter. Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate an API request signature.

Body

required
    FromUserId stringrequired

    The operator. Must be a registered user.

    GroupId stringrequired

    Group ID.

    ConvMsgSeq number[]required

    Message sequence numbers for which read receipts need to be set.

Responses

OK
Schema
    Code number

    Return code. (0 indicates success)

    The following only lists return codes related to the API business logic. For the complete list of return codes, please refer to Global return codes.

    Return CodeDescriptionSolution
    660000002Invalid parameterPlease check the parameters
    660300005Rate limit exceededPlease try again later
    660400102Number of read receipt messages exceeds the limitContact technical support
    660400103Failed to set read receipts for group messagesContact technical support
    Message string

    Return status message.

    RequestId string

    Unique request identifier.

    ReadTime number

    Server timestamp when the read receipt is successfully set for the recipient.

Previous

Set read receipts for one-to-one messages

Next

MessageBody introduction

On this page

Back to top