跳到主要内容

创建群组

您可以调用本接口在融云即时通讯(IM)服务上创建群组,并支持设置群组信息,包括群名称、群主、群头像、群简介、自定义群扩展信息、群权限。

开通服务

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

请求方法

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

频率限制:每秒 100 次

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

正文参数

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

参数类型必传说明
groupIdString群组 ID,最大长度为 64 个字符,支持大小写字母与数字的组合。
nameString群组名称,最长 64 个字符,可以重复创建。
ownerString群主的用户 ID。群组创建者默认为群主,并自动加入群组。
userIdsArray需要加入群组的用户 ID 数组,一次最多邀请 30 个用户。
groupProfileString群组基本信息,为 JSON 格式。具体的键(key)请参见下方表格。
permissionsString群组权限信息,为 JSON 格式。具体的键(key)请参见下方表格。
groupExtProfileString群组扩展信息,为 JSON 格式。其中,键(key)必须以 ext_ 为前缀,长度不超过 32 个字符;值(value)的长度不超过 256 个字符;默认最多可设置 10 个键值对(KV)。

groupProfile 中的 key 如下:

key 值类型描述
introductionString群组简介,不超过 512 个字符。
announcementString群组公告,不超过 1024 个字符。
portraitUrlString群组头像 URL,不超过 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:仅自己

请求示例

HTTP
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
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"code": 200
}