- 제품 소개
- 구매 가이드
- 다운로드 센터
- 시나리오 솔루션
- 클라이언트 APIs
- 서버 APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- Group Management
- Group Information
- Group Member Management
- Group Member Information
- Group Custom Attributes
- Live Group Management
- Setting Live Streaming Group Robots
- Deleting Live Streaming Group Robots
- Setting/Deleting Live Streaming Group Administrators
- Obtaining the List of Live Streaming Group Administrators
- Checking Whether Users Are in a Live Streaming Group
- Getting the Number of Online Users in an Audio-Video Group
- Getting the List of Online Members in Audio-Video Group
- Setting Audio-Video Group Member Marks
- Getting the List of Banned Group Members
- Community Management
- Creating Topic
- Deleting Topic
- Getting Topic Profile
- Modifying Topic Profile
- Importing Topic Profiles
- Permission Group Management
- Creating Permission Groups
- Terminating Permission Groups
- Modifying Permission Group Information
- Obtaining Permission Group Information
- Adding Topic Permissions
- Modifying Topic Permissions
- Deleting Topic Permissions
- Obtaining Topic Permissions
- Adding Members to a Permission Group
- Deleting Permission Group Members
- Obtaining Permission Group Member List
- Group Counter
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Official Account Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Operations Management Callbacks
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- 그룹 생성 전 콜백
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- 그룹 내 발언 전 콜백
- 그룹 내 발언 후 콜백
- 그룹 만원 후 콜백
- After a Group Is Disbanded
- 그룹 정보 변경 후 콜백
- 그룹 메시지 회수 후 콜백
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- 토픽 생성 전 콜백
- 토픽 생성 후 콜백
- 토픽 해산 후 콜백
- 토픽 프로필 수정 후 콜백
- Callback After Group Member Profile Changed
- Callback After Group Attribute Changed
- Callback After Read Receipt
- Callback After the Group Owner Changed
- Webhooks related to the Official Account
- Before a Official Account Is Created
- After a Official Account Is Created
- After Official Account Profile Is Modified
- After Official Account Is Destroyed
- Before Official Account Is Subscribed
- After Official Account Is Subscribed
- After a Official Account Is Full
- After Official Account Is Unsubscribed
- Before Official Account Message Is Sent
- Callback After Sending an Official Account Message
- Webhook After Recalling Official Account Messages
- 콘솔 가이드
- FAQ
- 협약 및 인증
- IM 정책
- 에러 코드
- 문의하기
- 제품 소개
- 구매 가이드
- 다운로드 센터
- 시나리오 솔루션
- 클라이언트 APIs
- 서버 APIs
- Generating UserSig
- RESTful APIs
- RESTful API Overview
- RESTful API List
- Message Related
- Session Related
- Group Related
- Group Management
- Group Information
- Group Member Management
- Group Member Information
- Group Custom Attributes
- Live Group Management
- Setting Live Streaming Group Robots
- Deleting Live Streaming Group Robots
- Setting/Deleting Live Streaming Group Administrators
- Obtaining the List of Live Streaming Group Administrators
- Checking Whether Users Are in a Live Streaming Group
- Getting the Number of Online Users in an Audio-Video Group
- Getting the List of Online Members in Audio-Video Group
- Setting Audio-Video Group Member Marks
- Getting the List of Banned Group Members
- Community Management
- Creating Topic
- Deleting Topic
- Getting Topic Profile
- Modifying Topic Profile
- Importing Topic Profiles
- Permission Group Management
- Creating Permission Groups
- Terminating Permission Groups
- Modifying Permission Group Information
- Obtaining Permission Group Information
- Adding Topic Permissions
- Modifying Topic Permissions
- Deleting Topic Permissions
- Obtaining Topic Permissions
- Adding Members to a Permission Group
- Deleting Permission Group Members
- Obtaining Permission Group Member List
- Group Counter
- User Management
- Global Mute Management
- Operations Management
- Chatbots
- Official Account Management
- Webhooks
- Webhook Overview
- Webhook Command List
- Operations Management Callbacks
- Online Status Webhooks
- Relationship Chain Webhooks
- One-to-One Message Webhooks
- Group Webhooks
- 그룹 생성 전 콜백
- After a Group Is Created
- Before Applying to Join a Group
- Before Inviting a User to a Group
- After a User Joins a Group
- After a User Leaves a Group
- 그룹 내 발언 전 콜백
- 그룹 내 발언 후 콜백
- 그룹 만원 후 콜백
- After a Group Is Disbanded
- 그룹 정보 변경 후 콜백
- 그룹 메시지 회수 후 콜백
- Webhook for Online and Offline Status of Audio-Video Group Members
- Webhook for Exceptions When Group Messages Are Sent
- 토픽 생성 전 콜백
- 토픽 생성 후 콜백
- 토픽 해산 후 콜백
- 토픽 프로필 수정 후 콜백
- Callback After Group Member Profile Changed
- Callback After Group Attribute Changed
- Callback After Read Receipt
- Callback After the Group Owner Changed
- Webhooks related to the Official Account
- Before a Official Account Is Created
- After a Official Account Is Created
- After Official Account Profile Is Modified
- After Official Account Is Destroyed
- Before Official Account Is Subscribed
- After Official Account Is Subscribed
- After a Official Account Is Full
- After Official Account Is Unsubscribed
- Before Official Account Message Is Sent
- Callback After Sending an Official Account Message
- Webhook After Recalling Official Account Messages
- 콘솔 가이드
- FAQ
- 협약 및 인증
- IM 정책
- 에러 코드
- 문의하기
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.comSingapore: adminapisgp.im.qcloud.comSeoul: adminapikr.im.qcloud.comFrankfurt: adminapiger.im.qcloud.comSilicon Valley: adminapiusa.im.qcloud.comJakarta: 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 | |
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 queryThis 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)
예
아니오
문제 해결에 도움이 되었나요?