API 参考
圈组

查询临时禁言操作记录

更新时间: 2024/07/17 17:57:34

云信支持查询临时禁言的操作记录,可以通过服务端/频道/用户多个维度进行查询。

前提限制

使用圈组临时禁言功能需要相关权限,请提前开启身份组权限项中的 禁言/临时禁言管理QChatRoleResource.MUTE)。

URL

POST  http://api.netease.im/nimserver/qchat/queryMuteHistoryPage.action  HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

  • POST 请求中 Headers 的设置请参考 API 调用方式

  • POST 请求中 Body 的设置如下:

参数类型必须说明
targetAccountIdString用户帐号 ID
serverIdLong服务器 ID
channelIdLong频道 ID
queryTypeInteger查询范围,1-仅服务器(不包括频道)、2-服务器(包括频道)、3-频道、4-服务器(包括频道的某个用户)、5-服务器(不包括频道的某个用户)、6-某个用户的所有记录
pageTokenString分页参数,使用上一次请求成功返回的分页标识
limitInteger本次查询的数量上限,单次最多返回 100 条记录

示例

cURL 请求示例

curl -X POST -H "AppKey: go9dnk49**803mgq3" -H "Nonce: 4tggg**323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb**316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&queryType=1' 'http://api.netease.im/nimserver/qchat/queryMuteHistoryPage.action'

返回参数

参数 类型 说明
code Integer 状态码
data Array of objects 禁言操作记录,具体字段信息见下表
pageInfo Object 分页信息,具体见下表

pageInfo 字段 类型 说明
hasMore Boolean 是否有下一页
nextPageToken String 分页标识

data 字段 类型 说明
accountId String 用户账号 ID
serverId String 服务器 ID
channelId String 频道 ID
beReleaseTime Long 自动解除禁言的时间戳
realReleaseTime Long 实际解除禁言的时间戳
muteOperateTime Long 被临时禁言的操作时间戳
operateType Integer 禁言操作类型,1-禁言、2-解禁、3-自动解禁
muteLevel Integer 临时禁言维度,1-服务器、2-频道
muteType Integer 禁言类型,1-临时禁言
muteOperatorAccountId String 操作者账号 ID
releaseOperatorAccountId String 被操作者的账号 ID
duration Long 被临时禁言的持续时间

返回示例

"Content-Type": "application/json; charset=utf-8"
{
    "code": 200,
    "data": [
        {
            "accountId": "111111",
            "serverId": 11111,
            "channelId": 11112222,
            "beReleaseTime": 11131312324, //将要解禁时间
            "realReleaseTime": 11131312324, //将要解禁时间
            "muteOperateTime": 11131312324, //禁言操作时间
            "operateType":1, //类型:1-禁言、2-解禁、3-自动解禁
            "muteLevel": "1",  //禁言级别:1-server、2-channel
            "muteType": "1", //禁言类型:1-临时禁言
            "muteOperatorAccountId": "3232323",  //操作者账号
            "releaseOperatorAccountId": "sdfada", //解除禁言操作者账号
            "duration": 100, //禁言持续时间,单位:秒
        }
    ],
    "pageInfo":{
        "hasMore":true,
        "nextPageToken":"dsfdsfsdf"    
    }
}

状态码

该接口在 HTTPS Body 中返回请求的状态码,以下仅列出与接口业务强相关的状态码。完整状态码请参见 状态码

200、403、404、414、416、431

此文档是否对你有帮助?
有帮助
去反馈
  • 前提限制
  • URL
  • 请求参数
  • 示例
  • cURL 请求示例
  • 返回参数
  • 返回示例
  • 状态码