文档中心
实时音视频
服务端 API
回调说明
房间关闭回调

房间关闭回调

更新时间：2024-07-04 11:19

1 描述

当开发者需要了解某个房间关闭的相关信息时，可以通过本回调获取。

2 回调说明

请求方法：POST。
- 回调数据需要 UrlDecode 解码。
- 使用 POST 请求方法传递参数时：
  - Body 中的参数直接传 JsonObject 格式即可，无需序列化为 String 格式。
  - Headers 中，设置 “Content-type” 为 “application/json”。

请求地址：请在 ZEGO 控制台上配置回调地址。
传输协议：HTTPS/HTTP，建议使用 HTTPS。

3 回调参数

公共参数	类型	描述
event	String	回调事件，此回调返回值为 `room_close`。
appid	UInt32	APP 的唯一标识。
timestamp	Int64	服务器当前时间，Unix 时间戳，单位：秒。
nonce	String	随机数。
signature	String	检验串，详情见检验说明。
业务参数	类型	描述
room_id	String	房间 ID。
room_session_id	UInt64	房间生命周期唯一标识，在该房间的整个生命周期中保持不变。房间创建后，会生成唯一的 room_session_id；如果房间被销毁后，再用相同的 room_id 创建一个新的房间，会生成新的唯一的 room_session_id。该参数与登录房间回调、退出房间回调中的参数 room_seq 一致。
close_reason	UInt32	房间关闭原因。 0：正常关闭。 1：房间内的最后一个用户心跳超时，房间无人，所以关闭。 2：房间内的最后一个用户掉线，房间无人，所以关闭。 3：房间内的最后一个用户被 Kickout，房间无人，所以关闭。
room_close_time	String	房间关闭时间，为服务器当前时间，Unix 时间戳，单位：毫秒。

建议您将部分参数转换为 Int 进行逻辑处理，相关字段包括 room_close_time。

4 数据示例

{
    "event": "room_close",
    "appid": 1,
    "timestamp": 1499676989,
    "nonce": "350176",
    "signature": "signature",
    "room_id": "rid_1242649",
    "room_session_id": 858012925204410400,
    "close_reason": 1,
    "room_close_time": "1499676989909"
}

5 返回响应

返回 HTTP status code 为 2XX （例如 200）表示成功，其他响应都表示失败。

6 回调重试策略

如果 ZEGO 服务器没有收到响应，或收到的 HTTP status code 不为 2XX（例如 200），都会尝试重试，最多进行 5 次重试。每次重试请求与上一次请求的间隔时间分别为 2s、4s、8s、16s、32s。若第 5 次重试后仍然失败，将不再重试，该回调丢失。