前端SDK文档接入（3.x）

参数

描述

类型

instanceId

string

dom

挂载元素的ID（只需要在UI版本必填）。

string

参数

描述

类型

默认值

header

是否展示头部（"云联络中心"名称）。

boolean

true

width

SDK面板的宽度（为了保证完整的UI展示，宽度最小310px）。

string | number

310px

height

SDK面板的高度（为了保证完整的UI展示，高度最小540px）。

string | number

620px

visible

是否展示SDK面板。

boolean

true

mainContentVisible

是否展示SDK面板完整内容，设置false则只展示最简单功能的SDK工具条。

boolean

true

offlineImage

下线展示的静态图片地址。

string

系统默认

breakImage

小休展示的静态图片地址。

string

系统默认

containerStyle

自定义外层样式。

React.CSSProperties

-

functionSwitch

面板上的功能开关（是否显示），部分配置还需要在工作台上开启。

WorkbenchUIFunctionSwitch

参考下方类型说明

reducePanelContainer

最小化面板的容器，会渲染到该容器上。

Function() => HTMLElement

默认在dom参数的ID标签中渲染

defaultLastSelectedCallerNumber

默认选择上次选择的外呼号码，在重新上下线时，默认再次选中上次使用的外呼号码。

boolean

true

exportErrorOfApi

Toast提示接口的错误信息、“ApiName”、“ErrorCode”、“RequestId”，当接口出现错误时，提供错误信息， 便于后端排查问题。默认是"false"，可根据需要是否Toast错误消息。

boolean

false

prettyPhoneNumber

是否格式化显示电话号码。

如：01012345678会格式化显示为010-12345678。

boolean

true

参数

描述

类型

默认值

showToggleStatus

显示左上角切换状态操作，包括最小化时左边的展示。

boolean

true

breakAction

显示左上角状态切换里的【小休】操作。

boolean

true

offlineAction

显示左上角状态切换里的【下线】操作。

boolean

true

invisibilityAction

显示左上角状态切换里的【隐身】操作。

boolean

true

adjustVolumeSetting

显示右上角设置中【音量调节】操作。

boolean

true

deviceDetectSetting

显示右上角设置中【设备检测】操作。

boolean

true

accessModeSetting

显示右上角设置中【接入模式】操作。

boolean

true

accessPointSetting

显示右上角设置中【坐席接入点】操作，当 "isEnableSwitchAdapter: true" 时生效。

boolean

true

showFlashSmsConfig

显示右上角设置中【闪信配置】操作，当前配置生效的前提是配置过闪信运营商。

boolean

true

allowStartConference

允许坐席发起会议。

boolean

true

allowMonitoring

允许发起监听。

此选项开启以后还需要管理员或者技能组组长权限，坐席权限就算设置此项也不能发起监听。

boolean

true

allowCallOutbound

允许坐席外呼电话。

boolean

true

allowViewRecord

允许坐席查看【通话记录】。

boolean

true

allowViewMyWork

允许坐席查看【我的工作】。

boolean

true

reducePanel

显示界面右上角最小化按钮。

boolean

true

closeable

显示右上角面板关闭按钮。

boolean

true

showSpeechToText

显示语音转文本按钮。

boolean

true

allowCreateTicket

允许坐席创建工单。

boolean

true

allowCreateSessionSummary

允许坐席创建会话小结。

boolean

true

aiAssistantConfig

aiAssistantConfig: {object}允许坐席使用AI助手配置。

aiAssistantConfig.summary: {boolean} 会话小结和标签是否允许使用AI助手。

aiAssistantConfig.ticket: {boolean} 工单是否允许使用AI助手。

object

{summary: true,ticket: true}

allowTransfer

allowTransfer: {boolean | object}允许坐席发起转接。

allowTransfer: {boolean} 是否允许所有转接方式。

allowTransfer.initiateAttendedTransfer: {boolean} 是否允许咨询转接。

allowTransfer.blindTransfer: {boolean} 是否允许直接转接。

boolean | object

true

参数

描述

类型

默认值

regionId

云呼服务器部署的集群，如果没有特殊说明，为cn-shanghai。

string

"cn-shanghai"

afterCallRule

挂机后进入空闲状态的时间，单位为秒，默认为15秒；等待客服手动从话后处理切换到空闲状态，为"manual"；默认为客服工作台设置的值。

number | 'manual'

工作台配置

autoAnswerCall

有来电时自动接听电话的时长，单位为秒，默认为客服工作台设置的值。

number

工作台配置

useLocalStorageToCall

是否允许使用多标签页外呼。

boolean

false

pollFrequenceWithoutWS

当坐席状态WebSocket连接失败时，调用PollUserStatus来拉取坐席状态的频率，

默认值为1000，单位毫秒。

目前云联络中心采用双通道方式来保证坐席状态的实时性与准确性：WebSocket推送和REST API拉取。

number

1000

pollFrequenceWithWS

当坐席状态WebSocket连接成功时，调用PollUserStatus来拉取坐席状态的频率，（兜底策略以及心跳）。

默认值为10000，单位毫秒。

number

10000

pollSaveWebRtcInfoFrequence

轮询接口SaveWebRtcInfo的轮询频率，

默认值为10000，单位为毫秒。

number

10000

disableSaveStats

默认为false（不关闭收集通话录音数据）。收集坐席侧通话录音数据，方便出现问题时进行语音排查和网络分析。 强烈不建议关掉，当出现问题时不方便工程师排查。

boolean

false

customizedNotification

支持集成客户自主定制来电桌面提醒，默认显示云联络中心配置的桌面来电提醒，默认为false，传值为true时不展示。

boolean

false

isEnableSwitchAdapter

为提高坐席语音通话质量，新增多个接入点语音专线，默认为true。如果坐席需要直连云联络中心服务器，可设置为false。

boolean

true

allowCalleeEncryption

是否允许被叫号码加密传输（call方法的callee参数类型不做限制）。

boolean

false

isMonitoredWithoutPerception

坐席是否无感知被监听，当设置为true时，通话页面上不展示监听者信息。

boolean

false

ringingToneSrc

自定义来电铃声，HTMLaudio标签的src属性。

string

系统默认

isOutboundNotReceivedToBeProcessed

