tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Chat
    Documentation
    Download PDF

    Clearing Historical Group Messages

    Last updated: 2024-11-11 14:36:23
    Download PDF

      Overview

      This API is used to clear historical messages sent by users in group chats.
      This API marks group messages as deleted so the SDK cannot pull them, rather than actually deleting them. The admin can still pull cleared historical messages through the "Pull Historical Group Messages" API.

      API Calling Description

      Applicable Group Types

      Group Type ID
      Support for This RESTful API
      Private
      Yes. The same as work groups (Work) in the new version
      Public
      Yes
      ChatRoom
      Yes. The same as meeting groups (Meeting) in the new version
      AVChatRoom
      Yes
      Community
      No
      The above group types are built in Chat. For details, see Group System.

      Sample Request URL

      https://xxxxxx/v4/group_open_http_svc/clear_group_msg?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

      Request Parameters

      The table below only lists parameters involved in modification and their description when this API is called. For more parameter details, refer to RESTful API Overview.
      Parameter
      Description
      xxxxxx
      The domain name corresponding to the country/region where your SDKAppID is located.
      China: console.tim.qq.com
      Singapore: adminapisgp.im.qcloud.com
      Seoul: adminapikr.im.qcloud.com
      Frankfurt: adminapiger.im.qcloud.com
      Silicon Valley: adminapiusa.im.qcloud.com
      Jakarta: adminapiidn.im.qcloud.com
      v4/group_open_http_svc/clear_group_msg
      Request API.
      sdkappid
      The SDKAppID assigned by the Chat console when an app is created.
      identifier
      It must be the app admin account. For more details, see App Admin.
      usersig
      The signature generated by the app admin account. For specific operations, see Generating UserSig.
      random
      A random 32-bit unsigned integer ranging from 0 to 4294967295.
      contenttype
      Request format. The value is fixed to json.

      Maximum Call Frequency

      200 calls per second.

      Sample Request

      Basic form Directly clear historical messages of the current group chat.
      {
        "GroupId": "@TGS#15ERQPAER"
      }
      Clearing by MsgSeq Clear historical messages of the group before the specified seq (including the seq).
      {
        "GroupId": "@TGS#15ERQPAER",
        "MsgSeq": 7803321       // Clear messages less than or equal to MsgSeq.
      }

      Request Fields

      Field
      Type
      Attribute
      Description
      GroupId
      String
      Required
      The ID of the group whose historical messages are to be cleared.
      MsgSeq
      Integer
      Optional
      Historical messages less than or equal to MsgSeq are cleared. If this field is left blank, all historical messages are cleared.

      Sample Response

      {
          "ActionStatus": "OK",
          "ErrorInfo": "",
          "ErrorCode": 0
      }

      Response Fields

      Field
      Type
      Description
      ActionStatus
      String
      Request result: OK: successful, FAIL: failed
      ErrorInfo
      String
      Error information
      ErrorCode
      Integer
      Error code:
      0: successful
      Other values: failed

      Error Codes

      The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The real error code and error information are indicated by ErrorCode and ErrorInfo in the response body. For public error codes (60000 to 79999), see Error Codes. Private error codes for this API are as follows:
      Error Code
      Description
      10002
      Internal server error. Please try again.
      10003
      Invalid request command word.
      10004
      Invalid parameter. Please check if the request is correct based on the error description.
      10007
      Insufficient operation permissions. The operator must be the admin.
      10010
      The group does not exist, or it existed in the past but has now been dissolved.
      10015
      Invalid Group ID. Please check if the Group ID is filled in correctly.

      API Debugging Tool

      Use the RESTful API Online Debugging Tool to debug this API.

      Reference

      Pull historical group chat messages (v4/group_open_http_svc/group_msg_get_simple).
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy