tencent cloud

功能说明

App 管理员可以通过该接口导入群组，不会触发回调、不会下发通知；当 App 需要从其他即时通信系统迁移到即时通信 IM 时，使用该协议导入存量群组数据。

接口调用说明

适用的群组类型

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

说明：

AVChatRoom（直播群）不支持导入群基础资料，对此类型的群组进行操作时会返回10007错误；如果需要达到导入群组基础资料的效果，可以通过 创建群组 和 修改群组基础资料 的方式实现。

请求 URL 示例

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

请求参数说明

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

最高调用频率

200次/秒。

请求包示例

• 基础形式
  导入群，可以用 CreateTime 指定群组的创建时间。

  {
    "Owner_Account": "leckie", // 群主的 UserId（选填）
    "Type": "Public", // 群组类型：Private/Public/ChatRoom/Community（必填）
    "Name": "TestGroup", // 群名称（必填）
    "CreateTime": 1448357837 // 群组的创建时间（选填，不填会以请求时刻为准）
  }
  

• 仅包含支持话题参数形式
  导入群组，并指定其类型为社群且支持话题。

  {
    "Type": "Community",       //群组类型 (必填)
    "Name": "test_import_group",  //群组名称 (必填)
    "SupportTopic": 1    // 是否支持话题选项, 1代表支持,0代表不支持
  }
  

• 指定其他选填字段
  指定简介、公告等选填字段，和创建群组相同。

  {
    "Owner_Account": "leckie", // 群主的 UserId（选填）
    "Type": "Public", // 群组类型：Private/Public/ChatRoom/Community（必填）
    "GroupId":"MyFirstGroup", // 用户自定义群组外显 ID（选填）
    "Name": "TestGroup", // 群名称（必填）
    "Introduction": "This is group Introduction", // 群简介（选填）
    "Notification": "This is group Notification", // 群公告（选填）
    "FaceUrl": "http://this.is.face.url",
    "MaxMemberCount": 500, // 最大群成员数量（选填）
    "ApplyJoinOption": "FreeAccess", // 申请加群处理方式（选填）
    "CreateTime": 1448357837, // 群组的创建时间（选填，不填会以请求时刻为准）
    "AppDefinedData": [ // 群组维度的自定义字段（选填）
        {
            "Key": "GroupTestData1", // App 自定义的字段 Key
            "Value": "xxxxx" // 自定义字段的值
        },
        {
            "Key": " GroupTestData2",
            "Value": "abc\u0000\u0001" // 自定义字段支持二进制数据
        }
    ]
  }
  

请求包字段说明

应答包体示例

• 基础形式

  {
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "GroupId": "@TGS#2J4SZEAEL"
  }
  

• 仅包含支持话题参数形式

  {
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "GroupId": "@TGS#_@TGS#c4YHCIIM62CX"
  }
  

• 指定其他选填字段

  {
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "GroupId": "MyFirstGroup"
  }
  

应答包字段说明

错误码说明

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

接口调试工具

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

参考

• 设置成员未读计数（v4/group_open_http_svc/set_unread_msg_num）
• 导入群成员（v4/group_open_http_svc/import_group_member）
• 解散群组（v4/group_open_http_svc/destroy_group）