跳到主要内容

加入群组

即时通讯服务不管理群组的业务逻辑,因此群组的业务逻辑全部在 App 服务器进行实现,对于客户端开发人员来说,创建群组只需要与 App 后端交互即可。

提示

每个群群成员上限 3000 人,App 内的群组数量没有限制,每个用户加入和创建的群组数量没有限制。

基本流程

  1. 客户端请求 App 后端加入群组。

  2. App 后端调用即时通讯服务端 API,申请加入群组。群组 ID 由 App 服务器管理,创建成功后,同时返回给客户端。

  3. 用户成功加入该群组后,可以在该群组内收发消息。

    用户加入群组后,默认只能查看加入时间点后的群消息。如果希望用户入群后可查看群历史记录,需在控制台开通以下功能:

    • 单群聊历史消息云存储
    • 新用户获取加入群组前历史消息

加入群组时序图

请求方法

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

频率限制: 每秒钟限 100 次

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

正文参数

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

参数类型必传说明
userIdString要加入群的用户 ID,可提交多个。最多不超过 1000 个。
groupIdString要加入的群的群组 ID。
groupNameString要加入的群的名称。

注意:加入群组时,如果传入 groupName,则会修改推送通知中携带的群组名称,效果与调用刷新群组信息一致。

请求示例

POST /group/join.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 对象:

返回值返回类型说明
codeNumber返回码,200 为正常。

返回结果示例

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

{"code":200}