导入群基础资料

最近更新时间:2019-08-02 18:36:31

功能说明

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

接口调用说明

适用的群组类型

群组类型 支持此 REST API
私有群(Private)
公开群(Public)
聊天室(ChatRoom)
音视频聊天室(AVChatRoom) 否(见下方说明)
在线成员广播大群(BChatRoom) 否(见下方说明)

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

说明:

音视频聊天室和在线成员广播大群不支持导入群基础资料,对这两种类型的群组进行操作时会返回 10007 错误;如果需要达到导入群组基础资料的效果,可以通过 创建群组修改群组基础资料 的方式实现。

请求 URL 示例

https://console.tim.qq.com/v4/group_open_http_svc/import_group?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

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

参数 说明
v4/group_open_http_svc/import_group 请求接口
sdkappid 创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier 必须为 App 管理员帐号,更多详情请参见 App 管理员
usersig App 管理员帐号生成的签名,具体操作请参见 生成 UserSig
random 请输入随机的32位无符号整数

最高调用频率

100次/秒。如需提升调用频率,请根据 工单模板 提交工单申请处理。

请求包示例

  • 基础形式
    导入群,可以用 CreateTime 指定群组的创建时间。
    {
      "Owner_Account": "leckie", // 群主的 UserId(选填)
      "Type": "Public", // 群组类型:Private/Public/ChatRoom(必填)
      "Name": "TestGroup", // 群名称(必填)
      "CreateTime": 1448357837 // 群组的创建时间(选填,不填会以请求时刻为准)
    }
  • 指定其他选填字段
    指定简介、公告等选填字段,和创建群组相同。
    {
      "Owner_Account": "leckie", // 群主的 UserId(选填)
      "Type": "Public", // 群组类型:Private/Public/ChatRoom(必填)
      "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" // 自定义字段支持二进制数据
          }
      ]
    }

请求包字段说明

字段 类型 属性 说明
Owner_Account String 选填 群主 ID,自动添加到群成员中。如果不填,群没有群主
Type String 必填 群组形态,包括 Public(公开群),Private(私密群), ChatRoom(聊天室)
GroupId String 选填 为了使得群组 ID 更加简单,便于记忆传播,腾讯云支持 App 在通过 REST API 创建群组时自定义群组 ID。详细请参阅 群组系统
Name String 必填 群名称,最长30字节
Introduction String 选填 群简介,最长240字节
Notification String 选填 群公告,最长300字节
FaceUrl String 选填 群头像 URL,最长100字节
MaxMemberCount Integer 选填 最大群成员数量,最大为6000,不填默认为2000个
ApplyJoinOption String 选填 申请加群处理方式。包含 FreeAccess(自由加入),NeedPermission(需要验证),DisableApply(禁止加群),不填默认为NeedPermission(需要验证)
AppDefinedData Array 选填 群组维度的自定义字段,默认情况是没有的,需要开通,详细请参阅 群组系统
CreateTime Integer 选填 群组的创建时间

应答包体示例

  • 基础形式

    {
      "ActionStatus": "OK",
      "ErrorInfo": "",
      "ErrorCode": 0,
      "GroupId": "@TGS#2J4SZEAEL"
    }
  • 指定其他选填字段

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

应答包字段说明

字段 类型 说明
ActionStatus String 请求处理的结果,OK 表示处理成功,FAIL 表示失败
ErrorCode Integer 错误码,0表示成功,非0表示失败
ErrorInfo String 错误信息
GroupId String 创建成功之后的群 ID,由 IM 云后台分配或者用户指定

错误码说明

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

错误码 含义说明
10002 服务器内部错误,请重试
10003 请求命令字非法
10004 参数非法,请根据错误描述检查请求是否正确
10007 操作权限不足,例如 Public 群组中普通成员尝试执行踢人操作,但只有 App 管理员才有权限
10021 群组 ID 已被使用,请选择其他的群组 ID
80001 文本安全打击。请检查群名称、群公告和群简介等是否有敏感词汇

接口调试工具

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

参考