tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Chat
    Documentation
    Download PDF

    Querying Unread One-to-One Message Count

    Last updated: 2024-07-16 10:52:14
    Download PDF

      Feature Overview

      This API is used to query the unread message count of a one-to-one conversation or all one-to-one conversations.

      API Calling Description

      Sample request URL

      https://xxxxxx/v4/openim/get_c2c_unread_msg_num?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/openim/get_c2c_unread_msg_num
      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

      Querying the total unread one-to-one message count of an account

      Sample request

      This example shows how the admin queries the total unread one-to-one message count of dramon1. Only To_Account is required.
      {
          "To_Account":"dramon1"
      }

      Sample response

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

      Querying the unread message counts of multiple one-to-one conversations at a time

      Sample request

      This example shows how the admin queries the unread message counts of dramon1's conversations with dramon2 and teacher.
      {
          "To_Account":"dramon1",
          "Peer_Account":[
              "dramon2",
              "teacher"
          ]
      }

      Sample response

      {
          "ActionStatus": "OK",
          "ErrorInfo": "",
          "ErrorCode": 0,
          "C2CUnreadMsgNumList": [
              {
                  "Peer_Account": "dramon2",
                  "C2CUnreadMsgNum": 12
              },
              {
                  "Peer_Account": "teacher",
                  "C2CUnreadMsgNum": 12
              }
          ]
      }

      Request fields

      Field
      Type
      Required
      Description
      To_Account
      String
      Yes
      UserID of the user to query
      Peer_Account
      Array
      No
      UserID of the other party in the conversation to query
      This field is required to query a specific one-to-one conversation.
      The array can contain up to 10 UserID values.

      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
      AllC2CUnreadMsgNum
      Integer
      Total unread message count of all conversations
      C2CUnreadMsgNumList.Peer_Account
      String
      UserID of the other party in the one-to-one conversation
      C2CUnreadMsgNumList.C2CUnreadMsgNum
      Integer
      Unread message count in the one-to-one conversation
      ErrorList.Peer_Account
      String
      Target account for which the query failed
      ErrorList.ErrorCode
      Integer
      Error code. 70107 indicates that the account does not exist.

      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 the account specified by To_Account does not exist.
      90008
      The From_Account field is missing in the JSON request, or the account specified by From_Account does not exist.

      References

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