修改群规格限制
GET
https://zim-api.zego.im/
通过此接口修改群组的以下规格限制:
- 进群模式;
- 邀请模式;
- 受邀请模式;
- 群组成员人数上限(最高不超过套餐包的限制,详情请参考 计费说明 - 版本差异)。
修改成功后,群成员可通过以下 ZIM SDK 的回调接口接收群组规格限制修改的通知:
| iOS | Android | macOS | Windows |
|---|---|---|---|
| groupVerifyInfoUpdated | onGroupVerifyInfoUpdated | groupVerifyInfoUpdated | onGroupVerifyInfoUpdated |
| Web | 小程序 | Flutter | React Native |
|---|---|---|---|
| groupVerifyInfoUpdated | groupVerifyInfoUpdated | onGroupVerifyInfoUpdated | groupVerifyInfoUpdated |
| Unity3D | uni-app | uni-app x | HarmonyOS |
|---|---|---|
| OnGroupVerifyInfoUpdated | groupVerifyInfoUpdated | groupVerifyInfoUpdated |
说明
参数 FromUserID 和 GroupId 仅支持数字,英文字符和 '!','#','$','%','&','(',')','+','',':',';','<','=','.','>','?', '@','[',']','^','_','{','}','|','~'。
如果无需修改 JoinMode、InviteMode 或 BeInvitedMode,请不要请求 URL 中携带该参数。如果携带参数但没赋值,该参数的值可能会被修改为 0。
说明
调用频率限制:20 次/秒。
Request
Query Parameters
- 0:(默认值)无需验证,任何人可以直接加入群。
- 1:用户需发起入群申请,群主或群管理员批准后,该用户才能加入群。
- 2:外部用户需经群内成员邀请方可入群。
- 0:(默认值)所有群成员都能邀请外部用户入群。
- 1:只有群主或者群管理员可以发起邀请。
- 0:(默认值)可以直接邀请外部用户入群,无需对方同意。
- 1:邀请某人加入群组后,需要对方同意。
Action string必填
可选值: [ModifyGroupLimit]
接口原型参数
https://zim-api.zego.im/?Action=ModifyGroupLimit
AppId uint32必填
💡公共参数。应用 Id,由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台 获取。
SignatureNonce string必填
💡公共参数。16 位 16 进制随机字符串(8 字节随机数的 hex 编码)。生成算法可参考 签名示例。
Timestamp int64必填
💡公共参数。当前 Unix 时间戳,单位为秒。生成算法可参考 签名示例,最多允许 10 分钟的误差。
SignatureVersion string必填
可选值: [2.0]
默认值: 2.0
💡公共参数。签名版本号。
Signature string必填
💡公共参数。签名,用于验证请求的合法性。请参考签名机制生成。
GroupId string必填
可选值: <= 32 characters
目标群组的 ID。
JoinMode number
可选值: [0, 1, 2]
加入群组的模式:
InviteMode number
可选值: [0, 1]
邀请模式:
BeInvitedMode number
可选值: [0, 1]
受邀请模式:
MemberCountLimit number
群组成员人数上限,默认值为 0。
Responses
- 200
OK
- application/json
