logoDocs
    Sign UpConsole
    Document
    ZIM Client API
    ZPNs Client API
    ZIM Audio Client API
    Server API
    In-app Chat
    Overview
    Release Notes
    Accessing Server APIs
    Call API Online
    Connect to ZEGOCLOUD Document MCP Serverlink
    User
    Room
    Group
    Message
    Call invitation
    Conversation
    Community
    Bot
    ZIMAudio
    Callbacks
    Return codes
    Debugging guide of server API operations
    Privacy policylink
    On this page

    GroupDeliveryReceipt

    2026-07-24
    POST

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

    Use this API to set delivered receipts for group messages.

    The server can call this API to report the delivery status on behalf of the message receiver (group member). After a successful call, the message sender will receive a delivery receipt push for the corresponding group message.

    Note
    FromUserId is the receiver (operator, must be a group member), and GroupId is the target group ID.

    Note
    Rate limit: 20 requests/second.

    Request

    Query Parameters

      Action stringrequired

      Possible values: [GroupDeliveryReceipt]

      API prototype parameter

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

      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 (message receiver). Must be a registered user and a group member.

      GroupId stringrequired

      Group ID.

      ConvMsgSeq number[]required

      Message sequence numbers for which delivered receipts need to be set. Up to 10 per request.

    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 receipt messages exceeds the limitUp to 10 per request, please reduce and retry
      660400103Failed to set receipts for group messagesContact technical support
      Message string

      Return status message.

      RequestId string

      Unique request identifier.

      DeliveredTime number

      Server timestamp when the delivered receipt is successfully set for the receiver.

    Previous

    Set delivered receipts for one-to-one messages

    Next

    MessageBody introduction

    On this page

    Back to top