tencent cloud

文档反馈

座席端 SDK API 文档

最后更新时间: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
    详细说明请参见 座席状态
    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持