# 消息通道

透明通道消息主要包含通话内消息和在线消息，具体使用要求和场景举例参考下表：

	在线消息	通话内消息
一对一发送	支持	支持
群发消息	不支持	支持
是否支持异步发送结果上报	支持	不支持
是否需要登录	是	是
是否需要建立通话	否	是
使用场景举例	1、实现不依赖通话的一对一聊天；2、实现一些通话前的自定义信令交互，比如呼叫、拒接/接听等等；	1、实现通话中的一些自定义信令、通知等；2、实现通话中单聊和群聊；
消息内容支持	只支持文本消息	只支持文本消息
消息内容大小最大支持（bit）	4K	4K

# 1. 通话内消息

调用 JRTCGuest (opens new window) 下的 sendMessage (opens new window) 方法发送消息

/**
 * 发送消息，消息内容不能大于4K
 *
 * 指定成员会收到 {@link JRTCGuestCallback.onMessageReceived onMessageReceived} 回调
 * @param contentType 消息内容类型
 * @param content 消息内容
 * @param toUserId 指定成员的用户ID，传 null 给通话中全部成员发送消息
 * @returns 接口调用结果
 * - true: 接口调用成功
 * - false: 接口调用异常
 */
public sendMessage(contentType: string, content: string, toUserId: string):boolean {}

接收消息通过实现 JRTCGuestCallback (opens new window) 中的 onMessageReceived (opens new window) 接口上报。

/**
 * 收到消息回调
 *
 * 通话中的访客和座席可分别调用 {@link JRTCGuest.sendMessage sendMessage} 接口给通话中的指定成员或全体成员发送文本消息，接收消息的成员会收到此回调，由此获取消息具体信息。
 * @param content 消息内容
 * @param contentType 消息内容类型
 * @param messageType 消息归属类型
 * - {@link MessageType.TYPE_1TO1 TYPE_1TO1} : 一对一消息
 * - {@link MessageType.TYPE_GROUP TYPE_GROUP} : 群发消息(发送给通话中所有成员)
 * @param fromUserId 发送方的用户ID
 */
onMessageReceived(content: string, contentType: string, messageType: MessageType, fromUserId: string): void;

示例代码：

// 给成员 agent1 发送消息
guest.sendMessage("messageType", "content", "agent1");
// 给通话中所有成员发送消息
guest.sendMessage("messageType", "content", null);
// 收到消息
onMessageReceived(content, contentType, messageType, fromUserId) {
    // 收到消息，消息内容为 content，消息来自 fromUserId  
}

# 2. 在线消息

只要登录到 Juphoon RTC 平台就可以通过 JRTCClient (opens new window) 的 sendOnlineMessage (opens new window) 实现在线消息的收发，消息内容不能大于4K。

/**
 * 发送在线消息
 * 
 * @note 消息大小不超过4k
 * @param message 消息内容
 * @param userId 对端的用户名
 * @returns 接口调用结果
 * - 操作id: 接口调用成功，对应 {@link JRTCClientCallback.onOnlineMessageSendResult onOnlineMessageSendResult} 回调的 operatorId 参数
 * - -1: 接口调用异常，不会收到回调
 */
public sendOnlineMessage(message: string, userId: string): number

在线消息发送结果通过 onOnlineMessageSendResult (opens new window) 回调通知。

/**
 * 在线消息发送结果回调
 *
 * @param result 发送结果是否成功
 *               - true：发送成功
 *               - false：发送失败
 * @param operatorId 操作id，对应 {@link JRTCClient.sendOnlineMessage sendOnlineMessage} 的返回值
 */
onOnlineMessageSendResult(result: boolean, operatorId: number): void;

在线消息接收者会收到 onOnlineMessageReceived (opens new window) 回调通知。

/**
 * 收到在线消息回调
 *
 * @param message 消息内容
 * @param userId  对方用户ID
 */
onOnlineMessageReceived(message: string, userId: string): void;

示例代码：

// 给成员 agent1 发送在线消息
client.sendOnlineMessage("content", "agent1");
// 在线消息发送结果回调
onOnlineMessageSendResult(result, operatorId) {}
// 收到消息
onMessageReceived(content, fromUserId) {
  // 收到消息，消息内容为 content，消息来自 fromUserId  
}

# 3. 事件消息

该接口主要用于访客和座席之间的一些事件消息传递，用于增加用户体验

