tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Chat
    Documentation
    Download PDF

    Pulling a conversation list

    Last updated: 2024-02-07 17:15:29
    Download PDF

      Feature Overview

      This API is used to pull a conversation list by page.

      API Calling Description

      Sample request URL

      https://xxxxxx/v4/recentcontact/get_list?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/recentcontact/get_list
      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 request

      {
        "From_Account": "id1",
        "TimeStamp": 0,
        "StartIndex": 0,
        "TopTimeStamp": 0,
        "TopStartIndex": 0,
        "AssistFlags": 7
      }

      Request fields

      Field
      Type
      Required
      Description
      From_Account
      String
      Yes
      UserID of the account for which to pull a conversation list
      TimeStamp
      Integer
      Yes
      Start time of general conversations. Enter 0 for the first page.
      StartIndex
      Integer
      Yes
      Starting point of general conversations. Enter 0 for the first page.
      TopTimeStamp
      Integer
      Yes
      Start time of pinned conversations. Enter 0 for the first page.
      TopStartIndex
      Integer
      Yes
      Starting point of pinned conversations. Enter 0 for the first page.
      AssistFlags
      Integer
      Yes
      Flag bits of conversations:<br/> Bit 0: Whether to support pinned conversations<br/> Bit 1: Whether to return an empty conversation<br/> Bit 2: Whether to support paginating pinned conversations

      Sample response

      {
        "SessionItem": [
          {
            "Type": 1,
            "To_Account": "id2",
            "MsgTime": 1630997627,
            "TopFlag": 1
          },
          {
            "Type": 2,
            "GroupId": "id3",
            "MsgTime": 1630997628,
            "TopFlag": 1
          },
          {
            "Type": 1,
            "To_Account": "id4",
            "MsgTime": 1630997630,
            "TopFlag": 0
          },
          {
            "Type": 2,
            "GroupId": "id5",
            "MsgTime": 1630997650,
            "TopFlag": 0
          }
        ],
        "CompleteFlag": 1,
        "TimeStamp": 1631012800,
        "StartIndex": 0,
        "TopTimeStamp": 1631012800,
        "TopStartIndex": 0,
        "ActionStatus": "OK",
        "ErrorCode": 0,
        "ErrorInfo": "",
        "ErrorDisplay": ""
      }

      Response fields

      Field
      Type
      Description
      SessionItem
      Array
      Array of conversation objects
      Type
      Integer
      Conversation type. 1: One-to-one conversation; 2: Group conversation
      To_Account
      String
      UserID of the other conversation participant, which will be returned only for a one-to-one conversation
      GroupId
      String
      Group ID, which will be returned only for a group conversation
      MsgTime
      Integer
      Conversation duration
      TopFlag
      Integer
      Flag of conversation pinning. 0: General conversation; 1: Pinned conversation
      CompleteFlag
      Integer
      Completion flag. 1: All conversation are returned; 0: Pulling has not finished yet.
      TimeStamp
      Integer
      Start time of the next pulled page for a general conversation, which is sent to the Chat backend via the TimeStamp field of the request during pulling-by-page
      StartIndex
      Integer
      Starting point of the next pulled page for a general conversation, which is sent to the Chat backend via the StartIndex field of the request during pulling-by-page
      TopTimeStamp
      Integer
      Start time of the next pulled page for a pinned conversation, which is sent to the Chat backend via the TopTimeStamp field of the request during pulling-by-page
      TopStartIndex
      Integer
      Starting point of the next pulled page for a pinned conversation, which is sent to the Chat backend via the TopStartIndex field of the request during pulling-by-page
      ActionStatus
      String
      The request result. OK: successful. FAIL: failed.
      ErrorCode
      Integer
      Error code. 0: Successful; other values: Failed. For details on non-zero results, see Error Codes.
      ErrorInfo
      String
      Detailed error message
      ErrorDisplay
      String
      Detailed information displayed on the client
      

      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 ResultCode, ResultInfo, ErrorCode, and ErrorInfo. For public error codes (60000 to 79999), see Error Codes. The following table describes the error codes specific to this API:
      Error Code
      Description
      50001
      The requested UserID has not been imported into the Tencent Cloud Chat backend. Please import.
      50002
      Incorrect request parameter. Check your request according to the error description.
      50003
      The request requires app admin permissions.
      50004
      Internal server error. Please try again.
      50005
      Network timeout. Try again later.

      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