是否在外呼时未接听也流转到话后处理（当前是未接通后到话后处理状态，再立即到空闲状态）。

boolean

false

videoCallConfig

视频坐席相关配置。

VideoCallConfig

参考下方类型说明

imConfig

IM 聊天插件的配置，需要加载IM SDK资源。

IMConfig

参考下方类型说明

transferDisplayedCustomerNumber

在转接外部号码时选择外显客户号码。

boolean

false

logger

日志配置：

logger.builtinEnabled: {boolean} 启动内置日志打印（使用console打印到浏览器调试控制台），

logger.level: {number} 日志等级，0(error)，1(warn)，2(log)，3(debug)，

logger.connector: {(level: string, category: string, label: string | undefined, content: any) => void} 工厂函数，所有日志都经过这个方法处理。

object

-

参数

描述

类型

默认值

ajaxOrigin

请求源，默认请求当前源。

string

location.origin

ajaxPath

请求路径。

string

"/data/api.json"

ssePath

sse接口的请求路径。

string

"/sseApi"

ajaxApiParamName

指定区分action的名称。

string

"action"

ajaxMethod

请求方式，post|get。

"post" | "get"

"post"

ajaxOtherParams

其他自定义参数和request同一层级。

object

-

ajaxHeaders

请求的headers。

object

{'Content-Type': 'application/x-www-form-urlencoded'}

withCredentials

表示跨域请求时是否需要使用凭证,是否允许携带cookie。

boolean

false

apiAxiosFunc

支持客户自己写请求接口的方法，最终返回结果为一个promise对象且返回的数据格式要和云联络中心公有云数据接口返回格式一致。

注意：

因为云联络中心内部使用axios请求库，默认返回的结果数据结构是：

{ 
   data: {
     code: "xxx",
     data: "xxx",
     httpStatusCode: "xxx",
     requestId: "xxxx"
   }
}

如果不是使用axios的话，请确保return的数据是这种数据结构，比 http 请求中返回的值多一个data包裹。

function

-

参数

描述

类型

默认值

enable

是否启动视频通话。

boolean

false

customVideoNode

自定义显示视频组件：

customVideoNode.localVideo: {HTMLVideoElement} 本地视频 DOM，

customVideoNode.remoteVideo: {HTMLVideoElement} 远程视频 DOM。

无UI版本该参数必填。

video dom需要添加 autoplay 属性来启动自动播放，localVideo 需要添加 muted 属性禁止播放声音（防止重音）。

object

-

disabledResize

禁止调整视频窗口大小。

boolean

false

defaultEnableCamera

默认开启摄像头。

boolean

true

getContainer

默认将弹窗插入 document.body.div 下，可自定义将弹窗放在的哪个容器里面。

() => HTMLElement

-

defaultSize

默认视频窗口的宽高：

defaultSize.width: {number} 宽度，

defaultSize.height: {number} 高度。

object

{width: 1024, height: 576}

cacheSize

是否存储上次调整的视频窗口尺寸。

boolean

true

minConstraints

窗口大小的调整的最小宽高约束 [宽, 高]。

[number, number]

[768, 432]

maxConstraints

窗口大小的调整的最大宽高约束 [宽, 高]。

[number, number]

[1280, 720]

isFixed

是否是position: fixed布局。

boolean

true

defaultPosition

默认显示在屏幕中的位置，不设置默认屏幕正中，有缓存配置的话，使用缓存中的位置（需 cachePosition=true）。

defaultPosition.x: {number}，

defaultPosition.y: {number}。

object

屏幕正中

disabledDrag

视频窗口是否禁止拖拽移动。

boolean

false

cachePosition

是否存储上次调整的位置，下次来电视频弹窗默认为上次的位置。

object

true

setIncomingCallPrompt

设置来电提示语，默认：“xxx邀请您进行视频通话”。

(details: { callContext: object }) => string

-

containerBackground

容器的背景 css background 属性。

string

#374151

operationControl

操作控制按钮：

operationControl.microphone: {boolean} 是否静音，

operationControl.camera: {boolean} 是否开启摄像头，

operationControl.fullscreen: {boolean} 是否全屏。

object

{microphone: true,camera: true,fullscreen: true}

参数

描述

类型

默认值

getContainer

IM插件的显示容器（必填）。

() => HTMLElement

-

user

自定义坐席信息，默认取【云联络中心>我的工作台>设置】中的头像和昵称参数。

user.nickname: {string} 名称，

user.avatarUrl: {string} 头像。

object

系统配置

onConvChange

激活的会话改变事件，为null时，没有激活会话。

签名：

Function(conv: object | null) => void

参数：

conv: {object} 会话信息。

Function

-

onConvInvite

会话邀请事件。

签名：

Function(event: object) => void

参数：

event: {object} 会话附加信息。

Function

-

onConvCancelInvite

取消会话邀请事件。

签名：

Function(event: object) => void

参数：

event: {object} 会话附加信息。

Function

-

onConvReleased

会话结束事件。

签名：

Function(event: object) => void

参数：

event: {object} 会话附加信息。

Function

-

onMessageAdd

消息新增事件。

签名：

Function(message: object) => void

参数：

message: {object} 消息详情。

Funciton

-

onClaimQueueAdd

队列中的消息增加事件。

签名：

Function(claimQueueList: array) => void

参数：

claimQueueList: {Array<object>} 新增的待认领会话列表。

Function

-

参数

描述

onInit

SDK对象实例化完成时触发。

签名：

Function() => void

onRegister

SIP服务注册成功时触发。

签名：

Function(event: object) => void

参数：

event: {object} GetLoginDetails接口返回的登录信息数据。

onLogIn

签入、上线时触发。

签名：

Function(event: object) => void

参数：

event.chooseSkillGroupList: {array} 上线时选择的技能组列表。

onLogOut

退出登录时触发。

签名：

Function() => void

onBreak

小休时触发。

签名：

Function(event: object) => void

参数：

event.breakReason: {string} 小休原因。

onReady

空闲时触发。

onChangeInvisibility

隐身状态切换。

签名：

Function(invisibility: boolean) => void

参数：

invisibility: {boolean} `true`为当前是隐身状态，`false`为当前是非隐身状态。

onCallComing

来电时触发。

签名：

