坐席管理

方法 描述
create创建 JCAgent 对象
destroy销毁 JCAgent 对象
queryAllGroups查询业务组号
checkin签入到排队机
checkout签出排队机
answer座席端在收到邀请后,调用answer来接听
term结束通话
checkResult通知访客业务办理的结果
requestVideo按设定质量请求频道中指定用户的视频流
applyStatePause主动发起示忙示闲
enableAudio开启关闭发送本地音频流
enableVideo开启关闭发送本地视频流
sendVideoEmptyPack视频发送空包
sendAudioEmptyPack音频发送空包
transferCall转接
getCallState获取当前通话状态
getGuestParticipant获取当前的访客成员对象
getSelfParticipant获取自己对象
getStatistics获取媒体统计信息
getOperatorState坐席签入状态
isPause当前是否是示忙状态
getParticipants获取当前通话中的所有成员对象
inviteMember邀请其他坐席
enableScreenShare屏幕共享
getShareRenderId屏幕共享时的渲染id,无屏幕共享时为空
getShareUserId屏幕共享时的共享成员id,无屏幕共享时为空
setRatio设置视频本地宽高比
responseUrgent应答加急请求
getSpkLevel获取扬声器音量
getMicLevel获取麦克风音量
queryAvailableAgents查询指定组号的空闲座席
setScreenMode设置分屏模式
getRequestSize视频请求质量
getSerialNumber获取服务唯一标识
getExtraStr获取来电额外参数
getTermState通话结束后默认状态
setRequestSize设置视频请求尺寸
setTermState设置通话结束后默认状态
enableLocalRecord开关本地通话录制
enableRemoteRecord开关远程通话录制
sendMessage透明通道发送全员消息
insertStorageRecord把文件绑定到当前的服务
getCallerWaitTime获取访客呼叫等待时长
setHoldState保持取回
getHoldState当前通话是否保持
turnCallType音视频通话切换
getCallType获取当前通话类型
sendTextMessage发送文本消息
requestSign请求访客签名
ControlRecord控制远程录制

坐席事件

方法 描述
onGetAllGroups查询服务动态组号回调
onCheckin签入结果
onCheckout签出结果
onCallStateChanged通话状态改变
onCallQueueCount排队人数上报
OnApply示忙示闲的结果
onTransferResult转接的结果
onNewMemberJoin通话中有新成员加入
onMemberLeave通话中有成员离开
onMemberUpdate成员属性有更新
onCallPropertyChange通话属性改变
onUrgentRequestRecv收到加急请求
onUrgentResponseResult处理加急结果
OnQueryAvailableAgentsListResult查询空闲座席结果
onMessageReceive接收频道消息的回调
onCallerWaitTimeNotify客户呼叫等待时长
onHeldNotify收到保持取回的通知
onCallTypeTurnedNotify音视频通话切换通知
onTextMessageRecvNotify收到文本消息
onSignRequestRecvNotify收到签名请求

访客管理

方法 描述
create创建 JCGuest 对象
destroy销毁 JCGuest 对象
queryAllGroups查询业务组号
call发起呼叫
oneToOneCall点对点呼叫
term结束通话
requestVideo按设定质量请求频道中指定用户的视频流
enableAudio开启关闭发送本地音频流
enableVideo开启关闭发送本地视频流
sendVideoEmptyPack视频发送空包
sendAudioEmptyPack音频发送空包
getAgentParticipant通话中可以取得正在通话的座席对象
getCallState获取当前通话状态
getSelfParticipant获取自己对象
getStatistics获取媒体统计信息
getParticipants获取当前通话中的所有成员对象
enableScreenShare屏幕共享
getShareRenderId屏幕共享时的渲染id,无屏幕共享时为空
getShareUserId屏幕共享时的共享成员id,无屏幕共享时为空
setRatio设置视频本地宽高比
requestUrgent请求加急
getSpkLevel获取扬声器音量
getMicLevel获取麦克风音量
setScreenMode设置分屏模式
getRequestSize视频请求质量
getSerialNumber获取服务唯一标识
setRequestSize设置视频请求尺寸
setLineUpTag设置排队标签
enableLocalRecord开关本地通话录制
enableRemoteRecord开关远程通话录制
sendMessage透明通道发送全员消息
insertStorageRecord把文件绑定到当前的服务
getHoldState当前通话是否保持
turnCallType音视频通话切换
getCallType获取当前通话类型
sendTextMessage发送文本消息

访客事件

方法 描述
onGetAllGroups查询服务动态组号回调
onCallStateChanged通话状态改变
onCallQueueCount排队人数上报
onNewMemberJoin通话中有新成员加入
onMemberLeave通话中有成员离开
onMemberUpdate成员属性有更新
onCallPropertyChange通话属性改变
onUrgentResult坐席处理加急的结果
onCheckVerifyResult业务是否办理成功
onMessageReceive接收频道消息的回调
onInviteDeclined邀请被拒绝
onOfflineResult离线排队结果
onPassOffline离线排队过号
onHeldNotify收到保持取回的通知
onCallTypeTurnedNotify音视频通话切换通知
onTextMessageRecvNotify收到文本消息
onSignRequestRecvNotify收到签名请求

登录管理

