登录管理

方法 描述
create创建 JCClient 对象
destroy销毁 JCClient 对象
login登录 Juphoon Cloud 平台
login登录 Juphoon Cloud 平台
logout登出 Juphoon Cloud 平台
setAppkey 获取Appkey
displayName设置/获取昵称
userId获得用户标识
setConfig设置配置相关参数
state获取当前状态
getConfig获取配置相关参数
sendOnlineMessage发送在线消息

登录事件

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

视频客服座席管理

方法 描述
create创建 JCClient 对象
destroy销毁 JCClient 对象
queryAllGroups查询业务组号
operatorState坐席签入状态
checkin签入
checkin签入
checkin签入
checkout签出
callState通话状态
answer接听
termState结束通话状态
term结束通话
applyStatePause发起示忙示闲
enableVideo 开启关闭发送视频流
enableAudio 开启关闭发送音频流
sendVideoEmptyPack 视频发送空包
sendAudioEmptyPack 音频发送空包
setRatio 设置视频本地宽高比
setScreenMode 设置分屏模式
queryAvailableAgents 查询空闲座席
transferCall转接
inviteMember邀请其他座席
checkResult通知访客服务的结果
responseUrgentWithSeialNumber应答加急请求
requestSize视频请求质量
enableScreenShare开关屏幕分享
enableLocalRecord开关本地通话录制
enableLocalRecord开关本地通话录制
enableRemoteRecord开关远程视频通话录制
sendMessage透明通道发送全员消息
sendMessage透明通道发送消息给某个成员
insertStorageRecord把文件绑定到当前的服务
setHoldState保持取回
setConfig设置配置相关参数
getHoldState通话是否保持
turnCallType音视频通话切换
getCallType当前通话类型
sendTextMessage发送文本消息
guestParticipant访客成员对象
participants当前通话中的所有成员对象
requestSign请求访客签名
controlRecord控制远程录制

视频客服座席事件

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

访客管理

方法 描述
create创建 JCClient 对象
destroy销毁 JCClient 对象
queryAllGroups查询业务组号
callState通话状态
operatorState坐席签入状态
call发起呼叫
oneToOneCall呼叫到指定坐席
term结束通话
enableVideo 开启关闭发送视频流
enableAudio 开启关闭发送音频流
sendVideoEmptyPack 视频发送空包
sendAudioEmptyPack 音频发送空包
setRatio 设置视频本地宽高比
setScreenMode 设置分屏模式
queryAvailableAgents 查询空闲座席
requestVideo按设置的尺寸请求指定成员的视频画面
requestUrgent请求加急
setRequestSize设置视频请求质量
enableScreenShare开关屏幕分享
enableLocalRecord开关本地通话录制
enableLocalRecord开关本地通话录制
enableRemoteRecord开关远程视频通话录制
sendMessage透明通道发送全员消息
sendMessage透明通道发送消息给某个成员
insertStorageRecord把文件绑定到当前的服务
setLineUpTag设置排队标签
getHoldState通话是否保持
turnCallType音视频通话切换
getCallType当前通话类型
sendTextMessage发送文本消息
participants当前通话中的所有成员对象

访客事件

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

设备管理

方法 描述
create创建 JCMediaDevice 对象
destroy销毁 JCMediaDevice 对象
startCameraVideo开始自身视频渲染
startCameraVideo开始自身视频渲染
startVideo开始其他端的视频渲染
startVideo开始其他端的视频渲染
stopVideo停止视频渲染
isAudioOutputStart音频输出是否打开
isAudioInputStart内置音频输入是否打开
startAudioInput打开设备内置音频输出
startAudioOutput打开设备内置音频输出
stopAudioInput关闭设备内置音频采集
stopAudioOutput关闭设备内置音频输出
getAudioOutputType当前音频模式
startAudio启动音频
stopAudio停止音频
startCamer开启摄像头
stopCamera关闭摄像头
switchCamera切换摄像头
specifyCamera指定要开启的摄像头
specifyCameraAngle指定摄像头采集角度
setCameraProperty设置摄像头采集属性
setScreenCaptureProperty设置屏幕共享采集属性
enableScreenCapture开启/关闭屏幕共享
startVideoFile开启视频文件作为视频输入源
setVideoFileFrame逐帧采集视频画面
setVideoFileFrame向文件视频源逐帧添加视频数据
stopVideoFile关闭逐帧采集画面
cameraOpen摄像头是否已打开
camera获取当前的摄像头
cameraDevices获取摄像头列表
videoFileOpen文件视频源是否已开启
videoFileId获取文件视频源渲染id
autoRotate视频窗体是否旋转
rotateAngleToScreen设置/获取视频窗体角度
speakerOn扬声器是否已打开
enableSpeaker开启关闭扬声器
snapshotWithRenderId截图
startSelfHelpRecord开始自助双录
attachSelfHelpRecordCaptureSoure合并其他窗口视频流到录制文件中
detachSelfHelpRecordCaptureSoure从录制文件移除其他窗口视频流
stopSelfHelpRecord停止自助双录
startFileRecordVideo开始离线单人录制
stopFileRecord停止单人录制
ringPlay播放铃声
ringStop停止铃声
getVersion获取版本号
getScreenCaptureWindowId获取屏幕id
audioInterrupt是否声音被中断
aec回声消除

设备事件

事件 描述
onCameraUpdate摄像头变化
onAudioOutputTypeChange音频输出类型变化
onRenderReceived收到第一帧数据
onRenderStart渲染开始
onAudioInerruptAndResume声音的中断恢复
onSnapshotComplete截图完成事件
onRenderCallback媒体流上报
onVideoCaptureDidStart视频采集开始
onAudioInputCallback接收音频流

媒体频道管理

方法 描述
create创建 JCMediaChannel 对象
destroy销毁 JCMediaChannel 对象
channelUri获得频道 Uri
channelId获得频道标识
confId获得confId
password获得频道密码
channelNumber获得频道号
title返回频道标题
state返回当前在频道中的状态
participants获得所有频道中的成员
uploadLocalAudio获取本地音频数据是否在上传
uploadLocalVideo获取本地视频数据是否在上传
audioOutput获取音频是否输出
screenRenderId获取屏幕共享渲染标识
screenUserId获取开启屏幕共享的用户标识
recordState获取视频录制状态
cdnState获得cdn推流状态
query查询频道相关信息
join加入频道
leave离开频道
stop关闭频道
enableUploadAudioStream开启关闭发送本地音频流
enableUploadVideoStream开启关闭发送本地视频流
enableAudioOutput开启关闭音频输出
requestVideo请求频道中其他用户的视频流
requestScreenVideo请求频道成员屏幕共享的视频流
enableCdn开关Cdn推流
enableRecord开关视频录制
enableLocalRecord开关屏幕分享
enableScreenShare开关屏幕分享
getParticipant获取频道成员
getStatistics获取统计信息
setCustomProperty设置频道自定义属性
getCustomProperty获取频道自定义属性
sendMessage发送消息
sendCommand发送指令
inviteSipUser邀请Sip用户
setRatio设置视频宽高比
setScreenMode设置分屏模式
enableScreenShare开启/关闭屏幕分享
setConfig设置配置相关参数
getConfig获取配置相关参数
setCustomState设置自定义状态
getCustomState获得自定义状态
generateRoomId生成会议号
sendVideoEmptyPack视频发送空包
sendAudioEmptyPack音频发送空包
spkLevel扬声器音量
micLevel本地记录音量

媒体频道事件

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

文件存储管理

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

文件存储事件

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