查询 App 下的禁言群组列表

POST

https://zim-api.zego.im/

本接口用于查询 App 中的所有禁言群组的 ID，包含处于全员禁言、按群组角色禁言或按用户 ID 禁言状态的群组。

本接口每次默认返回 10000 个群组，如需调整，请联系 ZEGO 技术支持。

说明

调用频率限制：20 次/秒。

Request

Query Parameters

Action string必填

可选值: [FetchForbidGroupList]

接口原型参数

https://zim-api.zego.im/?Action=FetchForbidGroupList

AppId uint32必填

💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台获取。

SignatureNonce string必填

💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考签名示例。

Timestamp int64必填

💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考签名示例，最多允许 10 分钟的误差。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

application/json

Body

required

FromUserId string必填

可选值: <= 32 characters

查询操作者的用户 ID（已在客户端调用 login 方法登录 ZIM 服务，或已调用服务端 API 完成注册）。

StartFlag number必填

分页拉取标志。第一次填 0，之后填上一次返回的 NextFlag 值。当返回的 NextFlag 为 0 时，表示群组列表获取完毕。

Responses

application/json

数据结构
按数据结构生成的示例
示例

Schema

Code number

返回码。

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

返回码	描述	处理建议
660000002	输入参数错误。	请检查输入的参数。
660000003	逻辑处理错误。	请重试，或联系 ZEGO 技术支持。
660000011	用户个数超过限制。	请检查输入的用户列表。

Message string

操作结果描述。

RequestId string

请求 ID。

FetchEnd number

是否拉取完毕： - 0：否。 - 1：是。

NextFlag number

当 FetchEnd 为 0 时，表示仍有更多群组可拉取，可将其作为下次接口调用的 StartFlag。
当 FetchEnd 为 1 时，表示列表已拉取完毕，此时请忽略此字段。

GroupList object[]

禁言群组列表。

Array[

GroupId string

群组 ID。

ForbidType number

禁言类型：

1：全员禁言
2：按群组角色禁言
4：按用户 ID 禁言

如果同时存在多种禁言情况，ForbidType 会把这些数值相加，例如同时全员禁言（1）和按群组角色禁言（2）时，ForbidType 为 3。

]

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "FetchEnd": 1,
  "NextFlag": 100000,
  "GroupList": [
    {
      "GroupId": "group_1",
      "ForbidType": 1
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "FetchEnd": 1,
  "NextFlag": 100000,
  "GroupList": [
    {
      "GroupId": "group_1",
      "ForbidType": 1
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "FetchEnd": 1,
  "NextFlag": 100000,
  "GroupList": [
    {
      "GroupId": "group_1",
      "ForbidType": 1
    },
    {
      "GroupId": "group_2",
      "ForbidType": 5
    }
  ]
}

{
  "Code": 0,
  "Message": "success",
  "RequestId": "343649807833778782",
  "FetchEnd": 1,
  "NextFlag": 100000,
  "GroupList": [
    {
      "GroupId": "group_1",
      "ForbidType": 1
    },
    {
      "GroupId": "group_2",
      "ForbidType": 5
    }
  ]
}

CURL

ZEGO 签名生成器

AppId

ServerSecret

RESPONSE清除

点击上方 “发送” 按钮，在此处查看响应。