tencent cloud

功能说明

• 该 API 接口的作用是导入群组成员，不会触发回调、不会下发通知。
• 当 App 需要从其他即时通信系统迁移到即时通信 IM 时，使用该协议导入存量群成员数据。

接口调用说明

适用的群组类型

即时通信 IM 内置以上四种群组类型，详情请参阅 群组系统。

说明：

AVChatRoom（直播群）所适用的场景一般不需要导入成员，因此不支持导入群成员功能，对此类型的群组进行操作时会返回10007错误。

请求 URL 示例

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

请求参数说明

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

最高调用频率

200次/秒。

请求包示例

用来向群中导入成员，一次请求最多支持添加300个成员；使用本接口设置的未读消息数如果大于群当前的消息数，未读消息数会设为群当前的消息总数。

注意：

请保证导入成员的入群时间大于群的创建时间并小于当前时间，否则该成员会导入失败。

{
    "GroupId": "@TGS#2J4SZEAEL", // 要操作的群组（必填）
    "MemberList": [ // 一次最多添加300个成员
    {
        "Member_Account": "tommy", // 要添加的群成员 ID（必填）
        "Role":"Admin", // 导入成员的角色，目前只有 Admin(可选)
        "JoinTime":1448357837, // 导入的成员入群时间（选填）
        "UnreadMsgNum":5 // 该成员的未读消息数（选填）

    },
    {
        "Member_Account": "jared",
        "JoinTime":1448357857,
        "UnreadMsgNum":2
    }]
}

请求包字段说明

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "MemberList": [
    {
         "Member_Account": "tommy",
         "Result": 1 // 导入结果：0表示失败；1表示成功；2表示已经是群成员
    },
    {
         "Member_Account": "jared",
         "Result": 1
    }]
}

应答包字段说明

错误码说明

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

接口调试工具

通过 REST API 在线调试工具 调试本接口。

参考

删除群成员（v4/group_open_http_svc/delete_group_member）