文档中心
实时音视频
服务端 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_logout`。
appid	String	App 的唯一标识。
timestamp	String	服务器当前时间，Unix 时间戳，单位：秒。
nonce	String	随机数。
signature	String	检验串，详情见检验说明。
业务参数	类型	描述
room_id	String	房间 ID。
room_seq	String	房间生命周期唯一标识，在该房间的整个生命周期中保持不变。房间创建后，会生成唯一的 room_seq；如果房间被销毁后，再用相同的 room_id 创建一个新的房间，会生成新的唯一的 room_seq。该参数与房间创建回调、房间关闭回调中的参数 room_session_id 一致。
user_account	String	登录房间的用户账号 ID。
user_nickname	String	登录房间的用户昵称。
session_id	String	登录房间的用户会话 ID。
login_time	String	用户登录房间时的服务器当前时间，Unix 时间戳，单位：毫秒。
logout_time	String	用户退出房间时的服务器当前时间，Unix 时间戳，单位：毫秒。
reason	String	用户退出房间的原因。 0：正常退出。 1：业务层心跳超时。 2：接入层连接断开或心跳超时。 3：调用后台接口被踢出。 4：token 过期退出。
user_role	String	登录房间的用户角色。 1：主播。 2：观众。 4：管理员，该类型用户主要存在于云录制、音视频流审核等场景中，客户端 SDK 的用户相关接口会过滤该类型用户。该返回参数，仅在接入 LiveRoom 服务时有实际意义，接入 Express 服务时请忽略此参数。
user_update_seq	String	房间用户列表变更 seq，用户登录或者退出都会递增 1。

建议您将部分参数转换为 Int 进行逻辑处理，相关字段包括 appid、login_time、logout_time 、reason、room_seq、session_id、timestamp、user_role 和 user_update_seq。

4 数据示例

{
    "event": "room_logout",
    "appid": "1",
    "timestamp": "1499676978",
    "nonce": "350176",
    "signature": "signature",
    "room_id": "rid_1242649",
    "room_seq": "6085791336856668982",
    "user_account": "888120154",
    "user_nickname": "888120154",
    "session_id": "792462300429684736",
    "login_time": "1663740623660",
    "logout_time": "1663740627986",
    "reason": "0",
    "user_role": "1",
    "user_update_seq": "13"
}

5 返回响应

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

6 回调重试策略

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