tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Chat
    Documentation
    Download PDF

    Recalling Official Account Messages

    Last updated: 2024-07-16 10:41:26
    Download PDF

      Feature Overview

      Administrator revokes official account message.
      This interface can revoke all official account messages within the valid roaming period, including official account messages sent by the client and those issued by the REST API interface.
      If you need to recall official account messages sent by the client, you can enable Callback after sending a message to the official account, record the MsgKey of each official account message via this callback interface, and then fill in the MsgKeyList parameter of this interface for revocation. You can also use Pulling historical messages of official account users to query the relevant information of the official account messages to be revoked, and then use this interface for revocation.
      If you need to revoke official account messages sent via the REST API Official Account Users Send Broadcast Messages interface, it's necessary to record the MsgKey field in the response packages of these interfaces for revocation.
      After invoking this interface to recall a message, the local cache of the recipient's client will also be recalled.
      This interface can recall official account messages without any time limit, meaning it can recall official account messages from any time, but the roaming time of the official account messages needs to be within the validity period.

      API Calling Description

      Sample request URL

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

      Request parameters

      The table below only lists the parameters modified when calling this API and their descriptions. For more details on the parameters, please refer to RESTful API Overview.
      Parameter
      Description
      xxxxxx
      The dedicated domain for 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/official_account_open_http_svc/official_account_msg_recall
      Request API
      sdkappid
      SDKAppID assigned by the Chat console when an app is created
      identifier
      You must be an App admin account. For more details, see App Admins
      usersig
      The 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 calling frequency

      200 queries/sec.

      Sample request packets

      Once a message is recalled, it cannot be restored. Please be cautious when invoking this interface.
      {
          "Official_Account": "@TOA#_2J4SZEAEL",
          "MsgKeyList":[
              "71_1_1698741698",
              "72_1_1698741698"
          ],
          "Reason":"Revocation Reason"
      }

      Request packet fields

      Field
      Type
      Attribute
      Description
      Official_Account
      String
      Mandatory
      Operated Official Account User ID
      MsgKeyList
      Array
      Mandatory
      List of MsgKeys for messages being recalled, a single request can recall up to 10 messages
      Reason
      String
      Optional
      Reason for message recall, length restricted to a maximum of 100 bytes

      Sample response packets

      {
          "ActionStatus": "OK",
          "ErrorInfo": "",
          "ErrorCode": 0,
          "RecallRetList":[
              {
                  "MsgKey":"71_1_1698741698",
                  "RetCode":10030
              },
              {
                  "MsgKey":"72_1_1698741699",
                  "RetCode":0
              }
          ]
      }

      Response packet field description

      Field
      Type
      Description
      ActionStatus
      String
      Processed Request Result:
      OK: Indicates successful processing
      FAIL: Indicates failure
      ErrorCode
      Integer
      Error Identifier:
      0: Indicates success
      Non-zero: Indicates failure
      ErrorInfo
      String
      Error message
      RecallRetList
      Array
      Detailed results of the message recall request
      MsgKey
      String
      MsgKey of a single message being recalled
      RetCode
      Integer
      Recall result of a single message: 0 means success; other values mean failure, refer to the error code explanations below

      Error codes

      Unless a network error occurs (such as a 502 error), the HTTP return code for this interface is always 200. The real error code and error message are indicated by ErrorCode, ErrorInfo in the response body. Common error codes (60000 to 79999) can be found in the Error Codes document. The private error codes for this API are as follows:
      Error code
      Description
      10002
      Internal server error, please try again
      10003
      Illegal Request Command Word
      10004
      Invalid parameter, please check if the request is correct based on the error description
      10007
      Insufficient operational permissions
      10010
      Official Account User does not exist, or may have existed in the past, but is now dissolved
      10015
      Invalid Official Account User ID, please check if the Official Account User ID is correctly filled in
      10030
      The message requested for recall does not exist
      10031
      The message requested for recall exceeds the time limit
      10032
      The message requested for recall does not support recall operations

      API Debugging Tool

      Use the RESTful API Online Debugging Tool to debug this API.
      
      
      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