InterfaceJRTCGuestCallback

访客相关事件回调

interface JRTCGuestCallback {
    onGetAllGroups(result: boolean, groups: undefined | JRTCCallCenterGroupItem[]): void;
    onCallStateChanged(type: GuestCallStateChangeType, incomingType: CallIncomingType, inviter: undefined | JRTCInviter, reason: CallTermReason): void;
    onCallQueueCount(count: number, time: number, agentRinging: boolean): void;
    onCallPropertyChanged(propChangeParam: JRTCRoomPropChangeParam): void;
    onMemberJoin(participant: JRTCRoomParticipant): void;
    onMemberLeave(participant: JRTCRoomParticipant): void;
    onMemberUpdate(participant: JRTCRoomParticipant, changeParam: JRTCRoomParticipantChangeParam): void;
    onHoldStateChanged(hold: boolean): void;
    onCallTypeChanged(callType: CallType): void;
    onMessageReceived(content: string, contentType: string, messageType: MessageType, fromUserId: string): void;
    onSignRequest(fromUserId: string, extraInfo: string): void;
    onOnewayVideoChanged(turnOn: boolean): void;
    onDeliveryAbort(isShutDown: boolean, deliveryUserId: string, reason: string): void;
    onNotifyMessageReceived(notifyMessage: JRTCNotifyMessage, fromUserId: string): void;
    onUrgentResultResponse(agree: boolean): void;
    onCallMediaEvent(code: EventCode, name: string): void;
}

Methods

onGetAllGroups onCallStateChanged onCallQueueCount onCallPropertyChanged onMemberJoin onMemberLeave onMemberUpdate onHoldStateChanged onCallTypeChanged onMessageReceived onSignRequest onOnewayVideoChanged onDeliveryAbort onNotifyMessageReceived onUrgentResultResponse onCallMediaEvent

Methods

onGetAllGroups

  • onGetAllGroups(result, groups): void

  • 获取业务号列表结果回调

    访客调用 queryAllGroups 接口获取业务号列表，会收到此回调。

    Parameters

    • result: boolean

      获取结果，true 表示获取成功，false 表示获取失败

    • groups: undefined | JRTCCallCenterGroupItem[]

      座席业务实体对象列表，获取失败时为 undefined

    Returns void

onCallStateChanged

  • onCallStateChanged(type, incomingType, inviter, reason): void

  • 通话状态改变回调

    Parameters

    Returns void

onCallQueueCount

  • onCallQueueCount(count, time, agentRinging): void

  • 当前排队人数上报回调

    在呼叫发起尚未接通的时间段定时上报，通话接通后将停止上报。

    Parameters

    • count: number

      当前排队人数

    • time: number

      预计等待时长，单位秒

    • agentRinging: boolean

      座席是否振铃

    Returns void

onCallPropertyChanged

  • onCallPropertyChanged(propChangeParam): void

  • 通话属性改变回调

    Parameters

    Returns void

    Note

    重点关注屏幕共享，即当screenShare 属性为 true 时，去处理屏幕共享相关事件。
    可根据 getShareStreamId 和 getShareUserId 方法进行屏幕共享画面的渲染和停止渲染。

onMemberJoin

  • onMemberJoin(participant): void

  • 通话中有新成员加入回调

    当第三方成员加入时，已在通话中的所有成员会收到此回调，而新加入的成员不会收到此回调。

    Parameters

    Returns void

onMemberLeave

  • onMemberLeave(participant): void

  • 通话中有成员离开回调

    通话中有成员离开通话时，剩余的成员会收到此回调，而离开的成员不会收到此回调。

    Parameters

    Returns void

onMemberUpdate

  • onMemberUpdate(participant, changeParam): void

  • 通话中成员属性更新回调

    常用的有 audio、video等。
    例如当通话中有成员关闭视频传输，通话中所有成员都会收到此回调。

    Parameters

    Returns void

onHoldStateChanged

  • onHoldStateChanged(hold): void

  • 收到通话保持或取回的回调

    通话中座席通过保持通话或取回通话，通话中所有成员都会收到此回调。

    Parameters

    • hold: boolean

      true 表示通话被保持，false 表示通话取回

    Returns void

onCallTypeChanged

  • onCallTypeChanged(callType): void

  • 音视频通话切换回调

    通话中的访客和座席切换音视频通话模式，通话中所有成员都会收到此回调。

    Parameters

    Returns void

onMessageReceived

  • onMessageReceived(content, contentType, messageType, fromUserId): void

  • 收到消息回调

    通话中的访客和座席可分别调用 sendMessage 接口给通话中的指定成员或全体成员发送文本消息，接收消息的成员会收到此回调，由此获取消息具体信息。

    Parameters

    • content: string

      消息内容

    • contentType: string

      消息内容类型

    • messageType: MessageType

      消息归属类型

    • fromUserId: string

      发送方的用户ID

    Returns void

onSignRequest

  • onSignRequest(fromUserId, extraInfo): void

  • 收到签名请求回调

    通话中座席调用请求签名接口给访客发送签名请求，访客会收到此回调。

    Parameters

    • fromUserId: string

      发起签名请求的座席用户ID

    • extraInfo: string

      随路额外消息

    Returns void

onOnewayVideoChanged

  • onOnewayVideoChanged(turnOn): void

  • 收到单向视频状态变化回调

    通话中座席请求单向视频，所有成员都会收到此回调。
    收到此回调后，应用需要自行实现单向视频功能，例如用图片遮挡该座席画面，SDK不会对画面进行单向处理。

    Parameters

    • turnOn: boolean

      是否单向视频

    Returns void

onDeliveryAbort

  • onDeliveryAbort(isShutDown, deliveryUserId, reason): void

  • 录制异常回调

    远程录制异常退出时会上报此回调。

    Parameters

    • isShutDown: boolean

      录制异常时服务器是否自动结束通话

      • true: 自动结束通话
      • false: 不自动结束通话
    • deliveryUserId: string

      录制异常的用户ID

    • reason: string

      录制异常的原因

    Returns void

onNotifyMessageReceived

  • onNotifyMessageReceived(notifyMessage, fromUserId): void

  • 收到事件通知消息回调

    通话中的访客和座席可分别调用 sendNotifyMessage 接口给通话中的指定成员或全体成员发送通知消息，接收消息的成员会收到此回调，由此获取消息具体信息。

    Parameters

    • notifyMessage: JRTCNotifyMessage

      事件通知实体类

    • fromUserId: string

      发送方的用户ID

    Returns void

onUrgentResultResponse

  • onUrgentResultResponse(agree): void

  • 座席处理加急的结果回调

    访客调用 requestUrgent 接口请求加急后，座席同意或拒绝加急请求，访客会收到此回调获得加急请求应答结果。

    Parameters

    • agree: boolean

      加急是否通过，true 表示座席同意了访客的加急请求，false 表示不同意

    Returns void

onCallMediaEvent

  • onCallMediaEvent(code, name): void

  • 通话中媒体事件 当前只有H5支持，具体查看 EventCode

    Parameters

    • code: EventCode
    • name: string

      事件说明

    Returns void

设置

主题