IM 即时通讯
服务端
API 参考
圈组

封禁账号

更新时间: 2023/08/22 13:39:23

网易云信服务端支持封禁和解禁账号,满足您业务的账号监管需求。

封禁账号

功能描述

出于安全目的,账号创建后只能封禁,不能删除;封禁后账号无法登录,但是仍计入应用账号总数。

  • 封禁时踢出,不止是断开 IM 的长连接,对应账号的聊天室连接也会一起断开。
  • 服务端 API 发起的封禁且踢出操作,不会触发登出事件消息抄送。

API 使用限制

单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。

URL

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

请求参数

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

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

参数名称类型字符串长度上限是否必选示例描述
accidString32必选"123456"待封禁的云信账号
needkickBoolean/选填true是否踢掉被禁用户,默认 false,不踢。如果设置为 true,那么该账号在被封禁的同时被踢出登录
如果封禁时未踢出该账号,且该账号处于登录状态,则当前登录状态不受影响,仍然可以收发消息。即封禁是禁止登录,而不是禁止收发消息。
kickNotifyExtString256选填{"k":"v"}该操作的扩展字段,可透传至客户端SDK(版本至少为v7.7.0)
needUnbindPushTokenBoolean/选填true是否解绑推送 token,默认 false,不解绑。若解绑,那么该账号所有设备不会收到推送(包括 IM 推送和圈组推送)

返回参数

参数名称 类型 示例 描述
code int 200 状态码
desc String {"zhangsan not register"} 封禁失败时返回的信息

示例

请求示例(curl)

curl -X POST -H "AppKey: go9dnk49bkd***9vmel1kglw0803mgq3" -H "Nonce: 4tgggerg***ow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2***62cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan' 'https://api.netease.im/nimserver/user/block.action'

封禁成功返回示例

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

封禁失败返回示例

"Content-Type": "application/json; charset=utf-8"
{
    "code": 414,
    "desc": "zhangsan not register"
}

状态码

该接口在 HTTPS Body 中返回请求的状态码,详情请参见状态码

解禁账号

功能描述

要对用户解除封禁状态,需要调用解禁接口。

API 使用限制

单个应用默认最高调用频率:100 次/秒。如超限,将被屏蔽 10 秒。

URL

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

请求参数

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

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

参数名称 类型 字符串长度上限 是否必选 示例 描述
accid String 32 必选 "123456" 待解禁的云信账号

返回参数

参数名称 类型 示例 描述
code int 200 状态码
desc String {"zhangsan not register"} 解禁失败时返回的信息

示例

请求示例(curl)

curl -X POST -H "AppKey: go9dnk49bkd9jd9vm***kglw0803mgq3" -H "Nonce: 4tggg***igwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9a***e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan' 'https://api.netease.im/nimserver/user/unblock.action'

解禁成功返回示例

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

解禁失败返回示例

"Content-Type": "application/json; charset=utf-8"
{
    "code": 414,
    "desc": "zhangsan not register"
}

状态码

该接口在 HTTPS Body 中返回请求的状态码,详情请参见状态码

此文档是否对你有帮助?
有帮助
去反馈
  • 封禁账号
  • 功能描述
  • API 使用限制
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例(curl)
  • 封禁成功返回示例
  • 封禁失败返回示例
  • 状态码
  • 解禁账号
  • 功能描述
  • API 使用限制
  • URL
  • 请求参数
  • 返回参数
  • 示例
  • 请求示例(curl)
  • 解禁成功返回示例
  • 解禁失败返回示例
  • 状态码