tencent cloud

功能说明

App 管理员和群主可以对直播群成员设置不同的标记以区分不同类型的群成员。该功能需旗舰版，并且在 IM 控制台“群功能配置”中开通“直播群在线成员列表”功能。其他套餐版本调用该API将返回失败。

接口调用说明

适用的群组类型

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

注意：

• 此功能需 旗舰版套餐，并且已开通“直播群在线成员列表”功能(控制台“群功能配置”)。
• 其他套餐版本调用该API返回失败。
• 每个直播群可以设置最多不超过10个不同类型的标记。
• 每一个标记可以设置最多1000人，该限制和直播群在线成员列表的1000人互相独立。
• 被设置标记的群成员需要在线（设置标记为500的成员除外，参见“特殊标记”）。当成员退群、掉线时标记信息会被清除，可以在通过第三方回调在该成员进群、上线时重新设置标记。

请求 URL 示例

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

请求参数说明

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

最高调用频率

200次/秒。

请求包示例

为直播群中teacher10设置标记1000，为直播群中student9设置标记1001：

{
    "GroupId": "@TGS#a6I4ZUUGO",
    "CommandType": 1,
    "MemberList": [
        {
            "Member_Account": "teacher10",
            "Marks": [1000]
        },
        {
            "Member_Account": "student9",
            "Marks": [1001]
        },
    ]
}

为直播群中teacher10取消标记1000，为直播群中student9取消标记1001：

{
    "GroupId": "@TGS#a6I4ZUUGO",
    "CommandType": 2,
    "MemberList": [
        {
            "Member_Account": "teacher10",
            "Marks": [1000]
        },
        {
            "Member_Account": "student9",
            "Marks": [1001]
        },
    ]
}

请求包字段说明

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorCode": 0,
    "ErrorInfo": "",
    "CommandType": 1,
    "MemberList": [
        {
            "Member_Account": "teacher10",
            "Marks": [1000]
        },
        {
            "Member_Account": "student9",
            "Marks": [1001]
        }
    ]
}

应答包字段说明

特殊标记

App管理员和群主可以为群成员设置范围为 [1000, +) 的标记，除此之外，App管理员可以设置IM预置的特殊标记，支持的特殊标记如下

错误码说明

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