Function(event: object) => void

参数：

event.caller: {string} 主叫号码。

event.callee: {string} 被叫号码。

event.jobId: {string} 当前通话ID。

event.callType: {string} 呼叫类型，参考CallType参数类型。

event.callContext: {object} 当前通话的详细信息，参考PollUserStatus接口返回的数据类型。

onBeforeCallDialing

调用call方法前触发，如果配置这样一个钩子函数，一定要执行callback方法，否则电话不会被拨打出去。

签名：

Function(event: object) => void

参数：

event.callee: {string} 被叫号码。

event.userId: {string} 坐席ID。

event.callback: {Function(callee?: string) => void} 满足条件以后的回调函数，可传入修改后的`callee`，不传为`event.callee`。

onCallDialing

去电、拨号振铃时触发。

签名：

Function(event: object) => void

参数：

event.caller: {string} 主叫号码。

event.callee: {string} 被叫号码。

event.jobId: {string} 当前通话ID。

event.callType: {string} 呼叫类型，参考CallType参数类型。

event.callContext: {object} 当前通话的详细信息，参考PollUserStatus接口返回的数据类型。

onCallEstablish

通话建立连接时触发。

签名：

Function(event: object) => void

参数：

event.callContext: {object} 当前通话的详细信息，参考PollUserStatus接口返回的数据类型。

onBeforeCallHangup

调用`hangUp`方法前触发，如果配置这样一个钩子函数，一定要执行`callback`方法，否则电话不会被挂断。

签名：

Function(event: object) => void

参数：

event.jobId: {string} 当前通话ID。

event.channelId: {string} 这个坐席通话的channel id。

event.userId: {string} 坐席ID。

event.callback: {Function(jobId?: string, channelId?: string) => void}，表示满足条件以后的回调函数。

onHangUp

挂机时触发。

签名：

Function(type：string) => void

参数：

type:{string} 挂机时的类型，具体为下述类型：

• ringing：代表呼入未接时挂机。

• dialing：代表呼出未接时挂机。

• inbound：代表呼入通话，通话中挂断。

• outbound：代表呼出通话，通话中挂断。

• agentHeld： 代表咨询通话，通话中挂断。

• meeting：代表会议或会议中坐席状态变化，通话中挂断。

• consulted：代表被动求助（被咨询通话），通话中挂断。

• monitored：代表监听，通话中挂断。

• monitoring：代表发起监听，还未监听成功，通话中挂断。

• bargedIn：代表强插，通话中挂断。

• coached：代表耳语坐席，进入三方通话，通话中挂断。

onCallRelease

通话结束时触发。

签名：

Function(event: object) => void

参数：

event.CallContext: {object} 当前通话的详细信息，参考PollUserStatus接口返回的数据类型。

onErrorNotify

有一些错误信息会被触发，可以获取错误信息。

当处于开发阶段时建议在该钩子函数中打印参数，以获取错误信息。

签名：

Function(event: object) => void

参数：

event.apiCode: {string} 当是API接口错误时，返回API接口报错的错误码，即接口返回的code。

event.errorCode: {string} 当是API接口错误时，返回接口action名称，否则返回系统定义的错误码。

event.errorMsg: {any} 详细错误信息。

event.errorMsgTip: {string} 错误信息提示。

event.requestId: {string} 当是API接口报错时，返回接口requestId参数。

onStatusChange

任何状态改变都会触发该函数，可在该函数内监听当前状态值的变化过程。状态code的含义请参考本文 状态对照表及状态说明。

签名：

Function(event: object) => void

参数：

event.code: {number} 当前状态码。

event.lastCode: {number} 上次状态码。

event.callContext: {object} 当前通话的详细信息，参考PollUserStatus接口返回的数据类型。

onWorkModeChange

坐席默认有两种工作模式：场内模式和场外模式。当坐席配置了SIP话机后，还有办公电话模式。

签名：

Function(workMode: string) => void

参数：

workMode: {string} 工作模式

• ON_SITE（场内模式）：通过浏览器接听、拨打电话。

• OFF_SITE（场外模式）：通过手机接听电话，即1.0中的“手机接听”方式。

• OFFICE_PHONE（办公电话模式）：通过SIP话机接听、拨打电话，无需通过浏览器操作。

onDeviceTypeChange

当坐席配置了SIP话机后，如果坐席通过浏览器上线，可选择使用哪种设备：WebRTC软电话和SIP话机。

签名：

Function(deviceType: number) => void

参数：

deviceType: {number} 设备类型

• 0：WebRTC软电话。

• 1：SIP话机。

onGetStatsData

获取语音质量数据。

签名：

Function(event: object) => void

参数：

event: {object}

event.jobId: {string} 当前通话的ID。

event.callId: {string} 当前通话的话务ID。

event.connid: {string} 当前通话的话务序列ID。

event.sender: {RTCStatsReport} 具体参数类型参考 RTCRtpSender.getStats()。

event.receiver: {RTCStatsReport} 具体参数类型参考 RTCRtpReceiver.getStats()。

event.moss: {Array<number>} 语音质量评分，通话过程中，每秒多出一条（静音状态下不新增）。

onAfterEarlyMediaRecognized

有早媒体识别音时触发。

签名：

Function(event: object) => void

参数：

event: {object}

event.earlyMediaState: {string} 状态。

event.earlyMediaText: {string} 内容。

event.earlyMediaTime: {number} 时间。

event.releaseAfterEarlyMediaRecognized: {number} 识别到早媒体自动释放的时间（可在坐席控制台设置中配置）。

onSignedSkillGroupChange

签入技能组列表变化。

签名：

Function(signedSkillGroupList: array, prevSignedSkillGroupList: array) => void

参数：

signedSkillGroupList: {array} 已签入技能组列表。

prevSignedSkillGroupList: {array} 上次签入的技能组列表。

onAudioTranscriptionText

语音转文字。

签名：

Function(event: object) => void

参数：

event: {object}

event.jobId: {string} 当前通话ID。

event.latestMessage: {object} 最新一条音转文消息。

event.messages: {Array<object>} 当前通话音转文的所有消息列表。

onBeingMonitored

当前坐席处于被监听状态时触发，监听者退出也触发。

签名：

Function(event: object) => void

