解散群组
将群组解散。解散后,所有用户都无法再接收该群的消息。
对本地历史消息记录的影响:
- 群组解散后,客户端仍可查看已保存到本地的群组历史消息。
对远端历史消息记录的影响(仅适用于已开通单群聊消息云存储服务的情况):
- 解散群组不会删除该群组在服务端的历史消息。如需清除,可使用融云 IM 服务端提供的删除消息接口。
- 群组关系解散后,App 客户端无权再拉取云存储服务中的群组历史消息。
提示
如果单群聊消息云存储服务中的历史消息未被清除,只要创建同 ID 的群组,客户端仍可拉取到之前的历史消息。
解散群组的基本流程:
- 用户在您的应用中进行解散群组操作,并向您的应用服务器发起解散群组请求。
- 您的应用后端调用融云服务端 API 解散群组。
解散群组时序图:
请求方法
POST: https://数据中心域名/group/dismiss.json
频率限制: 每秒 100 次
签名规则: 所有服务端 API 请求均需要进行规则校验,详见 API 请求签名。
正文参数
HTTP 请求正文支持以下 application/x-www-form-urlencoded
表单参数:
参数 | 类型 | 必传 | 说明 |
---|---|---|---|
userId | String | 是 | 操作解散群组的用户 ID。该用户不必是群主或者群组创建者,可以为任何用户。 |
groupId | String | 是 | 要解散的群组 ID。 |
请求示例
HTTP
POST /group/dismiss.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&groupId=123
返回 结果
HTTP 响应正文包含具有以下结构的 JSON 对象:
返回值 | 返回类型 | 说明 |
---|---|---|
code | Number | 返回码,200 表示请求成功。 |
返回结果示例
HTTP
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{"code":200}
常见问题
客户端能否解散群组?
默认情况下,客户端不能解散群组,该操作必须由您的应用服务器请求融云服务端 API 实现。
提示
如果您开通了用户信息托管服务,则可以通过客户端 SDK 进行群组管理,包括解散群组。
解散群组后会发送通知吗?
调用解散群组接口不会主动向 SDK 发送通知消息。如果您希望给用户发送解散群组的通知消息,可通过发送系统消息的方式进行通知。