本页面演示了如何在你的网站中嵌入 TOFFS HCS 客服聊天组件。
下方提供三种集成方式:iframe 嵌入(推荐)、Script 标签注入,
以及弹窗式 (popout)——宿主自制浮动入口 + 新窗口打开全屏聊天。
左下 / 右下的浮动按钮为 iframe 内嵌效果;右侧金色圆标为弹窗式入口的实际效果。
将聊天组件以 iframe 嵌入页面。组件通过 postMessage 通知父窗口调整 iframe 尺寸,
实现点击按钮展开/收起面板的效果。此方式与宿主页面完全隔离,不会产生样式冲突。
通过一行 script 标签自动创建 iframe 并注入页面,无需手动编写 iframe HTML。 适合希望最小化集成代码的场景。
不在主站加载任何挂件脚本本体:宿主自制一个浮动入口按钮,点击后用
window.open 打开一个全屏独立窗口的聊天页。URL 用干净短链
/chat/<brand_key>(对标 tawk / LiveChat:路径即品牌、隐含 popout)。
适合多品牌 / 多入口共用、或不想在主站注入挂件的场景,与两种 iframe 内嵌方式可并存。
本页左右两个金色圆标即为此效果(左 SIT / 右 UAT)。
URL 形态:https://<域名>/chat/<brand_key>?lang=&mc=。旧写法
/widget.html?brand_key=…&mode=popout 仍向后兼容。弹窗外观(顶部 logo、Home 屏
banner / 促销卡、欢迎语与快捷按钮、主题色)由后台「品牌详情 → Widget 外观 / Home 屏 / 欢迎语」
配置驱动,宿主侧零改动即可换肤。
| 参数 | 说明 | 示例 |
|---|---|---|
src |
TOFFS HCS 服务器的聊天组件地址,即 /widget.html 的完整 URL(需带 key 参数) |
https://aics.toffsdev.com/widget.html?key=... |
key |
Widget 密钥,标识接入的项目 / 站点,并校验跨域来源;从 TOFFS HCS 后台获取 | wVv2zL3R8KnC7s86 |
HCS_BASE |
TOFFS HCS 服务器根地址(方式二中使用),用于校验 postMessage 来源 |
https://aics.toffsdev.com |
| 初始尺寸 | 收起状态 80×80px(仅显示浮动按钮),展开状态 404×584px |
— |
| 字段 | 类型 | 说明 |
|---|---|---|
type |
string |
固定值 "argus-chat-resize" |
width |
string |
iframe 目标宽度,如 "80px" 或 "404px" |
height |
string |
iframe 目标高度,如 "80px" 或 "584px" |
| 环境变量 | 说明 |
|---|---|
CHAT_ENABLED=true |
开启聊天功能(否则 /api/chat/* 路由不可用) |
CORS_ORIGINS |
需包含嵌入页面的域名,如 https://yoursite.com |
TRTC_SDK_APP_ID |
腾讯云 IM (TIM) 的 SDKAppID,用于即时通讯 |
TRTC_SECRET_KEY |
腾讯云 IM 密钥,用于生成 UserSig |