Release Notes
Announcements
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 |
https://xxxxxx/v4/group_open_http_svc/get_group_msg_receipt?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
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.comTokyo： adminapijpn.im.qcloud.comFrankfurt: adminapiger.im.qcloud.comSilicon Valley: adminapiusa.im.qcloud.comJakarta: 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 | |
usersig | |
random | A random 32-bit unsigned integer ranging from 0 to 4294967295. |
contenttype | Request format. The value is fixed to json. |
{"GroupId":"@TGS#2TTV7VSII","MsgSeqList":[ // Pull the list of message `seq` values{"MsgSeq":1},{"MsgSeq":2}]}
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 |
{"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}]}
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 |
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. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback