创建群组
即时通讯服务不管理群组的业务逻辑,因此群组的业务逻辑全部在 App 服务器进行实现,对于客户端开发人员来说,创建群组只需要与 App 后端交互即可。
提示
每个群群成员上限 3000 人,App 内的群组数量没有限制,每个用户加入和创建的群组数量没有限制。
基本流程:
- App 客户端需要创建群组时,向 App 后端发起请求。
- App 后端自行生成群组 ID,并调用即时通讯服务端 API 接口创建群组。同时可以传入需要入群的用户 ID。
- 即时通讯服务创建群组成功后,返回给 App 后端。
- App 后端通知客户端群组创建成功。用户已加入该群组,可以在群组中收发消息。
创建群组时序图
请求方法
POST: https://数据中心域名/group/create.json
频率限制: 每秒钟限 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文数据格式为 application/x-www-form-urlencoded
,支持以下 HTTP 表单参数:
参数 | 类型 | 是否必传 | 说明 |
---|---|---|---|
userId | String | 必传 | 要加入群的用户 ID,最多不超过 1000 个。 |
groupId | String | 必传 | 创建群组 ID,最大长度 64 个字符。支持大小写英文字母与数字的组合。 |
groupName | String | 必传 | 群组 ID 对应的名称,用于在发送群组消息显示远程 Push 通知时使用,如群组名称改变需要调用刷新群组信息接口同步。 |
请求示例
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/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}
常见问题
即时通讯服务不维护群的基本信息(头像、名称、群成员名片等),需要由开发者应用服务器维护。
创建群组必须由 App 服务器请求即时通讯服务端 API 实现。即时通讯服务移动端 SDK 不提供创建群组的方法。
即时通讯服务在创建群组、用户加入、退出群组等完成群组操作后,不会发送通知消息。创建群组、成功加入及退出群组等群通知消息,需要由客户根据自身的业务场景决定,是否发送、什么时候发送。
以创建群组为例,发送群组通知消息的流程如下:
-
App 请求自己的 App Server 创建群组。
-
App Server 调用即时通讯服务端 API,申请创建群组。
-
返回 200 成功后,使用发送群消息 API 接口,发送创建群组通知消息。