In-app Chat
ZIMAudio
On this page

ClearMemberGroupMessage

POST

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

By calling this API, you can delete all messages from a specific user in a group chat conversation on the server side. Only the specified user will not be able to see these messages; other group members will not be affected.

QPS Limit
20 times/s

Request

Query Parameters

    Action stringrequired

    Possible values: [ClearMemberGroupMessage]

    API prototype parameter

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

    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

    Possible values: <= 32 characters

    The user ID that needs to delete all group chat messages.

    GroupId stringrequired

    Possible values: <= 32 characters

    Group ID.

Responses​

OK
Schema
    Code number

    Return code.
    For return codes, please refer to Return codes.

    Message string

    Description of the operation result.

    RequestId string

    Request ID.

Previous

Delete all messages from a one-to-one conversation user

Next

Set read receipts for one-to-one messages

On this page

Back to top