JRTCSDK-Android v2401.0
视频客服 API 文档
载入中...
搜索中...
未找到
Public 成员函数 | 所有成员列表
JRTCAgentCallback接口 参考

Public 成员函数

void onGetAllGroups (boolean result, List< JRTCCallCenterGroupItem > groups)
 
void onCheckIn (boolean result, boolean pause, long onlineTime, long breakTime, long callTimes, int reason)
 
void onCheckin (boolean result, boolean pause, String reason)
 
void onCheckout (boolean result, @AgentCheckoutReason int reason)
 
void onCheckStateChanged (@AgentOperatorState int currState, @AgentOperatorState int oldState)
 
void onCallStateChanged (@AgentCallStateChangeType int type, @CallIncomingType int incomingType, JRTCInviter inviter, @CallTermReason int reason)
 
void onCallQueueCount (int count)
 
void onApplyResult (int operationId, boolean result)
 
void onTransferCallResult (int operationId, boolean result)
 
void onMemberJoin (JRTCRoomParticipant participant)
 
void onMemberLeave (JRTCRoomParticipant participant)
 
void onMemberUpdate (JRTCRoomParticipant participant, ChangeParam changeParam)
 
void onCallPropertyChanged (PropChangeParam propChangeParam)
 
void onUrgentRequest (String serialNumber, String callerNumber)
 
void onResponseUrgentResult (boolean result, int operationId)
 
void onQueryAvailableAgentList (int operationId, boolean result, List< String > userIds)
 
void onHoldStateChanged (boolean hold)
 
void onCallTypeChanged (@CallType int callType)
 
void onTurnCallTypeForSipResult (boolean result, String reason)
 
void onMessageReceived (String content, String contentType, @MessageType int messageType, String fromUserId)
 
void onDeliveryAbort (boolean isShutDown, String deliveryUserId, String reason)
 
void onInviteThirdAgentResult (boolean result, String error)
 
void onInviteThirdGuestResult (boolean result, String userId, String error)
 
void onNotifyMessageReceived (JRTCNotifyMessage notifyMessage, String fromUserId)
 
void onOnewayVideoChanged (boolean turnOn)
 
void onSignResultResponse (boolean result, String fromUserId, String extraInfo)
 
void onSwitchPartRoleResult (int operationId, boolean result, String error)
 
void onKickParticipantResult (int operationId, boolean result, String error)
 

详细描述

座席相关事件回调

成员函数说明

◆ onApplyResult()

void onApplyResult ( int  operationId,
boolean  result 
)

示忙/示闲回调

座席示忙/示闲状态发生改变时,会收到此回调,例如调用 applyStatePause 接口修改忙闲状态。
可以通过 pause 获取当前的忙闲状态。

参数
operationId对应 applyStatePause 接口的返回值
result示忙/示闲操作结果
  • true: 示忙/示闲成功
  • false: 示忙/示闲失败

◆ onCallPropertyChanged()

void onCallPropertyChanged ( PropChangeParam  propChangeParam)

通话属性改变回调

注解
重点关注屏幕共享,即当screenShare 属性为 true 时,去处理屏幕共享相关事件。
可根据 shareRenderIdshareUserId 属性进行屏幕共享画面的渲染和停止渲染。
参数
propChangeParam通话改变的属性

◆ onCallQueueCount()

void onCallQueueCount ( int  count)

当前排队人数上报回调

参数
count当前座席所关联的所有业务号下排队总人数,不包含已经分配座席但是未接听的的访客成员

◆ onCallStateChanged()

void onCallStateChanged ( @AgentCallStateChangeType int  type,
@CallIncomingType int  incomingType,
JRTCInviter  inviter,
@CallTermReason int  reason 
)

通话状态改变回调

参数
type通话状态改变类型,即以下情况会收到此回调:
incomingType来电类型,当 type == AGENT_CHANGE_TYPE_INCOMING 时有效
inviter邀请成员对象,当 type == AGENT_CHANGE_TYPE_INCOMING 时有效
reason挂断原因,只在 type 为 AGENT_CHANGE_TYPE_TERMED 时需要关注,详见 CallTermReason

