please select
Docs Overview/
Chat/
Server APIs/
RESTful APIs/
Message Related/
Message Extension/
Pulling Message Extension of a Group Message/

Pulling Message Extension of a Group Message

Feature Overview

App admins and group members can pull the message extension of a one-to-one message. Message extension is a set of custom key-value pairs.
Note
To use this feature, you need to purchase the Premium edition and enable the Set message extension feature on the Login and Message page in the Chat console.
Up to 300 key-value pairs can be set for each group message.
For group messages for which key-value pairs are set, they need to be specified to support message extension when being sent. For operation details, see Sending Ordinary Messages in a Group.

API Calling Description

Applicable group types

Group Type ID
RESTful API Support
Private
Yes. Same as work groups (Work) in the new version.
Public
Yes
ChatRoom
Yes. Same as the meeting group (Meeting) in the new version.
AVChatRoom
No
Community
No
These are the preset group types in Chat. For more information, see Group System.

Sample request URL

https://xxxxxx/v4/openim_msg_ext_http_svc/group_get_key_values?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_msg_ext_http_svc/group_get_key_values
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

Basic format
Pull the message extensions of the group message whose MsgSeq is 158:
{
    "GroupId": "@TGS#1YMVAB3IZ",
    "MsgSeq": 158
}
Pull the message extensions of the group message whose MsgSeq is 158 and Seq is equal to or greater than 2:
{
    "GroupId": "@TGS#1YMVAB3IZ",
    "MsgSeq": 158,
    "StartSeq": 2
}

Request fields

Field
Type
Required
Description
GroupId
String
Yes
Group ID
MsgSeq
Integer
Yes
Seq of the group message to be configured
StartSeq
Integer
No
Message extension will be pulled for messages whose Seq is greater than or equal to StartSeq.

Sample response

{
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ActionStatus": "OK",
    "CompleteFlag": 1,
    "LatestSeq": 2,
    "ClearSeq": 0,
    "ExtensionList": [
        {
            "Key": "key1",
            "Value": "1",
            "Seq": 1
        },
        {
            "Key": "key2",
            "Value": "2",
            "Seq": 1
        },
        {
            "Key": "key3",
            "Value": "3",
            "Seq": 2
        }
    ]
}

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
ExtensionList
Array
List of key-value pairs returned, where the key-value pairs are sorted by Seq. Up to 200 key-value pairs can be returned per pull. If there are more than 200 key-value pairs, they need to be pulled in batches based on StartSeq.
CompleteFlag
Integer
1: All key-value pairs are returned. 0: Not all key-value pairs are returned.
LatestSeq
Integer
Latest Seq of the backend, which is the maximum value of Seq among all key-value pairs.
ClearSeq
Integer
Seq for the clearing operation. All key-value pairs whose Seq is less than or equal to ClearSeq must be deleted locally on the client.

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.
10004
Invalid parameter. Check the error description and troubleshoot the issue.
10008
Invalid request: The request is not an Premium edition plan request.
23004
The group message does not exist.