参数：

event: {object}

event.isBeingMonitored: {boolean} 是否正在被监听。

event.monitorChannelContext: {object} 监听者的channel上下文信息。

onIvrTrackingAISummary

推送AI总结IVR轨迹分析结果事件。

签名：

Function(event: object) => void

参数：

event: {object}

event.jobId: {string} 当前通话ID。

event.result: {string} IVR轨迹分析结果。

event.success: {boolean} 是否分析成功。

onMainContentVisibleChange

【UI版本】mainContentVisible 参数改变事件。

签名：

Function(visible: boolean) => void

参数：

visible: {boolean} 是否最大化，显示完整内容。

onWorkbenchClose

【UI版本】工作台右上角关闭按钮点击事件。

签名：

Function() => void

onSelectCurrentCallRecord

【UI版本】在通话记录列表页面，当前选中的通话记录。

签名：

Function(event: object) => void

参数：

event: {object}

event.record: {object} 选中的通话记录数据。

onSelectOutboundNumber

【UI版本】手动选择外呼号码时触发，`auto`时选择的自动。

签名：

Function(caller: string) => void

参数：

caller: {string} 选择的主叫号码

onMediaPlayFailed

当媒体失败（浏览器自动播放策略阻止等原因）导致听不到客户声音时，需要在这个函数中做处理。

浏览器为了防止网页自动播放音视频对用户造成干扰，对音视频的自动播放功能做了限制：在用户没有与网页产生交互（例如点击页面等）之前，带有声音媒体元素的网页将被禁止自动播放（Chrome中的自动播放策略，Safari中的自动播放策略）。

签名：

Function(event: object) => void

参数：

event.mediaElement: {HTMLMediaElement} 获取播放的媒体元素，尝试手动play

event.error: {Error} 媒体播放错误信息。

event.type: {string} remote：远程媒体；ringTone：来电响铃；dtmfTone：按键音；hintTone：提示音；local: 本地媒体。

属性

描述

类型

localMediaStream

本地媒体流。如果呼叫未接听，则未定义。

外呼时：最初可在 onCallDialing 获取。

呼入时：最初可在 onCallEstablish 获取。

MediaStream

remoteMediaStream

远程媒体流。如果呼叫未接听，则未定义。

外呼时：最初可在 onCallDialing 获取。

呼入时：最初可在 onCallEstablish 获取。

MediaStream

RTCPeerConnection

对等WebRTC连接。如果对等连接已关闭，则未定义。

RTCPeerConnection

参数

描述

changeUIConfig

修改UI版本专属配置。

签名：

Function(config: object | ((prevConfig: object) => object)) => void；

当config是Function时的config签名：Function(prevConfig: object) => object，返回当前config参数，并需要return新的config。

参数：

config: {object | function} 参考UI版本专属配置，目前可修改的参数为：

header

height

width

visible

mainContentVisible

offlineImage

breakImage

containerStyle

defaultLastSelectedCallerNumber

exportErrorOfApi

支持单个参数的修改。

getUIConfig

获取当前UI版本专属配置，只支持changeUIConfig方法可修改的参数。

签名：

Function() => object

返回值：

请参见 UI版本专属配置

changeFunctionSwitch

修改UI功能开关配置参数（functionSwitch）。

签名：

Function(config: WorkbenchUIFunctionSwitch | ((prevConfig: WorkbenchUIFunctionSwitch) => WorkbenchUIFunctionSwitch)) => void；

当config是Function时的config签名：Function(config: WorkbenchUIFunctionSwitch) => WorkbenchUIFunctionSwitch，返回当前config参数，并需要return新的config。

参数：

config: {WorkbenchUIFunctionSwitch | function} 参考WorkbenchUIFunctionSwitch

getFunctionSwitch

获取当前UI功能开关配置。

签名：

Function() => WorkbenchUIFunctionSwitch

返回值：

WorkbenchUIFunctionSwitch: 参考WorkbenchUIFunctionSwitch

reRender

重新渲染界面，适用于单页面应用程序，挂载的dom销毁后，再重新渲染。

签名：

Function() => void

setKeyboardValue

设置拨号盘上的号码。

签名：

Function(callee?: string, maskedCallee?: string) => void

参数：

callee?: {string} 被叫号码，显示在拨号盘上的输入框中。

maskedCallee?: {string} 被叫加密显示的号码（显示在坐席呼出详情里的号码）。

参数

描述

isAvailBrowser

此方法用来检测当前浏览器是否支持使用SDK。

签名：

Function() => Promise<boolean>

checkNetwork

此方法用来检测当前网络连接是否能连接到SDK网络服务，检测是否被本地的防火墙拦截。

签名：

Function() => Promise<boolean>

getSkillGroups

获取技能组列表。

签名：

Function() => object

返回值：

chooseSkillGroupList: 已选择签入的技能组列表。

allSkillGroupList: 坐席所属的所有技能组列表，在onInit钩子函数触发后，才有正确的数据。

getTurnServerList

获取接入点列表，在onInit钩子函数触发后，才有正确的数据返回。

签名：

Function() => Promise<array>

返回值：

请参见GetTurnServerList接口返回参数数据。

register

首次签入。页面加载完毕，首次签入需调用该方法。

签名：

Function(options?: object) => Promise<UserContext>

参数：

• options.currentSkillGroups?: {Array<object>} 当前需要签入的技能组，可以从 getSkillGroups 方法中获取可签入的技能组（UI版本不填会弹出选择技能组弹窗；非UI版本不填则必须在【坐席工作台-语音业务-设置-坐席工作台-坐席设置】中将“选择技能组登录”项设置为“否”，否则必填）。

• options.accessPoint?: {string} 接入点region，从getTurnServerList方法的返回值中选取一个，自动选择传default，SDK内部实现选择延迟最低的接入点。

• options.deviceType?: {0 | 1} 设备类型，默认为 `0`，软电话注册上线，当坐席注册了SIP话机，可设置参数为`1`，指定SIP话机上线。

• options.mode?: {enum} 登录模式，可选值：'normal'、'invisibility'、'break'，分别为正常、隐身模式、小休模式。

• options.breakReason?: {string} 小休模式上线时的小休原因。

返回值：

UserContext: 参考SignInGroup接口返回参数数据。