◆ onCallTypeChanged()

void onCallTypeChanged ( @CallType int  callType)

音视频通话切换回调

通话中的访客和座席可分别调用 turnCallTypeturnCallType 方法切换音视频通话模式,通话中所有成员都会收到此回调。

参数
callType通话模式

◆ onCheckIn()

void onCheckIn ( boolean  result,
boolean  pause,
long  onlineTime,
long  breakTime,
long  callTimes,
int  reason 
)

签入回调

座席调用 checkIn 接口成功,会收到此回调。

参数
result签入结果
  • true: 签入成功
  • false: 签入失败
pause签入后的示闲/示忙状态
  • true: 签入后示忙
  • false: 签入后示闲
onlineTime座席累计在线时长
breakTime座席累计示忙时长
callTimes通话次数
reason签入失败原因
弃用:
该回调方法即将废弃,请使用 onCheckin 代替

◆ onCheckin()

void onCheckin ( boolean  result,
boolean  pause,
String  reason 
)

签入回调

座席调用 checkin 接口成功,会收到此回调。

参数
result签入结果
  • true: 签入成功
  • false: 签入失败
pause签入后的示闲/示忙状态
  • true: 签入后示忙
  • false: 签入后示闲
reason失败原因

◆ onCheckout()

void onCheckout ( boolean  result,
@AgentCheckoutReason int  reason 
)

签出回调

座席调用 checkout 接口签出排队机,会收到此回调。

参数
result签出结果
  • true: 签出成功
  • false: 签出失败
reason签出原因

◆ onCheckStateChanged()

void onCheckStateChanged ( @AgentOperatorState int  currState,
@AgentOperatorState int  oldState 
)

签入/签出状态改变

参数
currState当前座席状态
oldState旧的座席状态

◆ onDeliveryAbort()

void onDeliveryAbort ( boolean  isShutDown,
String  deliveryUserId,
String  reason 
)

录制异常回调

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

参数
isShutDown录制异常时服务器是否自动结束通话
  • true: 自动结束通话
  • false: 不自动结束通话
deliveryUserId录制异常的用户ID
reason录制异常的原因

◆ onGetAllGroups()

void onGetAllGroups ( boolean  result,
List< JRTCCallCenterGroupItem groups 
)

获取业务号列表结果回调

座席调用 queryAllGroups 接口获取业务号列表,会收到此回调。

参数
groups座席业务实体对象列表,获取失败时为 null
result获取结果
  • true: 获取成功
  • false: 获取失败

◆ onHoldStateChanged()

void onHoldStateChanged ( boolean  hold)

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

通话中座席可调用 setHoldState 接口保持通话或取回通话,通话中所有成员都会收到此回调。

参数
holdtrue 表示通话被保持,false 表示通话取回

◆ onInviteThirdAgentResult()

void onInviteThirdAgentResult ( boolean  result,
String  error 
)

邀请第三方座席结果回调

参数
result邀请第三方座席结果
  • true: 邀请成功
  • false: 邀请失败
error邀请第三方座席失败原因

◆ onInviteThirdGuestResult()

void onInviteThirdGuestResult ( boolean  result,
String  userId,
String  error 
)

邀请第三方访客结果回调

参数
result邀请第三方访客结果
  • true: 邀请成功
  • false: 邀请失败
userId访客用户ID
error邀请第三方访客失败原因,仅在失败时生效

◆ onKickParticipantResult()

void onKickParticipantResult ( int  operationId,
boolean  result,
String  error 
)

踢出通话成员结果回调

参数
operationId操作id,对应 kickParticipant 接口的返回值
result踢出通话成员结果
  • true: 操作成功
  • false: 操作失败
error踢出通话成员操作失败原因

◆ onMemberJoin()

void onMemberJoin ( JRTCRoomParticipant  participant)

通话中有新成员加入回调

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

