服务端事件回调

---

1 描述

ZegoRoomKit 后台针对某些事件开放了事件通知，开发者后台可以基于这些事件来进行房间的管理。

开发者需提供“回调地址”和“加密参数”。ZegoRoomKit 后台在指定事件发生后，通过接口调用的方式通知开发者后台，开发者后台返回 200 则认为调用成功，否则会进行重试。默认重试两次，分别在 1 s、5 s 后发起。

开发者提供的回调接口，必须在 5 s 内正确响应，否则判定为超时。

本接口的使用方法请参考 使用服务端事件回调。

2 事件定义

2.1 房间事件

下图展示了在一种典型业务流程中各个事件回调触发的时机：

2.1.1 结束房间事件

通知消息体：

数据示例：

{
    "event_type": 1,
    "room_id": "19827033659",
    "timestamp": 1614149165898
}

2.1.2 进入房间事件

通知消息体：

数据示例：

{
    "event_type": 2,
    "nickname": "微信",
    "role": 2,
    "room_id": "19826903716",
    "timestamp": 1614149159658,
    "uid": 32614149156788
}

2.1.3 离开房间事件

通知消息体：

数据示例：

{
    "event_type": 3,
    "nickname": "谷歌",
    "role": 2,
    "room_id": "19826903716",
    "timestamp": 1614149175582,
    "uid": 32614149031156
}

2.1.4 开始上课事件

通知消息体：

数据示例：

{
    "event_type": 4,
    "room_id": "19827033659",
    "timestamp": 1614149165898
}

2.1.5 移出房间事件

通知消息体：

数据示例：

{
    "event_type": 5,
    "nickname": "谷歌",
    "role": 2,
    "room_id": "19826903716",
    "timestamp": 1614149175582,
    "uid": 32614149031156,
    "kick_out_type": 1
}

2.1.6 挂起房间事件

通知消息体：

数据示例：

{
    "event_type": 6,
    "room_id": "19826903716",
    "timestamp": 1614149175582
}

2.1.7 变更房间模式事件

通知消息体：

数据示例：

{
    "event_type": 7,
    "room_id": "19826903716",
    "timestamp": 1614149175582,
    "room_mode": 2
}

2.2 白板事件

2.2.1 正在共享的白板 ID 切换事件

通知消息体：

数据示例：

{
    "event_type": 101,
    "room_id": "20082191900",
    "timestamp": 1617786314436,
    "whiteboard_id": "1438507235"
}