logo
当前页
警告
服务端 API 板块于4月16日至5月15日升级维护,期间暂停信息更新,如有任何疑问,请联系 ZEGO 技术支持。

删除指定群聊用户全部消息


描述

调用此接口,您可以在服务端删除群聊会话中某一用户的全部消息。

接口原型

  • 请求方法:POST
  • 请求地址: https://zim-api.zego.im/?Action=ClearMemberGroupMessage
  • 传输协议:HTTPS
  • 调用频率限制:20 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考调用方式 - 公共请求参数

参数类型是否必选描述
FromUserIdString删除此用户在 GroupId 发送过的所有群聊消息。
GroupIdString群组 ID。

请求示例

  • 请求地址 URL:

    Untitled
    https://zim-api.zego.im/?Action=ClearMemberGroupMessage
    &<公共请求参数>
    
    1
    Copied!
  • 请求消息体:

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

响应参数

参数类型描述
CodeNumber返回码。
MessageString操作结果描述。
RequestIdString请求 ID。

响应示例

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

返回码

返回码请参考 全局返回码

Previous

删除指定单聊用户全部消息

Next

MessageBody 说明