创建群组
融云即时通讯服务 (IM) 不管理群组的业务逻辑,因此群组的业务逻辑全部在您的应用服务器进行实现。对于客户端开发人员来说,创建群组只需要与您的应用后端交互即可。
提示
每个群的成员上限为 3000 人,应用内的群组数量没有限制,每个用户可加入和创建的群组数量也没有限制。
基本流程:
- 您的客户端需要创建群组时,向您的应用后端发起请求。
- 您的应用后端自行生成群组 ID,并调用融云服务端 API 接口创建群组,同时可以传入需要入群的用户 ID。
- 融云 IM 服务端创建群组成功后,返回给您的应用后端。
- 您的应用后端通知客户端群组创建成功。用户已加入该群组,可以在群组中收发消息。
创建群组时序图
请求方法
POST: https://数据中心域名/group/create.json
频率限制: 每秒 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文支持以下 application/x-www-form-urlencoded
表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
userId | String | 是 | 要加入群组的用户 ID,最多不超过 1000 个。 |
groupId | String | 是 | 群组 ID,最大长度为 64 个字符。支持大小写英文字母和数字。 |
groupName | String | 是 | 群组名称。最大长度为 128 个字符。若超过长度限制,则自动截取前 125 个字符并添加“...”。此参数用于在发送群组消息的远程推送通知中显示。如果群组名称后续发生变化 ,您需要调用刷新群组信息接口进行同步。 |
请求示例
HTTP
POST /group/create.json HTTP/1.1
Host: api.rong-api.com
App-Key: uwd1c0sxdlx2
Timestamp: 1408710653491
Nonce: 14314
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/x-www-form-urlencoded
userId=1&userId=2&groupId=123&groupName=TestGroup
返回结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 表示请求成功。 |
返回结果示例
HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}
常见问题
融云是否维护群组信息?
融云 IM 服务不维护群组的基本信息(如头像、名称、群成员名片等),需要由您的应用服务器自行维护。
客户端能否创建群组?
不能。创建群组必须由您的应用服务器请求融云 IM 服务端 API 实现。融云 IM 服务的客户端 SDK 不提供创建群组的方法。
提示
如果您开通了用户信息托管服务,则可以通过客户端 SDK 进行群组管理,包括创建群组。
创建群组后会发送通知吗?
融云 IM 服务在创建群组、用户加入、或退出群组等操作完成后,不会自动发送通知消息。您需要根据自身的业务场景,决定是否以及何时发送相应的群通知消息。
例如,在创建群组后发送一条通知消息的流程如下:
-
您的应用请求您的应用服务端创建群组。
-
您的应用服务端调用融云服务端 API,申请创建群组。
-
收到成功的响应(
code
为200
)后,调用发送群消息 API 接口,发送创建群组的通知消息。