实时消息与信令

功能简介

ZEGO 提供多种文本消息的收发功能，实现发送房间内广播消息、弹幕消息、简单 IM 文字聊天、点赞、送礼物、答题等功能。

另外，ZEGO 还提供完整的即时通讯 ZIM SDK，为开发者提供全平台互动、海量并发、超低延时、消息必达的通信服务，具体请参考 即时通讯。

示例源码下载

请参考 下载示例源码 获取源码。

相关源码请查看 “/page/example/common-feature/room-im.nvue” 目录下的文件。

前提条件

在实现房间实时消息之前，请确保：

• 已在 ZEGO 控制台 创建项目，并申请有效的 AppID 和 AppSign，详情请参考 控制台 - 项目信息。
• 已在项目中集成 ZEGO Express SDK，并实现了基本的音视频推拉流功能，详情请参考 快速开始 - 集成 和 快速开始 - 实现流程。

使用步骤

收发广播消息

1. 发送广播消息

   调用 sendBroadcastMessage 接口向同一房间内的其他用户发送广播消息，长度不能超过 1024 字节。

   通过 ZegoIMSendBroadcastMessageResult 异步结果的返回获取消息发送结果。

   // 发送广播消息
   ZegoExpressEngine.instance().sendBroadcastMessage("ChatRoom-1", "This is a broadcast message").then((result) => {
       // 获取消息发送结果
   })

2. 接收广播消息

   通过调用 ZegoExpressEngine 的 on 方法，设置监听 IMRecvBroadcastMessage 的事件回调，当发送方成功发送广播消息后，同一房间内的其他用户通过此回调接收相关信息，包括消息内容、消息 ID、发送时间及发送方信息。

   // 收到其他用户发送消息
   ZegoExpressEngine.instance().on('IMRecvBroadcastMessage', (roomID, messageList) => {
       console.log("received broadcast message") 
   })

收发弹幕消息

1. 发送弹幕消息

   调用 sendBarrageMessage 接口向同一房间内的其他用户发送弹幕消息，长度不能超过 1024 字节。

   通过 ZegoIMSendBarrageMessageResult 异步结果的返回获取消息发送结果。

   // 发送房间弹幕消息
   ZegoExpressEngine.instance(). sendBarrageMessage("ChatRoom-1", "This is a barrage message").then((result) => {
       // 获取消息发送结果
   })

2. 接收弹幕消息

   通过调用 ZegoExpressEngine 的 on 方法，设置监听 IMRecvBarrageMessage 的事件回调，当发送方成功发送弹幕消息后，同一房间内的其他用户通过此回调接收相关信息，包括消息内容、消息 ID、发送时间及发送方信息。

   // 收到其他用户发送消息
   ZegoExpressEngine.instance().on('IMRecvBarrageMessage', (roomID, messageList) => {
       console.log("received barrage message") 
   })

收发自定义信令

1. 发送自定义信令

   调用 sendCustomCommand 接口向同一房间内通过 “toUserList” 指定的用户发送自定义信令，长度不能超过 1024 字节。

   通过 ZegoIMSendCustomCommandResult 异步结果的返回获取消息发送结果。

   // 发送自定义信令，`toUserList` 中指定的用户才可以通过 IMRecvCustomCommand 事件收到此信令
   // 若 `toUserList` 参数不传， 则 SDK 将发送该信令给房间内所有用户
   ZegoExpressEngine.instance().sendCustomCommand("ChatRoom-1", "This is a custom command", toUserList)

2. 接收自定义信令

   通过调用 ZegoExpressEngine 的 on 方法，设置监听 IMRecvCustomCommand 的事件回调，当发送方成功发送自定义信令后，同一房间内的指定用户通过此回调接收相关信息，包括消息内容和消息发送方信息。

   // 收到其他用户发送消息
   ZegoExpressEngine.instance().on('IMRecvCustomCommand', (roomID, fromUser, command) => {
       console.log("received custom command") 
   })