参数
participant新加入的成员对象

◆ onMemberLeave()

void onMemberLeave ( JRTCRoomParticipant  participant)

通话中有成员离开回调

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

参数
participant离开的成员对象

◆ onMemberUpdate()

void onMemberUpdate ( JRTCRoomParticipant  participant,
ChangeParam  changeParam 
)

通话中成员属性更新回调

常用的有 音量值音频上传状态视频上传状态等。
例如当通话中有成员关闭视频传输,通话中所有成员都会收到此回调。

参数
participant属性更新的成员对象
changeParam更新的属性对象

◆ onMessageReceived()

void onMessageReceived ( String  content,
String  contentType,
@MessageType int  messageType,
String  fromUserId 
)

收到消息回调

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

参数
content消息内容
contentType消息内容类型
messageType消息归属类型
fromUserId发送方的用户ID

◆ onNotifyMessageReceived()

void onNotifyMessageReceived ( JRTCNotifyMessage  notifyMessage,
String  fromUserId 
)

收到事件通知消息回调

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

参数
notifyMessage事件通知实体类
fromUserId发送方的用户ID

◆ onOnewayVideoChanged()

void onOnewayVideoChanged ( boolean  turnOn)

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

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

参数
turnOn是否单向视频

◆ onQueryAvailableAgentList()

void onQueryAvailableAgentList ( int  operationId,
boolean  result,
List< String >  userIds 
)

查询空闲座席回调

座席调用 queryAvailableAgentList 接口查询空闲座席成功时,会收到此回调。

参数
operationId操作id,对应 queryAvailableAgentList 接口的返回值
result查询结果
  • true: 查询成功
  • false: 查询失败
userIds查询到的空闲座席列表

◆ onResponseUrgentResult()

void onResponseUrgentResult ( boolean  result,
int  operationId 
)

处理加急结果回调

参数
result处理结果
  • true: 处理成功
  • false: 处理失败
operationId操作id,对应 responseUrgent 接口的返回值

◆ onSignResultResponse()

void onSignResultResponse ( boolean  result,
String  fromUserId,
String  extraInfo 
)

收到访客签名请求结果回调

通话中访客调用 JRTCGuest#responseSignResult(boolean, String, String) responseSignResult} 接口给座席发送签名请求结果,座席会收到此回调。

参数
result签名结果
  • true: 签名成功
  • false: 签名失败
fromUserId响应签名请求结果的访客用户ID
extraInfo随路额外消息

◆ onSwitchPartRoleResult()

void onSwitchPartRoleResult ( int  operationId,
boolean  result,
String  error 
)

切换自己在通话中角色结果回调

参数
operationId操作id,对应 switchPartRole 接口的返回值
result切换自己在通话中角色结果
  • true: 操作成功
  • false: 操作失败
error切换自己在通话中角色操作失败原因

◆ onTransferCallResult()

void onTransferCallResult ( int  operationId,
boolean  result 
)

通话转接回调

调用 transferCall 接口将通话转接给其他座席或业务组时,会收到此回调。

参数
operationId操作id,对应 transferCall 接口的返回值
result通话转接结果
  • true: 转接成功
  • false: 转接失败

◆ onTurnCallTypeForSipResult()

void onTurnCallTypeForSipResult ( boolean  result,
String  reason 
)

请求音视频通话切换结果回调

注解
目前仅支持Sip通话情况下,请求Sip成员开启视频
参数
result请求音视频通话切换结果
  • true: 请求成功
  • false: 请求失败
reason失败原因

◆ onUrgentRequest()

void onUrgentRequest ( String  serialNumber,
String  callerNumber 
)

收到加急请求回调

访客在排队过程中调用 requestUrgent 接口发起加急请求成功后,管理员权限的座席(业务管理平台配置)会收到此回调。
座席收到回调后可调用 responseUrgent 接口对加急请求进行处理,接口的参数从此回调中获得。

参数
serialNumber服务唯一标识
callerNumber发起加急请求的用户ID