方法 描述
create创建 JCClient 对象
destroy销毁 JCClient 对象
login登录 Juphoon Cloud 平台
logout登出 Juphoon Cloud 平台
getDisplayName获取昵称
setDisplayName设置昵称
getUserId获得用户标识
getState获取当前状态
setForeground是否设置为前台
setAppkey设置appkey
setConfig设置配置相关参数
getConfig获取配置相关参数
sendOnlineMessage发送在线消息

登录事件

事件 描述
onLogin登录结果回调
onLogout登出回调
onClientStateChange登录状态变化通知
onOnlineMessageSendResult在线消息发送结果通知
onOnlineMessageReceived收到在线消息通知

设备管理

方法 描述
create创建 JCMediaDevice 对象
destroy销毁 JCMediaDevice 对象
startCameraVideo开始自身视频渲染
startVideo开始其他端的视频渲染
stopVideo停止视频渲染
isAudioInputStart内置音频输入是否打开
isAudioOutputStart音频外放是否打开
startAudioInput打开设备内置音频采集
stopAudioInput关闭设备内置音频采集
startAudioOutput打开设备音频输出
stopAudioOutput关闭设备音频输出
startAudio启动音频
stopAudio停止音频
getAudioRouteType音频路由类型
enableSpeaker开启关闭扬声器
startCamer开启摄像头
stopCamera关闭摄像头
switchCamera切换摄像头
specifyCamera指定要开启的摄像头
specifyCameraAngle指定摄像头采集角度
getCameraType获得摄像头类型
setCameraProperty设置摄像头采集属性
setScreenCaptureProperty设置屏幕共享采集属性
startVideoFile开启视频文件作为视频输入源
setVideoFileFrame逐帧采集视频画面
stopVideoFile关闭逐帧采集画面
isCameraOpen摄像头是否已打开
isSpeakerOn扬声器是否已打开
getCamera获取当前的摄像头
getCameras获取摄像头列表
enableScreenOrWindowsAreaCapture开启/关闭区域采集
enableScreenCapture开启/关闭屏幕采集
snapshotWithRenderId截图
startSelfHelpRecord开始自助双录
attachSelfHelpRecordCaptureSoure合并其他窗口视频流到录制文件中
detachSelfHelpRecordCaptureSoure移除其他窗口视频流
stopSelfHelpRecord停止自助双录
startFileRecordVideo打开本地录制
stopFileRecord关闭本地录制
isVideoFileOpen文件视频源是否已开启
getVideoFileId获取文件视频源渲染id
getVersion获取MTC ZMF版本信息

设备事件

事件 描述
onCameraUpdate摄像头变化
onAudioOutputTypeChange音频输出变化
onRenderCallback渲染数据上报
onSnapshotComplete截图完成
onVideoError视频渲染错误,包括摄像头采集错误
onInputCallback实时音频数据
onRenderReceived收到第一帧数据
onRenderStart渲染开始
onVideoCaptureDidStart视频采集开始

多方通话管理

方法 描述
create创建 JCMediaChannel 对象
destroy销毁 JCMediaChannel 对象
getChannelUri获得频道 Uri
getChannelId获得频道标识
getConfId获得confid
getPassword获得频道密码
getChannelNumber获得频道号
getTitle返回频道标题
getState返回当前在频道中的状态
getParticipants获得所有频道中的成员
getUploadLocalAudio获取本地音频数据是否在上传
getUploadLocalVideo获取本地视频数据是否在上传
getAudioOutput获取音频是否输出
getScreenRenderId获取屏幕共享渲染标识
getScreenUserId获取开启屏幕共享的用户标识
isLocalRecording获取是否本地录制
getRecordState获取视频录制状态
getCdnState获得cdn推流状态
setConfig设置相关配置参数
getConfig获取相关配置参数
query查询频道相关信息
join加入频道
leave离开频道
stop关闭频道
enableUploadAudioStream开启关闭发送本地音频流
enableUploadVideoStream开启关闭发送本地视频流
enableAudioOutput开启关闭音频输出
requestVideo请求频道中其他用户的视频流
requestScreenVideo请求频道成员屏幕共享的视频流
enableLocalRecord开关本地会议录制
enableCdn开关Cdn推流
enableRemoteRecord开关远程视频录制
enableScreenShare开关屏幕分享
getParticipant获取频道成员
getStatistics获取统计信息
setCustomProperty设置频道自定义属性
getCustomProperty获取频道自定义属性
sendMessage发送消息
sendCommand发送指令
inviteSipUser邀请Sip用户
getSpkLevel获取扬声器音量
getMicLevel获取麦克风音量
setScreenMode设置分屏模式
setRatio设置宽高比
generateRoomId生成会议号
sendVideoEmptyPack视频发送空包
sendAudioEmptyPack音频发送空包

多方通话事件

事件 描述
onMediaChannelStateChange自身状态变化回调
onMediaChannelPropertyChange属性变化回调
onJoin加入频道结果回调
onLeave离开频道结果回调
onStop解散频道结果回调
onQuery查询频道信息结果回调
onParticipantJoin新成员加入回调
onParticipantLeft成员离开回调
onParticipantUpdate成员更新回调
onMessageReceive接收频道消息的回调
onInviteSipUserResult邀请Sip用户操作结果回调
onGenerateRoomIdResult成员声音变化

文件存储管理

方法 描述
create创建 JCStorage 对象
destroy销毁 JCStorage 对象
uploadFile上传文件
downloadFile下载文件
cancelFile取消正在进行的文件上传下载

文件存储事件

事件 描述
onFileUpdate文件传输结果回调
onFileResult文件状态更新回调