前置浏览器环境
客服端浏览器最低兼容版本及下载地址如下:
微软 Edge:88 及以上
谷歌 Chrome:88 及以上
Firefox:78 及以上
Safari:14.1 及以上
集成步骤
前提准备
初始化 AIDeskCore
原理
智能客服提供 JavaScript SDK。Web 前端通过业务服务端获取 SDK URL,并使用该 URL 初始化 AI Desk Core。AI Desk Core 负责加载和初始化原生 SDK、建立连接,同时作为 UI 数据层向 Web 前端提供数据与交互能力。整体集成流程如下:

关键概念
SdkAppId:您开通的智能客服应用 appid,称之为 SdkAppId,通常为160开头。
UserID :客服或管理员在智能客服内配置的账号,通常为邮箱格式,管理员参考《成员管理》添加客服账号。
SecretId 和 SecretKey:开发者调用云 API 所需凭证,通过 腾讯云控制台 创建。
SDKURL:初始化 Web SDK 时的 JS URL,通过云 API 创建,该 URL 有效时长为10分钟,请确保只使用一次,在需要初始化 SDK 时请求创建,SDK 初始化成功后无需重复创建。
步骤1:获取必备参数
1. 获取腾讯云账号的
SecretId 和 SecretKey,可参见 获取密钥。2. 获取智能客服应用的 SdkAppId,在 控制台 > 智能客服 页面,单击前往管理端。


3. 在跳转过去的页面 URL 上,可以找到160开头的数字,这串数字就是智能客服应用的 SdkAppId。


4. 在管理端的团队管理-成员中可以获取客服的 UserID 用于获取 SDKURL


步骤2:获取 SDKURL
说明:
该步骤需要接入方后台开发实现。
1. 引入 tencentcloud-sdk,引入方式可参见 SDK 中心 对应语言。
2. 调用接口 CreateSDKLoginToken。
3. 将获取到的 Token 返回给接入方前端。
下文将使用接口名称
/loginTCCC 来说明该步骤开发的接口。// tencentcloud-sdk-nodejs的版本要求大于或等于4.0.3const tencentcloud = require('tencentcloud-sdk-nodejs');const express = require('express');const app = express();const CccClient = tencentcloud.ccc.v20200210.Client;app.use('/getToken', (req, res) => {const clientConfig = {// secret获取地址: https://console.cloud.tencent.com/cam/capicredential: {secretId: 'SecretId',secretKey: 'SecretKey'},region: '',profile: {httpProfile: {endpoint: 'ccc.tencentcloudapi.com'}}};const client = new CccClient(clientConfig);const params = {SdkAppId: 1600000000, // 请替换为自己的 SdkAppIdSeatUserId: 'xxx@qq.com' // 替换为座席账号};client.CreateSDKLoginToken(params).then((data) => {res.send({token: data.Token})},(err) => {console.error('error', err);res.status(500);});})
步骤3:在 Web 前端获取 Token 并接入 SDK 完成初始化
说明:
该步骤需要接入方前端开发进行。
1. 引入 @tencentcloud/ai-desk-core
npm i @tencentcloud/ai-desk-core@latest
2. 请求第二步实现的
/loginTCCC 接口,得到 sdkUrl。3. 将 sdkUrl 作为 AIDeskCore 的初始化参数传入。
4. 在 init 执行成功后,执行业务逻辑。
import AIDeskCoreInstance from '@tencentcloud/ai-desk-core';await AIDeskCoreInstance.init(sdkUrl);console.log('初始化成功')
说明:
AIDeskCore 在执行 init 成功之后客服会自动上线。
API 说明
AIDeskCore 初始化
使用 URL 初始化 AIDeskCore。AIDeskCore 负责加载和初始化原生 SDK、建立连接,同时作为 UI 数据层向 Web 前端提供数据与交互能力。
接口
AIDeskCoreInstance.init(SDKURL);
参数
参数 SDKURL 为 string 类型
返回值
无
示例
import AIDeskCoreInstance from '@tencentcloud/ai-desk-core';AIDeskCoreInstance.init(SDKURL);
AIDeskCore 销毁
如果需要切换用户或不使用 AIDeskCore 时,可调用销毁 API 释放内存。
接口
AIDeskCoreInstance.destroy();
参数
无
返回值
无
示例
import AIDeskCoreInstance from '@tencentcloud/ai-desk-core';AIDeskCoreInstance.destroy();