please select
Docs Overview/
Chat/
Server APIs/
RESTful APIs/
Message Related/
Message Extension/
Configuring Message Extension for a Group Message/

Configuring Message Extension for a Group Message

Feature Overview

App admins and group members can configure message extension for common group messages. Message extension is a set of custom key-value pairs.
Note:
To use this feature, you need to purchase the Ultimate 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_set_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
Configure message extensions for the group message whose MsgSeq is 158:
{
    "GroupId": "@TGS#1YMVAB3IZ",
    "MsgSeq": 158,
    "OperateType": 1,
    "ExtensionList": [
        {"Key": "key1", "Value": "value1", "Seq": 0},
        {"Key": "key2", "Value": "value2", "Seq": 0},
    ]
}
Delete message extensions for the group message whose MsgSeq is 158:
{
    "GroupId": "@TGS#1YMVAB3IZ",
    "MsgSeq": 158,
    "OperateType": 2,
    "ExtensionList": [
        {"Key": "key1", "Value": "", "Seq": 1}
    ]
}
Clear all message extensions for the group message whose MsgSeq is 158:
{
    "GroupId": "@TGS#1YMVAB3IZ",
    "MsgSeq": 158,
    "OperateType": 3
}

Request fields

Field
Type
Required
Description
GroupId
String
Yes
Group ID
MsgSeq
Integer
Yes
Seq of the group message to be configured
OperateType
Integer
Yes
1: Setting key-value pairs for a message; 2: Deleting certain key-value pairs for a message; 3: Clearing all key-value pairs for a message
ExtensionList
Array
Yes (when OperateType is 1 or 2)
Up to 20 key-value pairs can be set or deleted per request
Fields of the objects in ExtensionList are described as follows:
Field
Type
Required
Description
Key
String
Yes
Key in a key-value pair, which can be up to 100 bytes
Value
String
Yes
Value in a key-value pair, which can be up to 1,000 bytes
Seq
Integer
Yes (when the API is not called by an app admin)
Version number of the current key-value pair. Seq is 0 when the API is called by a group member to configure a key-value pair for the first time and is 1 when the configuration is successful. For subsequent key-value pair configuration, the latest Seq of the key-value pair needs to be passed back to the backend, which then checks whether the key-value pair has been modified by others. If the Seq does not match the key-value pair, the configuration fails, and an error code is returned. The backend does not verify the Seq when the API is called by an app admin.

Sample response

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "ExtensionList": [
        {
            "ErrorCode": 0,
            "Extension": {
                "Key": "key1",
                "Value": "value1",
                "Seq": 1
            }
        },
        {
            "ErrorCode": 23001,
            "Extension": {
                "Key": "key2",
                "Value": "value1234",
                "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
Message extension configuration result

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 Ultimate edition plan request.
23001
Seq conflict: The key-value setting has been modified by others. You need to pull the latest Seq to request again.
23002
The configured group message does not support message extension.
23003
Too many key-value setting attempts (more than 200 attempts per minute per message)
23004
The configured group message does not exist.