Feature Description

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 only describes the modified parameters when this API is called. For more information on other parameters, please see RESTful API Overview.

Maximum calling 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

Response fields

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), please see Error Codes.
The following table describes the error codes specific to 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)
• Querying One-to-One Messages (v4/openim/admin_getroammsg)
• Recalling One-to-One Messages (v4/openim/admin_msgwithdraw)