Website高级用法指南

最新更新：2025-11-27

website通道支持基于Livedesk Widget SDK 接口进行更多配置，满足用户需求。

设置 Userid 及用户信息（普通模式）

window.addEventListener("livedesk:ready", function () { window.$livedesk.setUser("用户唯一ID（如 user_id）", { // 第一个参数为唯一标识符 email: "user@example.com", name: "用户姓名", avatar_url: "https://example.com/avatar.jpg", // 可选 phone_number: "+1234567890" // 可选 }); });

              
              window.addEventListener("livedesk:ready", function () {
  window.$livedesk.setUser("用户唯一ID（如 user_id）", {  // 第一个参数为唯一标识符
    email: "user@example.com",
    name: "用户姓名",
    avatar_url: "https://example.com/avatar.jpg",  // 可选
    phone_number: "+1234567890"  // 可选
  });
});

このコードブロックはフローティングウィンドウ内に表示されます

设置 Userid 及用户信息（加密模式）

启用身份验证（推荐）：为防止伪造和确保会话跨浏览器持久化，在配置中启用 HMAC（使用 SHA256 生成 identifier_hash）。示例（JavaScript）：

const crypto = require('crypto'); const key = '你的 HMAC Token'; // 从 Inboxes 设置复制 const message = '用户唯一ID'; const identifier_hash = crypto.createHmac('sha256', key).update(message).digest('hex'); // 在 setUser 中附加 window.$livedesk.setUser("用户唯一ID", { ...其他信息, identifier_hash: identifier_hash });

              
              const crypto = require('crypto');
const key = '你的 HMAC Token';  // 从 Inboxes 设置复制
const message = '用户唯一ID';
const identifier_hash = crypto.createHmac('sha256', key).update(message).digest('hex');

// 在 setUser 中附加
window.$livedesk.setUser("用户唯一ID", {
  ...其他信息,
  identifier_hash: identifier_hash
});

このコードブロックはフローティングウィンドウ内に表示されます

设置「对话自定义变量」

window.$livedesk.setConversationCustomAttributes({ utm_source: "google", // 示例：会话级 UTM session_type: "support" });

              
              window.$livedesk.setConversationCustomAttributes({
  utm_source: "google",  // 示例：会话级 UTM
  session_type: "support"
});

このコードブロックはフローティングウィンドウ内に表示されます

这些自定义变量在 livdesk - Conversation - 对话信息中显示。
这些自定义变量将被 GPTBots 接收，若双方的变量名称相匹配，将可被赋值于 GPTBots 系统的自定义变量字段。

设置「用户自定义变量」

window.addEventListener("livedesk:ready", function () { window.$livedesk.setCustomAttributes({ pricing_plan: "premium", // key: 预定义的唯一标识，value: 根据类型设置（如字符串） signup_date: new Date(), // 示例：日期类型 account_id: 123 // 示例：数字类型 }); });

              
              window.addEventListener("livedesk:ready", function () {
  window.$livedesk.setCustomAttributes({
    pricing_plan: "premium",  // key: 预定义的唯一标识，value: 根据类型设置（如字符串）
    signup_date: new Date(),  // 示例：日期类型
    account_id: 123           // 示例：数字类型
  });
});

このコードブロックはフローティングウィンドウ内に表示されます

这些自定义变量在「 livdesk - Conversation - 联系人属性」中显示。
这些自定义变量将被 GPTBots 接收，若双方的变量名称相匹配，将可被赋值于 GPTBots 系统的用户属性字段。

删除用户属性

删除指定的自定义属性。

window.$livedesk.deleteCustomAttribute("pricing_plan");//string属性键名

              
              window.$livedesk.deleteCustomAttribute("pricing_plan");//string属性键名

このコードブロックはフローティングウィンドウ内に表示されます

切换聊天气泡的打开状态

切换小部件的打开/关闭状态。

window.$livdesk.toggle(); // Toggle widget by passing state window.$livedesk.toggle("open"); // 打开聊天部件 window.$livedesk.toggle("close"); // 关闭聊天部件

              
              window.$livdesk.toggle();

// Toggle widget by passing state
window.$livedesk.toggle("open"); // 打开聊天部件
window.$livedesk.toggle("close"); // 关闭聊天部件

このコードブロックはフローティングウィンドウ内に表示されます

显示/隐藏聊天气泡

window.$livedesk.toggleBubbleVisibility('hide');// show/hide

              
              window.$livedesk.toggleBubbleVisibility('hide');// show/hide

このコードブロックはフローティングウィンドウ内に表示されます

弹窗模式

以弹出窗口模式打开聊天界面。

window.$livedesk.popoutChatWindow();

              
              window.$livedesk.popoutChatWindow();

このコードブロックはフローティングウィンドウ内に表示されます

设置语言

设置小部件语言

window.$livedesk.setLocale("en");// string语言代码，示例：zh-CN

              
              window.$livedesk.setLocale("en");// string语言代码，示例：zh-CN

このコードブロックはフローティングウィンドウ内に表示されます

添加/移除标签

为当前会话添加标签（对话未开始前），标签将自动设置到对话中

window.$livdesk.setLabel('support-ticket');// string标签标识符 window.$livdesk.removeLabel('support-ticket');

              
              window.$livdesk.setLabel('support-ticket');// string标签标识符
window.$livdesk.removeLabel('support-ticket');

このコードブロックはフローティングウィンドウ内に表示されます

お問い合わせ