解散群组
描述
通过此接口即可解散群组。
解散群组成功后,全体群成员都会收到以下 ZIM 回调通知:
iOS | Android | macOS | Windows | Web |
---|---|---|---|---|
groupStateChanged | onGroupStateChanged | groupStateChanged | onGroupStateChanged | groupStateChanged |
小程序 | Flutter | Unity3D | uni-app | React Native |
groupStateChanged | onGroupStateChanged | OnGroupStateChanged | groupStateChanged | groupStateChanged |
接口原型
- 请求方法:GET
- 请求地址:
https://zim-api.zego.im/?Action=DismissGroup
- 传输协议:HTTPS
- 调用频率限制:1 次/秒,群级别限制。如需调整,请联系 ZEGO 技术支持。
请求参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数。
参数 | 类型 | 是否必选 | 描述 |
---|---|---|---|
FromUserId | String | 是 | 操作者用户 ID。可以是任何用户,无需在群内,也无需为群主。 |
GroupId | String | 是 | 群组 ID |
说明
FromUserId 和 GroupID 仅支持数字,英文字符和 '!','#','$','%','&','(',')','+','',':',';','<','=','.','>','?','@','[',']','^','_','{','}','|','~'。
请求示例
Untitled
https://zim-api.zego.im/?Action=DismissGroup
&FromUserId=zego_user&GroupId=groupid
&<公共请求参数>
1
响应参数
参数 | 类型 | 描述 |
---|---|---|
Code | Number | 返回码。 |
Message | String | 操作结果描述。 |
RequestId | String | 请求 ID。 |
响应示例
Untitled
{
"Code": 0,
"Message": "success",
"RequestId": "343649807833778782"
}
1
返回码
以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码。
返回码 | 说明 | 处理建议 |
---|---|---|
660000002 | 输入参数错误。 | 请检查输入参数。 |
660300006 | 频率限制 | 请稍后再试,或了解相关频率限制。 |
660500002 | 操作者用户未注册。 | 请让操作者先注册 ZIM 服务。 |
660600001 | 群组不存在。 | 请确认输入的 GroupID 是否正确。 |