功能描述

创建聊天室后，聊天室默认处于开放状态，所有用户可自由进入聊天室。如需暂停所有用户可自由进入聊天室的权限，创建者可通过调用本服务端 API 关闭聊天室。

若关闭聊天室后需要再次开启，创建者也可以调用此接口重新开放聊天室，该接口还可以设置聊天室定时关闭策略。

如果关闭聊天室，那么聊天室中所有在线成员将被强制踢下线。

调用频率

单个应用默认最高调用频率请参考 频控说明。

请求

URL

PATCH https://open.yunxinapi.com/im/v2/chatrooms/:{room_id}/actions/update_status

Header

请求 Header 的参数说明请参见请求 Header。

路径参数

参数名称	类型	是否必选	描述
room_id	Long	必选	需要开放/关闭的聊天室 ID，聊天室创建成功后，云信会返回聊天室 ID。

请求体参数

参数名称	类型	是否必选	描述
operator_account_id	String	必选	操作者（聊天室创建者）的云信账号 ID。
valid	Boolean	必选	是否开放聊天室，true（默认）：开放；false：关闭。
delay_close_policy	Integer	可选	聊天室定时关闭方式。 0（默认）：不开启定时关闭；1：固定时间关闭（不管聊天室中是否还有用户）；2：空闲关闭（等聊天室中没有用户后固定时间关闭）。聊天室定时关闭功能（聊天室自动销毁机制），需要在控制台先开通后才能使用，具体请参考开通和配置聊天室功能。仅该功能开通后创建的聊天室支持定时关闭，开通前创建的聊天室不支持定时关闭。
delay_seconds	Long	可选	聊天室定时关闭的时间，单位秒。只有当 delay_close_policy = 1 或 2 时，该参数才生效，且最大值和默认值都为 7*24*3600 秒。

请求体示例

json{
    "valid": true,
    "delay_seconds": 604800,
    "operator_account_id": "yx1",
    "delay_close_policy": 2
}

响应

Header

响应 Header 的参数说明请参见响应 Header。

响应体参数

参数名称	类型	描述	是否必返回
code	Integer	状态码，200 表示请求成功。	是
msg	String	提示信息。请求失败时返回错误信息，请求成功时返回 "success"。	是
- data	Object	返回的 JSON 数据对象，请求失败则返回空对象。	是
valid	Boolean	聊天室状态。true：开放；false：关闭。	是
creator	String	聊天室创建者。	是
room_name	String	聊天室名称。	是
announcement	String	聊天室公告。	否
live_url	String	直播地址。	否
extension	String	自定义扩展字段。	否
chat_banned	Boolean	聊天室是否处于全体禁言状态，全体禁言时仅管理员和创建者可以发言，false：未禁言，true：禁言。	是
room_id	Long	聊天室 ID。	是
queue_level	Integer	聊天室队列管理权限。0：所有人都有权限变更队列；1：只有管理员才能变更队列。	是

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "valid": true,
        "extension": "聊天室自定义消息002",
        "creator": "yx1",
        "chat_banned": false,
        "announcement": "这是一条聊天的共享信息",
        "room_name": "测试聊天室",
        "broadcast_url": "http://ww.baidu.com",
        "room_id": 1602817043,
        "queue_level": 0
    }
}

错误码

错误码	错误码描述	错误信息示例
200	请求成功	success
414	参数错误	parameter error
416	频率超限	rate limit exceeded
113303	聊天室正在关闭，不允许重新开启	chat room closing, reopen not allowed
113410	聊天室服务未开通	chatroom service disabled
113409	聊天室重复操作	operation on chatroom repeated
113404	聊天室不存在	chatroom not exist
113406	聊天室已关闭	chatroom closed
113434	聊天室数量超过限制	chatroom count limit exceeded
500	服务端内部错误	internal server error
503	服务器繁忙	server busy