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

主动退出服务器

更新时间: 2022/12/17 13:53:35

云信服务端提供 API,支持服务器成员主动退出服务器。

功能介绍

加入服务器后如不想继续待在此服务器中,用户可选择主动退出。退出时,退出者和服务器所有者如果在线,将收到“主动离开服务器” (SERVER_MEMBER_LEAVE(13))的系统通知。此后,退出者将不再接收该服务器下的消息和通知。

如果您的应用需要其他服务器成员也能够接收该系统通知,请通过云信官网提供的联系方式咨询商务经理开通。开通后,其他服务器成员接收该系统通知的条件,参见服务器相关事件通知

URL

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

请求参数

  • POST 请求中 Headers 的设置请参考API调用方式
  • POST 请求中 Body 的设置如下:
参数类型必须说明
accidString需要退出的用户的 IM 账号
serverIdLong服务器 ID

示例

cURL 请求示例

curl -X POST -H "AppKey: go9dnk49**803mgq3" -H "Nonce: 4tgggergi**3t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&serverId=1513535' 'https://api.netease.im/nimserver/qchat/leaveServer.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 请求示例
  • 返回示例
  • 状态码