logo
当前页

修改群规格限制


描述

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

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

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

iOSAndroidmacOSWindowsWeb
groupVerifyInfoUpdatedonGroupVerifyInfoUpdatedgroupVerifyInfoUpdatedonGroupVerifyInfoUpdatedgroupVerifyInfoUpdated
小程序Flutteruni-appReact Native
groupVerifyInfoUpdatedonGroupVerifyInfoUpdatedgroupVerifyInfoUpdatedgroupVerifyInfoUpdated

接口原型

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

请求参数

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

参数类型是否必选描述
FromUserIdString修改操作者的用户 ID(已注册)。
GroupIdString目标群组的 ID。
JoinModeNumber加入群组的模式:
  • 0:(默认值)无需验证,任何人可以直接加入群。
  • 1:用户需发起入群申请,群主或群管理员批准后,该用户才能加入群。
  • 2:外部用户需经群内成员邀请方可入群。
InviteModeNumber邀请模式:
  • 0:(默认值)所有群成员都能邀请外部用户入群。
  • 1:只有群主或者群管理员可以发起邀请。
BeInvitedModeNumber受邀请模式:
  • 0:(默认值)可以直接邀请外部用户入群,无需对方同意。
  • 1:邀请某人加入群组后,需要对方同意。
MemberCountLimitNumber群组成员人数上限,默认值为 0。
说明
  • FromUserID 和 GroupId 仅支持数字,英文字符和 '!','#','$','%','&','(',')','+','',':',';','<','=','.','>','?','@','[',']','^','_','{','}','|','~'
  • 如果无需修改 JoinModeInviteModeBeInvitedMode,请不要请求 URL 中携带该参数。如果携带参数但没赋值,该参数的值可能会被修改为 0。

请求示例

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

响应参数

参数类型描述
CodeNumber返回码。
MessageString操作结果描述。
RequestIdString请求 ID。

响应示例

Untitled
{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782"
 }
1
Copied!

返回码

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

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

Previous

创建群组

Next

查询 App 下的群组列表