Home/WebSocket 事件

Open API / WebSocket

WebSocket 事件

会议房间 WebSocket 承载成员状态、聊天、控制事件和关服通知; presence WebSocket 承载在线状态和好友事件。

room.snapshotparticipant.joinchat.messagepresence.readyfriend.requestserver.shutdown

Features

会议房间

连接 /ws/meetings/:id 后,服务端校验 token、会议和成员关系,再推送房间快照和聊天历史。

在线状态

连接 /ws/presence 后,客户端可收到好友上下线、好友申请和私信通知。

Example

const ws = new WebSocket("wss://meet.yi-ruan.com/ws/meetings/<id>?token=<jwt>");
ws.onmessage = (event) => {
  const payload = JSON.parse(event.data);
  console.log(payload.type, payload);
};

Related APIs

  • GET /ws/meetings/:id?token=
  • GET /ws/presence?token=

Ready to try Yihuichang?

Download the client to get started, or contact the team about self-hosting, OEM and partnerships.

DownloadContact us