logo
In-app Chat
On this page

Delete all messages from a group member


Description

Call this API to delete all messages from a group member.

Request method and endpoint

  • Request method: POST
  • Request endpoint: https://zim-api.zego.im/?Action=ClearMemberGroupMessage
  • Protocol: HTTPS
  • QPS limit: 20 requests/second

Request parameters

The following request parameter list only shows the interface request parameters and some public parameters. For the complete list of public parameters, please refer to Accessing Server APIs - Public parameters.

ParameterTypeRequiredDescription
FromUserIdStringYesDelete all group messages sent by this user to GroupId.
GroupIdStringYesGroup ID.

Request example

  • Request URL:

    Untitled
    https://zim-api.zego.im/?Action=ClearMemberGroupMessage
    &<Public request parameters>
    
    1
    Copied!
  • Request body:

    Untitled
    {
        "FromUserId": "user_a",
        "GroupId": "group_id",
    }
    
    1
    Copied!

响应参数

参数类型描述
CodeNumberReturn code.
MessageStringDescription of the request result.
RequestIdStringRequest ID.

Response example

Untitled
{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782"
}
1
Copied!

Return codes

Please refer to Return codes.

Previous

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

Next

MessageBody introduction