即时通讯
  • iOS : Objective-C
  • Android
  • macOS
  • Windows
  • Web
  • 小程序
  • Flutter
  • Unity3D
  • uni-app
  • React Native
  • 产品简介
  • 下载
  • 快速开始
    • 跑通示例源码
    • 实现基本消息收发
  • 用户相关
  • 房间相关
  • 群组相关
  • 消息相关
  • 呼叫邀请
  • 会话管理
  • 缓存管理
  • 离线推送
  • 语音组件
  • 客户端 API
  • 服务端 API
  • 迁移方案
  • SDK 错误码
  • 常见问题
  • 文档中心
  • 即时通讯
  • 服务端 API
  • 群组相关
  • 修改群规格限制

修改群规格限制

更新时间:2024-03-29 23:07

描述

通过此接口修改群组的以下规格限制:

  • 进群模式;
  • 邀请模式;
  • 受邀请模式;
  • 群组成员人数上限(最高不超过套餐包的限制,详情请参考 计费说明 - 版本说明)。

修改成功后,群成员可通过以下 ZIM SDK 的回调接口接收群组规格限制修改的通知:

接口原型

  • 请求方法:GET
  • 请求地址:https://zim-api.zego.im/?Action=ModifyGroupLimit
  • 传输协议:HTTPS
  • 调用频率限制:20 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数

参数 类型 是否必选 描述
FromUserId
String
修改操作者的用户 ID(已注册)。
GroupId
String
目标群组的 ID。
JoinMode
Number
加入群组的模式:

  • 0:(默认值)无需验证,任何人可以直接加入群。
  • 1:用户需发起入群申请,群主或群管理员批准后,该用户才能加入群。
  • 2:外部用户需经群内成员邀请方可入群。
InviteMode
Number
邀请模式:

  • 0:(默认值)所有群成员都能邀请外部用户入群。
  • 1:只有群主或者群管理员可以发起邀请。
BeInvitedMode
Number
受邀请模式:

  • 0:(默认值)可以直接邀请外部用户入群,无需对方同意。
  • 1:邀请某人加入群组后,需要对方同意。
MemberCountLimit
Number
群组成员人数上限,默认值为 0。
  • FromUserID 和 GroupId 仅支持数字,英文字符和 '!','#','$','%','&','(',')','+','',':',';','<','=','.','>','?','@','[',']','^','_','{','}','|','~'。
  • 如果无需修改 JoinModeInviteModeBeInvitedMode,请不要请求 URL 中携带该参数。如果携带参数但没赋值,该参数的值可能会被修改为 0。

请求示例

https://zim-api.zego.im/?Action=ModifyGroupLimit
&<公共请求参数>
&FromUserId=zego
&GroupId=group
&JoinMode=1
&MemberCountLimit=100

响应参数

参数 类型 描述
Code
Number
返回码。
Message
String
操作结果描述。
RequestId
String
请求 ID。

响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782"
 }

返回码

以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码

返回码 说明 处理建议
660000001
服务端出错。
请重试,或联系 ZEGO 技术支持。
660000002
输入的参数缺失或不合法。
请检查输入的参数。
660300005
调用接口的频率超出了 AppID 级别限制。
请稍后再试。
660500002
操作者用户未注册。
请先注册操作者用户。
660600001
群不存在
请确认输入的 GroupId 是否正确。
660600009
获取群相关信息失败。
请先确认 GroupID 是否正确。如果正确,请联系 ZEGO 技术支持。
本篇目录