logIn

签入（处于签出状态可调用，状态为`1`），调用该方法实现上线操作。

签名：

Function(options?: object) => Promise<UserContext>

参数：

• options.currentSkillGroups?: {Array<object>} 当前需要签入的技能组，可以从 getSkillGroups 方法中获取可签入的技能组，不传默认使用register时签入的技能组。

• options.mode?: {enum} 登录模式，可选值：'normal'、'invisibility'、'break'，分别为正常、隐身模式、小休模式。

• options.breakReason?: {string} 小休模式上线时的小休原因。

返回值：

UserContext: 参考SignInGroup接口返回参数数据。

forceToPrepareSignIn

如果注册时收到7001错误，即已有设备在线，可以调用此方法继续注册。成功后会把原有设备踢下线。

签名：

Function() => Promise<UserContext>

返回值：

UserContext: 参考SignInGroup接口返回参数数据。

logOut

签出，调用该方法实现下线操作。

签名：

Function() => Promise<UserContext>

返回值：

UserContext: 参考SignOutGroup接口返回参数数据。

applyForBreak

申请小休，设置后来电将不会转到当前坐席，会转到其他空闲的坐席人员。

签名：

Function(breakReason?: string) => Promise<UserContext>

参数：

breakReason?: {string} 小休原因。

返回值：

UserContext: 参考TakeBreak接口返回参数数据。

ready

置空闲、通过该方法可变为空闲状态，空闲状态后可接听、拨打电话。IM可以接受分配和认领会话。

签名：

Function(options?: object) => Promise<UserContext>

参数：

options.invisible?: {boolean} 空闲时是否隐身。

返回值：

UserContext: 参考ReadyForService接口返回参数数据。

changeVisibility

隐身模式切换。如果为true，则坐席不会有电话呼入，也不会有IM会话分配。

签名：

Function(invisible?: boolean) => Promise<UserContext>

参数：

invisible?: {boolean} 是否隐身。

返回值：

UserContext: 参考SignInGroup接口返回参数数据

call

拨打电话。

签名：

Function(options?: object) => Promise<UserStatusContext>

参数：

• options.callee: {string} 被叫号码，如果是内部呼叫，该字段填写目标坐席的分机号，如果是外呼呼叫，填写客户的电话号码。

• options.caller?: {string} 主叫号码，如果是内部呼叫，这此参数无效，如果是外部呼叫，此参数为当前坐席可用的外呼号码。

• options.timeoutSeconds?: {number} 超时时间，呼叫在经过该参数指定的时间仍然未接通的情况下，则主动挂断，取值范围30-300，单位秒。

• options.maskedCallee?: {string} 脱敏后的被叫号码，如果该字段不为空，表示需要对被叫号码脱敏，脱敏规则由客户自行定义。

• options.mediaType?: {string} 媒体类型，默认是语音（AUDIO）, 其他可选参数包括 VIDEO。

返回值：

UserStatusContext: 参考MakeCall接口返回参数数据。

redialCall

重拨电话，使用jobId拨打，一般用于被叫号码加密的通话。

签名：

Function(options?: object) => Promise<UserStatusContext>

参数：

• options.jobId: {string} 通话ID。

• options.callee?: {string} 被叫号码，当前jobId通话的被叫号码。

• options.caller?: {string} 主叫号码。

• options.timeoutSeconds?: {number} 超时时间，呼叫在经过该参数指定的时间仍然未接通的情况下，则主动挂断，取值范围30-300，单位秒。

返回值：

UserStatusContext: 参考RedialCall接口返回参数数据。

agentToAgent

内部通话方法。

签名：

Function(extension: string) => Promise<UserStatusContext>

参数：

extension: {string} 坐席分机号。

返回值：

UserStatusContext: 参考MakeCall接口返回参数数据。

answer

接听电话，通过该方法可接听来电，建立通话连接。

签名：

Function() => Promise<UserStatusContext>

返回值：

UserStatusContext: 参考AnswerCall接口返回参数数据。

hangUp

挂断/拒接，通过该方法可结束通话。

签名：

Function(jobId?: string, channelId?: string) => Promise<UserStatusContext>

参数：

jobId?: {string} 可挂断指定通话。如果不传，则挂断当前通话。

channelId?: {string} 可挂断指定通话中的指定方。如果不传，则挂断当前通话。

返回值：

UserStatusContext: 参考ReleaseCall接口返回参数数据。

stayAfterCall

保持话后处理状态（与通话结束，点击话后处理按钮效果一致）。

签名：

Function() => Promise<void>

sendDtmf

DTMF按键交互，发送dtmf。

签名：

Function(options?: object) => Promise<UserStatusContext>

参数：

• options.dtmf: {string} DTMF按键信息，即拨号盘上的按键，包括0-9、*、#。

• options.jobId?: {string} 通话ID，多方通话时，必填。

• options.channelId?: {string} 待发送 DTMF 的话务通道 ID，多方通话时，必填。

返回值：

UserStatusContext: 参考SendDtmfSignaling接口返回参数数据。

callHold

通话保持/暂停通话，通过该方法可使通话进行保持，客户端听到的是一段音乐，坐席端说话客户端无法听到。

签名：

Function() => Promise<UserStatusContext>

返回值：

UserStatusContext: 参考HoldCall接口返回参数数据。

callRetrieve

通话取回，通过该方法结束通话保持的状态，重新建立客户端和坐席端的通话。

签名：

Function() => Promise<UserStatusContext>

返回值：

UserStatusContext: 参考RetrieveCall接口返回参数数据。

muteAgent

坐席通话中静音，关闭麦克风。

签名：

Function() => Promise<UserStatusContext>

返回值：

UserStatusContext: 参考MuteCall接口返回参数数据。

unmuteAgent

坐席取消通话中静音，开启麦克风。

签名：

Function() => Promise<UserStatusContext>

返回值：

UserStatusContext: 参考UnmuteCall接口返回参数数据。

changeRingToneVolume

改变来电振铃时的音量。

签名：

Function(volume: number) => void

参数：

volume: {number} 音量，值为[0, 1]的数。

changeVolumeInCall

改变通话中的音量。

签名：

Function(volume: number) => void

参数：

