tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Chat
    Documentation
    Download PDF

    Deleting Topic

    Last updated: 2024-07-16 11:20:06
    Download PDF

      Feature Overview

      This API is used to delete a topic.

      API Calling Description

      Applicable group types

      Group Type ID
      Whether This RESTful API Is Supported
      Private
      No
      Public
      No
      ChatRoom
      No
      AVChatRoom
      No
      Community
      This API applies only to topic-enabled communities.
      These are the preset group types in Chat. For more information, see Group System.
      Note
      To use the topic feature, you need to go to the console, choose Feature Configuration > Group configuration > Group feature configuration > Community, enable the community feature and then enable the topic feature.

      Sample request URL

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

      Request parameters

      The following table describes the modified parameters when this API is called. For other parameters, see RESTful API Overview.
      Parameter
      Description
      xxxxxx
      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/million_group_open_http_svc/destroy_topic
      Request API
      sdkappid
      The SDKAppID assigned by the Chat console when the application is created
      identifier
      App admin account. For more information, see the App Admin section in Login Authentication.
      usersig
      Signature generated by the app admin account. For details, see Generating UserSig.
      random
      A random 32-bit unsigned integer ranging from 0 to 4294967295.
      contenttype
      Request format. Fixed value: json.

      Maximum call frequency

      200 calls per second

      Sample request

      Note that a topic cannot be recovered once deleted through this API.
      {
        "GroupId":"@TGS#_@TGS#cQVLVHIM62CJ",	// Group ID of the topic to be deleted
        "TopicIdList":[	// List of IDs of the topics to be deleted
           "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic",	
           "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic_1"
        ]
      }
      

      Request fields

      Field
      Type
      Required
      Description
      GroupId
      String
      Required
      Group ID of the topic to be deleted
      TopicIdList
      Array
      Required
      List of IDs of the topics to be deleted

      Sample response

      {
          "ActionStatus": "OK",
          "ErrorInfo": "ok",
          "ErrorCode": 0,
          "DestroyResultItem": [
              {
                  "ErrorCode": 0,
                  "ErrorInfo": "ok",
                  "TopicId": "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic"
              },
              {
                  "ErrorCode": 0,
                  "ErrorInfo": "ok",
                  "TopicId": "@TGS#_@TGS#cQVLVHIM62CJ@TOPIC#_TestTopic_1"
              }
          ]
      }

      Response fields

      Field
      Type
      Description
      ActionStatus
      String
      Request result. OK: Successful; FAIL: Failed
      ErrorCode
      Integer
      Error code. 0: Successful; other values: Failed
      ErrorInfo
      String
      Error information
      DestroyResultItem
      Array
      Returned result of topic deletion. Each item indicates the deletion result of a topic.

      Error Codes

      The returned HTTP status code for this API is always 200 unless a network error (such as error 502) occurs. The specific error code and details can be found in the response fields ErrorCode and ErrorInfo respectively. For public error codes (60000 to 79999), see Error Codes. The following table describes the error codes specific to this API:
      Error Code
      Description
      10002
      Internal server error. Try again.
      10003
      Invalid command word.
      10004
      Invalid parameter. Check the error description and troubleshoot the issue.
      10006
      The operation exceeds the frequency limit. Please reduce the call frequency. This error is usually caused by too much net group increase in a single day or too frequent calls to obtain all groups in the app.
      10007
      Insufficient operation permissions. Check the request parameters based on the error message.
      10008
      The request is invalid, probably because verification of the signing information in the request failed. Please try again or submit a ticket.
      10015
      The requested group ID is invalid. Check the request parameter based on the error message.
      10021
      The group ID has already been used by another user. Select another group ID.
      10025
      You have already used this group ID. Disband the existing group first or select another group ID.
      11000
      The current group does not support the community topic feature. To use this feature, you need to purchase the Premium edition and enable it in the console.
      110002
      Failed to delete the topic. Check based on the error message.
      110003
      Failed to delete the topic. The topic has been deleted.

      API Debugging Tool

      Use the RESTful API online debugging tool to debug this API.

      Possible Webhooks

      After a Topic Is Deleted
      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