服务端
API 参考
圈组

开启/关闭进出聊天室事件通知

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

在创建聊天室时,可设置开启/关闭人员进出聊天室事件通知。在聊天室创建成功后,若还需要修改进出聊天室事件的通知状态,可以调用此接口。

目前人员进出聊天室事件通知主要包括以下事件:

  • 主动退出聊天室
  • 聊天室掉线
  • 进入聊天室

URL

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

请求参数

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

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

参数类型必填说明
roomid Long 聊天室 ID
close Boolean开启或关闭进出聊天室事件通知
true:关闭进出聊天室通知,false:开启进出聊天室通知

示例

请求示例(curl)

curlcurl -X POST  -H 'appkey: fe416640***7ad2547'  -H 'cache-control: no-cache'  -H 'checksum: 18f5435a7bf**7f75265495034'  -H 'content-type: application/x-www-form-urlencoded'   -H 'curtime: 1508481877'   -H 'nonce: 12345' -d 'close=false&roomid=3001' "https://api.netease.im/nimserver/chatroom/updateInOutNotification.action"

请求成功返回示例

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

请求失败返回示例

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

状态码

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

后续步骤

通过服务端开启进出聊天室事件通知后,您可以在客户端监听进出聊天室事件通知回调。 各端参考文档如下:

此文档是否对你有帮助?
有帮助
去反馈
  • URL
  • 请求参数
  • 示例
  • 请求示例(curl)
  • 请求成功返回示例
  • 请求失败返回示例
  • 状态码
  • 后续步骤