volume: {number} 音量，值为[0, 1]的数。

thirdCallTransfer

通话过程中直接转接，A和B通话，将通话直接交给C，直接转接也叫盲转或单步转。

签名：

Function(options?: object) => Promise<UserStatusContext>

参数：

• options.transferee: {string} 被转接方，可以是坐席分机号或技能组ID或外部号码。

• options.transferor?: {string} 转接发起方，当场景是直接转接到外部号码时，用此参数指定的号码作为主叫，转内部坐席或技能组时，此参数无效，发起方由UserId指定。

• options.callPriority?: {number} 转接到技能组队列时的排队优先级，取值范围0-9，0优先级最高，9最低。

• options.strategyName?: {string} 转接到技能组队列时的座席分配策略名称，可选值为 MOST_IDLE，MOST_SKILLED，MOST_ACQUAINTED，CUSTOMIZED。

• options.strategyParams?: {string} 转接到技能组队列时的座席分配策略参数。

• options.timeoutSeconds?: {number} 超时时间，取值范围30-300，单位秒。

• options.transfereeType?: {string} 转接目的类型，可选值为 AGENT，SKILL_GROUP，IVR 和 EXTERNAL_NUMBER。

• options.contactFlowVariables?: {string} 传递给联系流的变量，这里配置的变量，可以在 IVR 流程中拿到并使用，格式为 JSON 字符串格式的键值对集合。

返回值：

UserStatusContext: 参考BlindTransfer接口返回参数数据。

initiateAttendedTransfer

通话过程中咨询转接，A和B通话，咨询C，咨询过程中A等待，咨询转接也叫关注转或双步转。

签名：

Function(options?: object) => Promise<UserStatusContext>

参数：

• options.transferee: {string} 被转接方，可以是坐席分机号或技能组ID或外部号码。

• options.transferor?: {string} 转接发起方，当场景是直接转接到外部号码时，用此参数指定的号码作为主叫，转内部坐席或技能组时，此参数无效，发起方由UserId指定。

• options.callPriority?: {number} 转接到技能组队列时的排队优先级，取值范围0-9，0优先级最高，9最低。

• options.strategyName?: {string} 转接到技能组队列时的座席分配策略名称，可选值为 MOST_IDLE，MOST_SKILLED，MOST_ACQUAINTED，CUSTOMIZED。

• options.strategyParams?: {string} 转接到技能组队列时的座席分配策略参数。

• options.timeoutSeconds?: {number} 超时时间，取值范围30-300，单位秒。

• options.transfereeType?: {string} 转接目的类型，可选值为 AGENT，SKILL_GROUP，IVR 和 EXTERNAL_NUMBER。

• options.contactFlowVariables?: {string} 传递给联系流的变量，这里配置的变量，可以在 IVR 流程中拿到并使用，格式为 JSON 字符串格式的键值对集合。

返回值：

UserStatusContext: 参考InitiateAttendedTransfer接口返回参数数据。

thirdCallRetrieve

三方通话取回，回到原来的通话，A和B通话，咨询C，咨询完成回到A和B通话。

签名：

Function() => Promise<UserStatusContext>

返回值：

UserStatusContext: 参考CancelAttendedTransfer接口返回参数数据。

thirdCallTransferFinished

三方咨询通话过程中转移通话，A和B通话，咨询C，咨询完成回到A和B通话，实现A和C通话。

签名：

Function() => Promise<UserStatusContext>

返回值：

UserStatusContext: 参考CompleteAttendedTransfer接口返回参数数据。

switchToConference

咨询通话转会议（多方通话）。

签名：

Function() => Promise<UserStatusContext>

返回值：

UserStatusContext: 参考SwitchToConference接口返回参数数据。

startConference

发起会议。

签名：

Function(options?: object) => Promise<UserStatusContext>

参数：

• options.participantListJson: {string} 参会方列表，格式为JSON数组的字符串，数组元素是参会方，如果是内呼坐席， 参会方是目标的坐席分机号，如果是外呼客户，参会方是客户号码。

• options.timeoutSeconds?: {number} 超时时间，取值范围30-300，单位秒。

返回值：

UserStatusContext: 参考StartConference接口返回参数数据。

monitor

监听方法。

签名：

Function(userId: string) => Promise<UserStatusContext>

参数：

userId: {string} 需要监听的坐席ID。

返回值：

UserStatusContext: 参考MonitorCall接口返回参数数据。

bargeIn

强插方法。成功后，转入三方会议模式。

签名：

Function(options?: object) => Promise<UserStatusContext>

参数：

• options.jobId: {string} 被强插的通话ID。

• options.bargedUserId: {string} 被强插的座席ID。

• options.timeoutSeconds?: {number} 强插超时时间，经过指定的时间强插仍未成功，则取消强插，正常情况下，强插操作会马上成功， 设置超时时间是为了防止异常发生，此字段选填，默认30，单位秒。

返回值：

UserStatusContext: 参考BargeInCall接口返回参数数据。

intercept

强拆方法，成功后，原坐席被踢出通话，新插入坐席与客户通话。

签名：

Function(options?: object) => Promise<UserStatusContext>

参数：

• options.jobId: {string} 被强拆的通话ID。

• options.interceptedUserId: {string} 被强拆的座席ID。

• options.timeoutSeconds?: {number} 强拆超时时间，经过指定的时间强拆仍未成功，则取消强拆，正常情况下，强拆操作会马上成功， 设置超时时间是为了防止异常发生，此字段选填，默认30，单位秒。

返回值：

UserStatusContext: 参考InterceptCall接口返回参数数据。

coach

辅导方法（耳语坐席）。管理员和技能组组长可以辅导坐席与客户通话。

成功后，客户只能听到初始坐席的声音，被辅导坐席可以同时听到客户和辅导者的声音。辅导者可以同时听到客户和坐席的声音。

签名：

Function(options?: object) => Promise<UserStatusContext>

参数：

• options.jobId: {string} 被辅导的通话ID。

• options.coachedUserId: {string} 被辅导的座席ID。

• options.timeoutSeconds?: {number} 辅导超时时间，经过指定的时间辅导仍未成功，则取消辅导，此字段选填，默认30，单位秒。

返回值：

UserStatusContext: 参考CoachCall接口返回参数数据。

