Pulling Read Receipts for Group Messages

Feature Overview
This API is used to pull read receipts for group messages.
Note:
This feature is available only in the Premium edition. To use it, you need to purchase the Premium edition, go to the console, choose Feature Configuration > Group configuration > Group Message Read Receipts, and enable the feature.
API Calling Description
Applicable group types
Group Type ID
Support for This RESTful API
Private
Yes. Same as work groups (Work) in the new version.
Public
Yes
ChatRoom
Yes. Same as meeting groups (Meeting) in the new version.
AVChatRoom
No
Community
No
Above are the Chat built-in group types. For more information, please see Group System.
Sample request URL
https://xxxxxx/v4/group_open_http_svc/get_group_msg_receipt?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/group_open_http_svc/get_group_msg_receipt
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. The value is fixed to json.
Maximum call frequency
200 calls per second
Sample request
Batch pull the read receipts for group messages, including the read count and unread count.
Basic format
{
  "GroupId":"@TGS#2TTV7VSII",
  "MsgSeqList":[        // Pull the list of message `seq` values
      {"MsgSeq":1},
      {"MsgSeq":2}
  ]
}
Request fields
Field
Type
Required
Description
GroupId
String
Yes
ID of the group of which message read receipts are to be pulled
MsgSeqList
Array
Yes
List of message seq values
MsgSeq
Integer
Yes
Seq of the message to pull
Sample response
Basic format
{
  "ActionStatus": "OK",
  "ErrorCode": 0,
  "ErrorInfo": "",
  "GroupMsgReceiptList": [   // Read receipts
      {
          "Code": 0,
          "MsgSeq": 1,       
          "ReadNum": 1,      // Read count of the group message
          "UnreadNum": 6     // Unread count of the group message
      },
      {
          "Code": 0,
          "MsgSeq": 2,
          "ReadNum": 1,
          "UnreadNum": 6
      }
  ]
}
Response fields
Field
Type
Description
ActionStatus
String
Request result. OK: successful; FAIL: failed
ErrorInfo
String
Error information
ErrorCode
Integer
Error code. 0: Successful; other values: Failed
GroupMsgReceiptList
Array
Read receipt for the group message
Code
Integer
Error code for the read receipt. For example, 10062 indicates that the read receipt doesn't exist.
MsgSeq
Integer
Seq of the message to pull
ReadNum
Integer
Read count of the group message
UnreadNum
Integer
Unread count of the group message
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
10002
Internal server error. Try again.
10003
Invalid command word.
10004
Invalid parameter. Check the error description and troubleshoot the issue.
10007
No operation permissions. The operator must have permissions to perform corresponding operations.
10010
The group does not exist or has been deleted.
10015
Invalid group ID. Use the correct group ID.
10062
The read receipt doesn't exist.
API Debugging Tool
Use the RESTful API online debugging tool to debug this API.
References
Pulling group message read receipt details (v4/group_open_http_svc/get_group_msg_receipt_detail)

Feature Overview
API Calling Description
Error Codes
API Debugging Tool
References

Group Type ID	Support for This RESTful API
Private	Yes. Same as work groups (Work) in the new version.
Public	Yes
ChatRoom	Yes. Same as meeting groups (Meeting) in the new version.
AVChatRoom	No
Community	No

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/group_open_http_svc/get_group_msg_receipt	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. The value is fixed to `json`.

Field	Type	Required	Description
GroupId	String	Yes	ID of the group of which message read receipts are to be pulled
MsgSeqList	Array	Yes	List of message `seq` values
MsgSeq	Integer	Yes	Seq of the message to pull

Error Code	Description
10002	Internal server error. Try again.
10003	Invalid command word.
10004	Invalid parameter. Check the error description and troubleshoot the issue.
10007	No operation permissions. The operator must have permissions to perform corresponding operations.
10010	The group does not exist or has been deleted.
10015	Invalid group ID. Use the correct group ID.
10062	The read receipt doesn't exist.