tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Chat
    Documentation
    Download PDF

    Pulling Historical One-to-one Messages

    Last updated: 2024-02-07 17:11:43
    Download PDF

      Feature Overview

      This API is used by the app admin to query the message history of a one-to-one conversation from the perspective of a party of the conversation based on a specified time range.
      The one-to-one conversation to be queried is specified by Operator_Account and Peer_Account in the request and the query is performed from the perspective of the party specified by Operator_Account. The query result contains the messages sent between both parties. The specific sender and recipient of each message are specified by From_Account and To_Account respectively.
      In most cases, the query result is the same if you perform the query from the perspective of either party of a one-to-one conversation. However, there are four cases where the results are different (some messages in the conversation can be queried by one party but not by the other party):
      One party of the conversation has cleared the message history of the conversation by calling the terminal API clearC2CHistoryMessage().
      One party of the conversation has deleted the conversation by calling the terminal API deleteConversation(), web/uni-app API deleteConversation, or server API for deleting a conversation with ClearRamble being set to 1.
      One party of the conversation has deleted some messages in the conversation by calling the terminal API deleteMessages() or web/uni-app API deleteMessage.
      For messages sent through the API for sending one-to-one messages to one user or the API for sending one-to-one messages to multiple users, SyncOtherMachine is set to 2, indicating that specified messages are not synced to the message history of the other party of the conversation.
      The query result contains recalled messages indicated by the MsgFlagBits field.
      The IsPeerRead field in the query result indicates whether the recipient sends the read receipt of the message. The field value is 1 only when the recipient calls the sendMessageReadReceipts (Android / iOS and Mac / Windows) or sendMessageReadReceipt (Web&) API.
      If you want to recall a message, you can first call this API to query the MsgKey of the message and then call the RESTful API for recalling one-to-one messages to recall the message.
      The time range of message records that can be queried depends on the roaming message storage period, which is seven days by default. You can modify the message roaming period via the Chat console. Extending the message roaming period is a value-added service. For more information, see Message Storage.
      If the total size of the messages within the requested time range exceeds the upper size limit (currently 13 KB) of the response, continued pulling is needed. You can see whether all the requested messages have been pulled by checking the Complete field in the response.

      API Calling Description

      Sample request URL

      https://xxxxxx/v4/openim/admin_getroammsg?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
      Mumbai: adminapiind.im.qcloud.com
      Silicon Valley: adminapiusa.im.qcloud.com
      Jakarta: adminapiidn.im.qcloud.com
      v4/openim/admin_getroammsg
      Request API
      sdkappid
      SDKAppID assigned by the Chat console when an app 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, which should always be json.

      Maximum call frequency

      200 calls per second

      Sample requests and responses

      For example, user1 and user2 had a conversation, and you want to query the conversation history from 2020-03-20 10:00:00 to 2020-03-20 11:00:00 from the perspective of user2.

      Sample request

      {
          "Operator_Account":"user2",
          "Peer_Account":"user1",
          "MaxCnt":100,
          "MinTime":1584669600,
          "MaxTime":1584673200
      }

      Sample response

      {
          "ActionStatus": "OK",
          "ErrorInfo": "",
          "ErrorCode": 0,
          "Complete": 0,
          "MsgCnt": 12, //12 messages were returned for the pull.
          "LastMsgTime": 1584669680,
          "LastMsgKey": "549396494_2578554_1584669680",
          "MsgList": [
              {
                  "From_Account": "user1",
                  "To_Account": "user2",
                  "MsgSeq": 549396494,
                  "MsgRandom": 2578554,
                  "MsgTimeStamp": 1584669680,
                  "MsgFlagBits": 0,
                  "IsPeerRead": 0,
                  "MsgKey": "549396494_2578554_1584669680",
                  "MsgBody": [
                      {
                          "MsgType": "TIMTextElem",
                          "MsgContent": {
                              "Text": "msg 1"
                          }
                      }
                  ],
                  "CloudCustomData": "your cloud custom data"
              },
              {
                  "From_Account": "user2",
                  "To_Account": "user1",
                  "MsgSeq": 1054803289,
                  "MsgRandom": 7201,
                  "MsgTimeStamp": 1584669689,
                  "MsgFlagBits": 0,
                  "IsPeerRead": 0,
                  "MsgKey": "1054803289_7201_1584669689",
                  "MsgBody": [
                      {
                          "MsgType": "TIMTextElem",
                          "MsgContent": {
                              "Text": "msg 2"
                          }
                      }
                  ],
                  "CloudCustomData": "your cloud custom data"
              },
              { ... } // The remaining ten messages are not listed for simplicity.
          ]
      }
      In the response, "Complete": 0 indicates that not all messages generated within the time range have been pulled. Therefore, continued pulling is required. In the continued pulling request, the value of MaxTime must be changed to the value of LastMsgTime in the response, and the LastMsgKey in the response must be entered, as shown below:
      Sample continued pulling request
      {
          "Operator_Account":"user2",
          "Peer_Account":"user1",
          "MaxCnt":100,
          "MinTime":1584669600,
          "MaxTime":1584669680,
          "LastMsgKey": "549396494_2578554_1584669680"
      }

      Sample response

      {
          "ActionStatus": "OK",
          "ErrorInfo": "",
          "ErrorCode": 0,
          "Complete": 1,
          "MsgCnt": 5, // Five messages were returned for the pull.
          "LastMsgTime": 1584669601,
          "LastMsgKey": "1456_23287_1584669601",
          "MsgList": [
              {
                  "From_Account": "user1",
                  "To_Account": "user2",
                  "MsgSeq": 1456,
                  "MsgRandom": 23287,
                  "MsgTimeStamp": 1584669601,
                  "MsgFlagBits": 0,
                  "IsPeerRead": 1,
                  "MsgKey": "1456_23287_1584669601",
                  "MsgBody": [
                      {
                          "MsgType": "TIMTextElem",
                          "MsgContent": {
                              "Text": "msg 13"
                          }
                      }
                  ],
                  "CloudCustomData": "your cloud custom data"
              },
              {
                  "From_Account": "user2",
                  "To_Account": "user1",
                  "MsgSeq": 9806,
                  "MsgRandom": 14,
                  "MsgTimeStamp": 1584669602,
                  "MsgFlagBits": 0,
                  "IsPeerRead": 1,
                  "MsgKey": "9806_14_1584669602",
                  "MsgBody": [
                      {
                          "MsgType": "TIMTextElem",
                          "MsgContent": {
                              "Text": "msg 14"
                          }
                      }
                  ],
                  "CloudCustomData": "your cloud custom data"
              },
              { ... } // The remaining three messages are not listed for simplicity.
          ]
      }
      In the response, "Complete": 1 indicates that all messages generated within the time range have been pulled. If the value of Complete in the response is 0, you need to continue pulling messages until the value of Complete becomes 1.

      Request fields

      Field
      Type
      Required
      Description
      Operator_Account
      String
      Yes
      UserID of one party of the conversation for which messages are queried. The result may be different if you query messages for the other party of the same conversation. For more information, see the API description section.
      Peer_Account
      String
      Yes
      UserID of the other party in the conversation
      MaxCnt
      Integer
      Yes
      Number of messages to query
      MinTime
      Integer
      Yes
      Minimum value of the time range for message query, in seconds
      MaxTime
      Integer
      Yes
      Maximum value of the time range for message query, in seconds
      LastMsgKey
      String
      No
      MsgKey of the last message that was pulled previously. This field is required for continued pulling. For more information, see the preceding sample.

      Sample response

      Response to a successful request
      {
        "ActionStatus": "OK",
        "ErrorInfo": "",
        "ErrorCode": 0,
        "Complete": 1,
        "MsgCnt": 1,
        "LastMsgTime": 1584669680,
        "LastMsgKey": "549396494_2578554_1584669680",
        "MsgList": [
            {
                "From_Account": "user1",
                "To_Account": "user2",
                "MsgSeq": 549396494,
                "MsgRandom": 2578554,
                "MsgTimeStamp": 1584669680,
                "MsgFlagBits": 0,
                "IsPeerRead": 0,
                "MsgKey": "549396494_2578554_1584669680",
                "MsgBody": [
                    {
                        "MsgType": "TIMTextElem",
                        "MsgContent": {
                            "Text": "1"
                        }
                    }
                ],
                "CloudCustomData": "your cloud custom data"
            }
        ]
      }
      Response to a failed request
      {
        "ActionStatus": "FAIL", 
        "ErrorInfo": "Fail to Parse json data of body, Please check it", 
        "ErrorCode": 90001
      }

      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
      Complete
      Integer
      Whether all messages have been pulled. 0: no, continued pulling is required; 1: yes
      MsgCnt
      Integer
      Number of messages that were pulled this time
      LastMsgTime
      Integer
      Time when the last message was pulled this time
      LastMsgKey
      String
      Identifier of the last message pulled this time
      MsgList
      Array
      List of returned messages
      MsgFlagBits
      Integer
      Message attribute. 0: normal message; 8: recalled message
      IsPeerRead
      Integer
      Whether the recipient has sent the read receipt of this message. Valid values: 0 for no and 1 for yes. For details, see the feature description of this API.
      MsgBody
      Array
      Message body. For details on formats, see Message Formats. (Note: A message can contain multiple message elements, in which case MsgBody is an array.)
      CloudCustomData
      String
      Custom message data. It is saved in the cloud and will be sent to the peer end. Such data can be pulled after the app is uninstalled and reinstalled.
      MsgKey
      String
      Message identifier. You can use this field when calling the RESTful API for recalling one-to-one messages.

      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
      90001
      Failed to parse the JSON request. Make sure the format is valid.
      90003
      The To_Account field is missing in the JSON request or it is not a string.
      90008
      The From_Account field is missing in the JSON request or the account it specifies does not exist.
      90009
      The request requires app admin permissions.
      91000
      Internal service error. Try again.

      API Debugging Tool

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

      References

      Sending One-to-One Messages to One User (v4/openim/sendmsg)
      Sending One-to-One Messages to Multiple Users (v4/openim/batchsendmsg)
      Recalling One-to-One Messages (v4/openim/admin_msgwithdraw)
      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