cancelAutomaticCallRelease

取消外呼智能挂机设置（“设置-坐席工作台-坐席接听-外呼智能挂机”中配置）的自动挂机操作。

签名：

Function() => Promise<UserStatusContext>

返回值：

UserStatusContext: 参考CoachCall接口返回参数数据。

transferStatisfic

发送语音满意度,或者转到其他IVR流程。

签名：

Function(contactFlowId?: string) => Promise<UserStatusContext>

参数：

contactFlowId?: {string} 如果不传，则发起已配置的语音满意度流程。也可以传入指定IVR流程ID，发起指定IVR流程。发起IVR流程后，当前坐席被挂断。

返回值：

UserStatusContext: 参考LaunchSurvey接口返回参数数据。

launchShortMessageAppraise

送短信满意度，只有在话后处理状态下可用。

签名：

Function(options?: object) => Promise<UserStatusContext>

参数：

options.smsMetadataId?: {string} 表示短信满意度配置ID，如果不传，则发起已配置的短信满意度模板。

返回值：

UserStatusContext: 参考LaunchSurvey接口返回参数数据。

launchShortMessageMissedCall

发送语音满意度，或者转其他IVR流程。

签名：

Function(options?: object) => Promise<void>

参数：

options.smsMetadataId?: {string} 短信满意度配置ID，如果不传，则会使用已配置的漏话短信模板。

launchAuthentication

核身验证，发送指定IVR流程，当前坐席不被挂断。

签名：

Function(contactFlowId: string，contactFlowVariables?: string) => Promise<UserStatusContext>

参数：

• contactFlowId: {string} IVR 核身流程的联系流 ID。

• contactFlowVariables?: {string} 传递给联系流的变量，这里配置的变量，可以在 IVR 流程中拿到并使用，格式为 JSON 字符串格式的键值对集合。

返回值：

UserStatusContext: 参考LaunchAuthentication接口返回参数数据。

applyForOnSite

设置场内模式。当坐席为场外模式时，可调用此方法设置场内模式后上线。

签名：

Function() => Promise<UserContext>

返回值：

UserContext: 参考ChangeWorkMode接口返回参数数据。

applyForOffSite

设置场外模式。当坐席空闲时，可调用此方法设置场外模式，即手机接听。

签名：

Function(options?: object) => Promise<UserContext>

参数：

• options.signedSkillGroupIdList?: {Array<string>} 需要签入的技能组ID列表。可以通过此参数指定场外座席需要签入的技能组列表。不传的话，核心版本会默认使用上次签入时的技能组，UI版本会显示弹窗选择签入技能组。

• options.mobile?: {string} 坐席的个人电话号码，该号码在场外模式下会用到， 坐席可以使用该号码进行场外模式接听，不传的话，使用坐席详情中手机号码/固话参数。

返回值：

UserContext: 参考ChangeWorkMode接口返回参数数据。

applyForOffSiteDirectly

直接申请场外模式，不显示弹窗确认。核心版本该方法与 applyForOffSite 方法完全一致，UI版本，不传signedSkillGroupIdList，也不显示选择技能组弹窗，与核心版本的applyForOffSite方法效果一致。

签名、参数、返回值都与 applyForOffSite 一致。

getStatusCode

获取坐席当前状态码。

签名：

Function() => object

返回值：

code: {string} 当前状态。

lastCode: {string} 上一次状态。

testTurnServers

检测坐席接入点。

签名：

Function(options?: object) => Promise<object>

参数：

• options.accessPoint?: {string} 可以只测某个接入点的值。不传为测试当前所有接入点。

• options.currentFrequence?: {number} 测试几次，不传为1次。多次取平均值。

返回值：

• result: {object} 计算的节点数据。

• accessPoint: {string} 计算出延迟最低的节点。

switchAccessPoint

切换接入点.

签名：

Function(accessPoint: string) => void

参数：

accessPoint: {string} 需要切换的接入点。

getSoftPhoneDeviceId

获取当前软电话id。可以根据此值进行MakeCall接口调用。

签名：

Function() => string

toggleLocalVideo

本地摄像头开关。

签名：

Function(enabled: boolean) => Promise<void>

参数：

enabled: {boolean} 是否开启。

getAudioDeviceList

获取当前设备的麦克风和耳机列表。

签名：

Function() => Promise<MediaDeviceInfo[]>

返回值：

MediaDeviceInfo: 参考MediaDeviceInfo。

getVideoDeviceList

获取当前设备的摄像头列表。

签名：

Function() => Promise<MediaDeviceInfo[]>

返回值：

MediaDeviceInfo: 参考MediaDeviceInfo。

switchVideoInputDevice

切换摄像头设备，在下一通视频通话生效。

签名：

Function(deviceId: string) => void

参数：

deviceId: {string} 摄像头设备ID，可以通过getVideoDeviceList方法获取。

setAudioInputDevice

设置麦克风设备。

签名：

Function(deviceId: string) => void

参数：

deviceId: {string} 麦克风设备ID，可以通过getAudioDeviceList方法获取。

setAudioOutputDevice

设置麦扬声器/耳机设备。

签名：

Function(deviceId: string) => void

参数：

deviceId: {string} 扬声器设备ID，可以通过getAudioDeviceList方法获取。

addSignedSkillGroup

新增签入的技能组。

签名：

Function(options?: object) => Promise<void>

参数：

• options.skillGroupList?: {Array<object>} 需要签入的技能组列表，核心版本必传，UI版本不传的话，会弹出选择技能组弹窗进行选择。

• options.mediaTypeList?: {Array<string>} 需要签入的技能组媒体类型，不传选择所有媒体类型（只在UI版本支持该参数）。

renderIM

渲染IM插件（需要加载IM SDK）。

签名：

Function() => void

unmountIM

卸载IM插件（需要加载IM SDK），离线时自动卸载。

签名：

Function() => void

unloadWorkbench

卸载SDK工作台，此方法调用后，必须重新初始化实例。

签名：

Function() => Promise<void>

setCallerPhoneNumber

设置当前坐席外呼号码。

签名：

Function(phoneNumber: string) => void

参数：

phoneNumber: {string} 可外呼的号码，或者auto自动选择外呼号码

getCallerPhoneNumber

