跳到主要内容

创建群组

此接口允许在 IM Server 上创建群组，并支持设置群组信息，包括群名称、群主、群头像、群简介，自定义群扩展信息、群权限。

开通服务​

调用此接口前，您须在控制台开通信息托管服务。详情请参阅开启用户信息托管。

请求方法​

POST： https://数据中心域名/entrust/group/create.json

频率限制： 每秒钟限 100 次

签名规则： 所有服务端 API 请求均需要进行规则校验，详见 API 请求签名。

正文参数​

HTTP 请求正文数据格式为 application/x-www-form-urlencoded，支持以下 HTTP 表单参数：

参数类型必传说明
groupIdString是群组ID，最大长度 64 个字符。支持大小写英文字母与数字的组合。
nameString是群名称，最长不超过 64 个字符，群名称可以重复创建。
ownerString是群主。创建者 ID ，默认为群主 ID ，该用户自动加入到群组中。
userIdsArray否加入群组的用户 ID 数组，一次最多允许 30 个用户加入。
groupProfileString否群组基本信息, 为 JSON 格式，具体的键（key）参考下方详情。
permissionsString否群组权限信息, 为 JSON 格式，具体的键（key）参考下方详情。
groupExtProfileString否群组扩展信息，为 JSON 格式。键（key）的前缀必须加 ext_，其长度不超过 32 个字符；值（value）的长度不超过 256 个字符； 键值对（KV）默认可设置 10个。

groupProfile 中的 key 如下：

key 值类型描述
introductionString群简介，不超过 512 个字符
announcementString群公告，不超过 1024 个字符
portraitUrlString群头像地址，不超过 128 个字符

permissions 中的 key 如下：

key 值类型描述
joinPermNumber加入群权限：
  • 0：需要群主验证（默认）
  • 1：不用验证
  • 2：群管理员或群主验证
  • 3： 不允许任何人加入
removePermNumber将群成员移出群组权限：
  • 0：群主（默认）
  • 1：群主+群管理员
  • 2： 所有人
memInvitePermNumber邀请他人入群权限：
  • 0：群主（默认）
  • 1：群主+群管理员
  • 2： 所有人
invitePermNumber邀请加入群组处理方式：
  • 0：需要被邀请人同意（默认）
  • 1： 需要被邀请人同意
profilePermNumber修改群资料及权限：
  • 0：群主（默认）
  • 1：群主+群管理员
  • 2： 所有人
memProfilePermNumber设置群成员资料权限：
  • 0：群主+群管理员+自已（默认）
  • 1：群主+自已
  • 2： 仅自已

请求示例​

POST /entrust/group/create.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded

groupId=2222334444&name=testGName&owner=userId

返回结果​

HTTP 响应正文包含具有以下结构的 JSON 对象：

返回值返回类型说明
codeNumber返回码，200 表示请求成功。

返回结果示例​

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "code": 200,
}
最后于 更新