服务端
API 参考
圈组

更新成员封禁状态

更新时间: 2024/03/15 14:31:53

云信服务端支持封禁某个服务器成员。

功能介绍

拥有“封禁他人权限”的服务器成员可调用本 API 封禁某位服务器成员。被封禁的成员将直接被踢出服务器,且不能再申请加入服务器或被邀请加入服务器。某成员被封禁后,所有该服务器成员都会收到该封禁成员被踢的系统通知。

URL

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

请求参数

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

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

参数类型必须说明
accidString操作者用户帐号 操作者需要拥有封禁他人的权限,否则将返回 403 错误码。权限相关配置请参见修改服务器身份组
serverIdLong服务器 ID
opeTypeint操作类型,1-封禁,2-解封
targetAccidString待封禁或解封的用户帐号
customString自定义扩展字段,最大长度 1,024 字符

示例

cURL 请求示例

curl -X POST -H "AppKey: go9dnk49**803mgq3" -H "Nonce: 4tggg**323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'serverId=1513535&accid=zhangsan&opeType=1&targetAccid=lisi' 'http://api.netease.im/nimserver/qchat/updateServerMemberBan.action'

返回示例

HTTP 响应:JSON

"Content-Type": "application/json; charset=utf-8"
{
    "code":200
}

状态码

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

状态码 说明 处理建议
200 请求成功 -
403 非法操作或没有权限
  • 检查是否已开通圈组功能
  • 检查操作者是否拥有“封禁他人权限”
404 对象不存在
  • 检查是否存在必传参数为空的问题
  • 检查传入的 IM 账号或服务器 ID 是否存在
414 参数错误 根据提示信息,检查传入参数的格式和限制条件
416 调用频率超限 降低调用频率
431 HTTP 重复请求 -
此文档是否对你有帮助?
有帮助
去反馈
  • 功能介绍
  • URL
  • 请求参数
  • 示例
  • cURL 请求示例
  • 返回示例
  • 状态码