获取当前坐席外呼号码。

签名：

Function() => string

返回值：

返回当前坐席设置的外呼号码，auto是自动选择外呼号码

参数

描述

addListener

监听钩子函数触发。

签名：

Function(event: string, fn: (...args: any[]) => void, options: object) => void

参数：

event: {string} 钩子函数名称，具体查看钩子函数。

fn: {Function} 钩子函数触发时调用的函数。

options?.once: {boolean} 是否只触发一次。

示例：

window.CCCWorkbenchSDK.addListener('onInit', () => {
  console.log('实例已经初始化');
});

removeListener

删除指定钩子函数监听。

签名：

Function(event: string, fn?: (...args: any[]) => void) => void

参数：

event: {string} 钩子函数名称，具体查看钩子函数。

fn?: {Function} 钩子函数触发时调用的函数。

示例：

const onInitListener = () => {
  console.log('实例已经初始化');
};
// 添加监听器
window.CCCWorkbenchSDK.addListener('onInit', onInitListener);
// 删除监听器
window.CCCWorkbenchSDK.removeListener('onInit', onInitListener);

// 删除所有 onInit 监听器
window.CCCWorkbenchSDK.removeListener('onInit');

removeAllListeners

删除所有钩子函数监听或者指定钩子函数监听。

签名：

Function(event?: string) => void

参数：

event?: {string} 钩子函数名称，具体查看钩子函数。

类型

接口

描述

业务接口

GetLoginDetails

获取坐席的登录信息。

GetUser

获取坐席的信息。

ListSkillLevelsOfUser

坐席的技能组信息。

ListOutboundNumbersOfUser

坐席的外呼号码。

ListConfigItems

坐席工作台配置信息。

GetTurnServerList

获取云呼提供的turn服务接入点。

ListPrivilegesOfUser

坐席的权限列表。

GetTurnCredentials

Turn服务的账号密码。

ListDevices

登录的设备信息。

PickOutboundNumbers

自动选择外呼号码。

GetNumberLocation

查询号码归属地。

ListRealtimeAgentStates

查询当前坐席的状态列表（转接功能）。

ListAgentStates

查询当前的坐席列表（监听功能）。

ResetAgentState

重置坐席状态。

ListRecentCallDetailRecords

查询通话记录。

ListSkillGroups

获取技能组，只有admin有权限。

ListBriefSkillGroups

转接的技能组列表。

ListHistoricalAgentReport

获取坐席我的工作数据。

SaveTerminalLog

给服务端上报错误日志。

SignInGroup

技能组登录。

PollUserStatus

轮询获取用户状态。

LaunchAuthentication

核验身份。

ChangeVisibility

切换隐身。

SignOutGroup

退出。

AddBlacklistCallTagging

新增号码黑名单。

AddFeedback

AI数据回流。

AnalyzeConversation

会话分析，生成AI内容。

ListFlashSmsApplications

获取闪信模板运营商列表。

ListFlashSmsTemplates

获取闪信模板列表。

GetIvrTrackingSummary

获取IVR智能分析结果。

话务接口

TakeBreak

小休。

ReadyForService

置空闲。

MakeCall

拨打电话。

AnswerCall

接听电话。

ReleaseCall

挂电话。

HoldCall

通话保持。

RetrieveCall

通话取回。

BlindTransfer

直接转接。

InitiateAttendedTransfer

发起咨询转接。

CompleteAttendedTransfer

咨询转接转移通话。

CancelAttendedTransfer

取消转接。

SendDtmfSignaling

发送DTMF按键。

MonitorCall

发起监听。

BargeInCall

监听状态下强插。

InterceptCall

监听状态下强拆。

Coach

监听状态下辅导。

MuteCall

静音。

UnmuteCall

取消静音。

LaunchSurvey

发送语音满意度。

ChangeWorkMode

切换工作模式。

RedialCall

回拨电话（通过jobId回拨，一般在号码加密的情况下调用）。

状态码

描述

操作

可允许调用的方法

-1

未注册

当前状态只能操作register

register

0

注册中

register

1

离线

上线

logIn, applyForOffSite, forceToPrepareSignIn

2

小休

置空闲，仅外呼，下线

applyForBreak，ready, changeVisibility,

logOut，addSignedSkillGroup

3

空闲

下线、外呼、接听，发起监听，会议

logOut, agentToAgent, call, monitor, applyForBreak, changeVisibility,bargeIn, intercept, coach, startConference，addSignedSkillGroup

4

仅外呼

下线、外呼、接听、发起监听、会议、置空闲

logOut, agentToAgent, call, monitor, applyForBreak，changeVisibility, ready，bargeIn, intercept, coach, startConference，addSignedSkillGroup

5

话后处理

置空闲

logOut, applyForBreak, ready, call, launchShortMessageAppraise, changeVisibility, applyForOffSite，addSignedSkillGroup

6

振铃

接听

answer

7

IM正在工作中

addSignedSkillGroup

8

拨号

挂断

hangUp，sendDtmf

9

呼入通话

挂断

hangUp, callHold, callRetrieve, sendDtmf, muteAgent, unmuteAgent, transferStatisfic, launchAuthentication, thirdCallTransfer, initiateAttendedTransfer

10

呼出通话

挂断

hangUp, callHold, callRetrieve, sendDtmf, muteAgent, unmuteAgent, transferStatisfic, launchAuthentication, thirdCallTransfer, initiateAttendedTransfer

11

内部通话

结束通话

hangUp, callHold, callRetrieve, sendDtmf, muteAgent, umMuteAgent

12

通话保持

取消通话保持

callRetrieve

16

发起三方

通话取回、取消三方通话

thirdCallRetrieve

17

咨询通话

取消咨询通话、咨询通话转移

thirdCallRetrieve, thirdCallTransferFinished, sendDtmf, switchToConference

19

会议

坐席由空闲状态发起会议

hangUp, sendDtmf

20

被动求助

挂断

hangUp

21

监听

挂断

hangUp

24

发起监听，还未监听成功

25

强插，进入三方通话

挂断

hangUp

26

耳语坐席，进入三方通话

挂断

hangUp

30

会议中坐席状态变化

例如有人退出会议，或者有人进入会议

hangUp, transferStatisfic