/**
 * 发送事件通知消息
 *
 * 通话中的其他成员会收到 {@link JRTCGuestCallback.onNotifyMessageReceived onNotifyMessageReceived} 回调
 * @param notifyMessage 事件通知实体对象
 * @param toUserId  指定成员的用户ID，不传即给通话中全部成员发送通知消息
 * @returnss 接口调用结果
 * - true: 接口调用成功
 * - false: 接口调用异常
 */
public sendNotifyMessage(notifyMessage: JRTCNotifyMessage, toUserId?: string): boolean;

事件消息回调

/**
 * 收到事件通知消息回调
 *
 * 通话中的访客和座席可分别调用 {@link JRTCGuest.sendNotifyMessage sendNotifyMessage} 接口给通话中的指定成员或全体成员发送通知消息，接收消息的成员会收到此回调，由此获取消息具体信息。
 * @param notifyMessage   事件通知实体类
 * @param fromUserId      发送方的用户ID
 */
onNotifyMessageReceived(notifyMessage: JRTCNotifyMessage, fromUserId: string): void;

集成中常见的影响用户体验的事件消息如下，也是我们 Windows 座席插件已经集成的事件消息：

当访客进入后台，视频画面静止，需要通知座席，如果对端座席是我们提供的 Windows 插件，该事件会在插件提示；

示例代码：

//监听页面前后台
document.addEventListener("visibilitychange", this.onVisibilityChange);
onVisibilityChange(ev: any): void {
  if (document.hidden) {
    //当应用进入后台
    let notifyMessage = new JRTCNotifyMessage();
    notifyMessage.eventCode = C21_DEVICE_ENTER_BACKGROUND;
    notifyMessage.desc = "应用进入后台";
    guest.sendNotifyMessage(notifyMessage, "座席用户ID");
  } else {
    //当应用进入前台
    let notifyMessage = new JRTCNotifyMessage();
    notifyMessage.eventCode = C21_DEVICE_BACK_FOREGROUND;
    notifyMessage.desc = "应用进入前台";
    guest.sendNotifyMessage(notifyMessage, "座席用户ID");
  }
}
// JRTCAgentCallback
@Override
void onNotifyMessageReceived(JRTCNotifyMessage notifyMessage, String fromUserId) {
    //先过滤是访客端发送过来的消息
    if (TextUtils.equals(fromUserId, guestParticipant.getUserId())) {
        //判断事件码
        if (notifyMessage.getEventCode() == JRTCEventCode.C21_DEVICE_ENTER_BACKGROUND) {
            //访客端进入后台
        } else if (notifyMessage.getEventCode() == JRTCEventCode.C21_DEVICE_BACK_FOREGROUND) {
            //访客端回到前台
        }
    }
}

当访客收到系统来电，座席端听不到访客声音，需要通知座席，如果对端座席是我们提供的 Windows 插件，该事件会在插件提示；

示例代码：

//需要应用层自行实现监听系统来电

//系统收到来电
let notifyMessage = new JRTCNotifyMessage();
notifyMessage.eventCode = C22_SYSTEM_PHONE_IDLE;
notifyMessage.desc = "系统通话状态空闲";
guest.sendNotifyMessage(notifyMessage, "座席用户ID");

//系统收到来电
let notifyMessage = new JRTCNotifyMessage();
notifyMessage.eventCode = C22_SYSTEM_PHONE_RING;
notifyMessage.desc = "收到系统来电";
guest.sendNotifyMessage(notifyMessage, "座席用户ID");

//系统收到来电
let notifyMessage = new JRTCNotifyMessage();
notifyMessage.eventCode = C22_SYSTEM_PHONE_TALKING;
notifyMessage.desc = "系统通话中";
guest.sendNotifyMessage(notifyMessage, "座席用户ID");
// JRTCAgentCallback
@Override
void onNotifyMessageReceived(JRTCNotifyMessage notifyMessage, String fromUserId) {
    //先过滤是访客端发送过来的消息
    if (TextUtils.equals(fromUserId, guestParticipant.getUserId())) {
        //判断事件码
        if (notifyMessage.getEventCode() == JRTCEventCode.C22_SYSTEM_PHONE_RING) {
            //访客端收到系统来电
        } else if (notifyMessage.getEventCode() == JRTCEventCode.C22_SYSTEM_PHONE_TALKING) {
            //访客端系统通话中
        } else if (notifyMessage.getEventCode() == JRTCEventCode.C22_SYSTEM_PHONE_IDLE) {
            //访客端系统通话结束
        } 
    }
}

其他事件用户可以自行定义，只要座席端和访客端自行协议好就行，自定义事件码范围159xxx（即159000～159999）****。

← 实现视频通话智能排队 →