获取群组禁言列表

更新时间: 2024/03/15 14:27:33

用户可查询群组禁言的成员列表。

API 使用限制

单个应用中 1 秒内所有的高级群操作 API 合计最多可调用 100 次,超过后限制调用,会返回 416 错误码。

除发送群消息 API 外,其他所有高级群 API 都属于高级群操作 API。

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API 调用方式
  • POST 请求中 Body 的设置如下:
参数类型必填说明
tidLong云信服务器产生,群唯一标识,创建群时会返回,最大长度 64 位长整型
owner String群主账号,accid,最大长度 32 位字符

返回参数

参数 类型 说明
code Integer 状态码
mutes String 被禁言的群成员列表,JSON

mutes 中的参数说明

参数 类型 说明
nick String 群成员昵称
accid String 群成员账号,accid
tid Long 群 ID
type Integer 群成员类型
0,普通成员;1,群主;2,管理员

示例

请求示例(curl)

curlcurl -X POST -H "AppKey: go9dnk49b***glw0803mgq3" -H "Nonce: 4tggger**ow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'tid=1513535&owner=wangwu' 'https://api.netease.im/nimserver/team/listTeamMute.action'

请求成功返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
    "mutes":[
        {
            "nick":"nick1", 
            "accid":"user1", 
            "tid":17874, 
            "type":0}, 
        {"nick":"nick2","accid":"user2","tid":17874,"type":0}
    ]
}

请求失败返回示例

"Content-Type": "application/json; charset=utf-8"
{
"code": 414,  // 参数错误
"desc": "xxxx  is empty" 
}

状态码

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

状态码 说明 处理建议
200 请求成功 -
403 禁止操作:
owner 不是群成员或 owner 不是群主
根据对应提示信息做出处理
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
416 调用频率超出限制 降低访问频率
500 服务出错 -
此文档是否对你有帮助?
有帮助
去反馈
  • API 使用限制
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例(curl)
  • 请求成功返回示例
  • 请求失败返回示例
  • 状态码