tencent cloud

即时通信 IM

动态与公告
产品动态
公告
产品简介
产品概述
基本概念
应用场景
功能介绍
账号系统
用户资料与关系链
消息管理
群组相关
公众号系统
音视频通话 Call
使用限制
购买指南
计费概述
价格说明
购买指引
续费指引
停服说明
退费说明
开发指引
Demo 专区
开通服务
体验 Demo
快速跑通
下载中心
SDK & Demo 源码
更新日志
聊天互动（含 UI）
TUIKit 组件介绍
快速开始
全功能接入
单功能接入
AI 集成
构建基础界面
更多特性
定义外观
国际化界面语言
推送服务（Push）
服务概述
名词解释
开通服务
快速跑通
厂商通道
数据统计
排查工具
客户端 API
服务端 API
推送回调
高级功能
更新日志
错误码
常见问题
智能客服
功能概述
快速入门
集成指引
管理员操作手册
客服操作手册
更多实践
直播间搭建
AI 聊天机器人方案
超大娱乐协作社群
Discord 实现指南
游戏内集成 Chat 指南
类 WhatsApp Channel 搭建方案
发送红包
Chat 应对防火墙限制相关
无 UI 集成
快速开始
集成 SDK
初始化
登录登出
消息相关
会话相关
群组相关
社群话题
用户管理
离线推送
云端搜索
本地搜索
公众号
客户端 API
JavaScript
Android
iOS & macOS
Swift
Flutter
Electron
Unity
React Native
C 接口
C++
服务端 API
生成 UserSig
REST API
第三方回调
控制台指南
新版控制台介绍
创建并升级应用
基本配置
功能配置
账号管理
群组管理
公众号管理
回调配置
用量统计
资源包查看指南
实时监控
开发辅助工具
访问管理
高级功能
常见问题
uni-app 常见问题
购买相关问题
SDK 相关问题
账号鉴权相关问题
用户资料与关系链相关问题
消息相关问题
群组相关问题
直播群相关问题
昵称头像相关问题
协议与认证
服务等级协议
安全合规认证
IM 政策
隐私政策
数据隐私和安全协议
平滑迁移方案
平滑迁移完整版
平滑迁移简化版
错误码
联系我们
文档即时通信 IM智能客服集成指引集成座席端座席端 SDK API 文档

座席端 SDK API 文档

PDF
聚焦模式
字号
最后更新时间： 2024-02-06 09:19:47
注意
TCCC 是加载 SDK 后的全局变量，可直接访问。

通用结构

AgentStatus

座席状态。
字段
描述
free
空闲
busy
忙碌
arrange
话后整理
notReady
示忙
rest
小休

CommonSDKResponse

参数
类型
必填
备注
options
status
'success' |'error'
是
SDK API 调用结果：
成功：返回 success
失败：返回 error
errorMsg
string
否
错误信息，当 status 为 error 时返回

Chat（在线客服相关接口函数）

接听会话

tccc.Chat.accept(options): Promise<CommonSDKResponse>

参数
类型
必填
备注
options
sessionId
String
是
指定会话 ID

结束会话

tccc.Chat.end(options): Promise<CommonSDKResponse>

参数
类型
必填
备注
options
sessionId
String
是
指定会话 ID

转接会话

tccc.Chat.transfer(): Promise<CommonSDKResponse>

参数
类型
必填
备注
options
sessionId
String
是
指定会话 ID
skillGroupId
String
否
转接到指定技能组
userId
String
否
转接到指定座席

Agent（座席状态相关接口函数）

上线

tccc.Agent.online(): void

下线

tccc.Agent.offline(): void

设置座席状态

tccc.Agent.setStatus(optoins): Promise<CommonSDKResponse>

参数
类型
必填
备注
options
status
String
是
座席状态，可选值：
free: 空闲
rest: 小休
arrange: 话后整理
notReady: 示忙
stopNotReady: 停止示忙
restReason
String
否
小休原因

获取座席状态

tccc.Agent.getStatus():AgentStatus

Devices（设备相关接口函数）

检测当前浏览器是否支持

tccc.Devices.isBrowserSupported(): boolean

说明
TCCC Web SDK 支持 Chrome 56、Edge80以上的浏览器。

返回麦克风设备列表

tccc.Devices.getMicrophones(): Promise<MediaDeviceInfo []>

返回扬声器设备列表

tccc.Devices.getSpeakers(): Promise<MediaDeviceInfo []>

UI（用户界面相关接口函数）

隐藏 SDK 所有 UI

tccc.UI.hide(): void

显示 SDK 所有 UI

tccc.UI.show(): void

显示浮动按钮

tccc.UI.showfloatButton(): void

隐藏浮动按钮

tccc.UI.hidefloatButton(): void

显示工作台

tccc.UI.showWorkbench(): void

隐藏工作台

tccc.UI.hideWorkbench(): void

Events（事件）

事件监听

tccc.on(event, callback)

取消事件监听

tccc.off(event, callback)

SDK 初始化完成

tccc.events.ready

当 SDK 初始化完成时触发，此时可安全调用 API。

会话呼入

tccc.events.callIn

会话呼入类型包括：
phone：电话会话
im：在线会话
voip：音频会话
video：视频会话
internal：内线会话

在线会话呼入

参数
类型
必填
备注
options
sessionId
String
是
会话 ID
type
'phone'
是
电话会话类型
timeout
Number
是
会话接入超时时长，0代表不超时
nickname
String
是
用户昵称
avatar
String
否
用户头像
remark
String
否
备注
peerSource
String
否
渠道来源
channelName
String
否
自定义参数
clientData
String
否
用户自定义参数

座席接入会话

tccc.events.userAccessed

参数
类型
必填
备注
options
sessionId
String
是
指定会话 ID

会话超时转接事件

tccc.events.autoTransfer

参数
类型
必填
备注
options
sessionId
String
是
指定会话 ID

会话结束事件

tccc.events.sessionEnded

参数
类型
必填
备注
options
sessionId
String
是
指定会话 ID
closeBy
String
是
表示挂断方：
client：用户挂断
seat：座席挂断
admin：系统挂断
timer：定时器挂断
mainReason
String
否
仅在电话类型，并且挂断方为"admin"时存在，表示挂断原因
subReason
String
否
仅在电话类型，并且挂断方为"admin"时存在，表示挂断的详细原因

会话转接事件

tccc.events.transfer

参数
类型
必填
备注
options
sessionId
String
是
指定会话 ID

座席状态变更事件

tccc.events.statusChanged

参数
类型
必填
备注
options
status
否
详细说明请参见 座席状态

上一篇: 方案二：SDK 集成下一篇: 座席端 SDK 常见问题

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