tencent cloud

功能说明

App 管理员和群成员可以为群聊普通消息设置消息扩展，消息扩展为一组自定义的键值对。

注意：

• 此功能需 旗舰版套餐，并且已开通“消息扩展功能”功能(控制台“登录与消息”配置)。
• 单条群消息可设置的最大键值对数量为300条。
• 被设置的群消息需要在发送时指定“支持消息扩展”，参见 在群组中发送普通消息。

接口调用说明

适用的群组类型

即时通信 IM 内置上述群组类型，详情介绍请参见 群组系统。

请求 URL 示例

https://xxxxxx/v4/openim_msg_ext_http_svc/group_set_key_values?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参考 REST API 简介。

最高调用频率

200次/秒。

请求包示例

• 基础形式

为MsgSeq为158的群消息设置消息扩展：

{
    "GroupId": "@TGS#1YMVAB3IZ",
    "MsgSeq": 158,
    "OperateType": 1,
    "ExtensionList": [
        {"Key": "key1", "Value": "value1", "Seq": 0},
        {"Key": "key2", "Value": "value2", "Seq": 0},
    ]
}

为MsgSeq为158的群消息删除消息扩展：

{
    "GroupId": "@TGS#1YMVAB3IZ",
    "MsgSeq": 158,
    "OperateType": 2,
    "ExtensionList": [
        {"Key": "key1", "Value": "", "Seq": 1}
    ]
}

将MsgSeq为158的群消息的所有消息扩展清空：

{
    "GroupId": "@TGS#1YMVAB3IZ",
    "MsgSeq": 158,
    "OperateType": 3
}

请求包字段说明

其中ExtensionList中对象的每一个字段说明如下：

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "ExtensionList": [
        {
            "ErrorCode": 0,
            "Extension": {
                "Key": "key1",
                "Value": "value1",
                "Seq": 1
            }
        },
        {
            "ErrorCode": 23001,
            "Extension": {
                "Key": "key2",
                "Value": "value1234",
                "Seq": 2
            }
        }
    ]
}

应答包字段说明

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：