SDK 接入指南

只需一行代码,即可为您的网站添加智能客服能力。支持三种接入模式,零依赖、开箱即用。

1
引入 SDK 脚本
2
调用 XmIM.init() 配置参数
3
完成!客服功能自动就绪
💬

方式一:悬浮客服图标

页面右下角显示客服按钮,用户点击后打开聊天窗口

最常用的接入方式,适合电商、SaaS 后台、企业官网等任何页面。用户按需点击,不打扰浏览。

HTML
<!-- 1. 引入 SDK -->
<script src="https://im.aibotcenter.cn/sdk/xm-im-sdk.js"></script>

<!-- 2. 初始化 -->
<script>
  XmIM.init({
    server:    'https://im.aibotcenter.cn/api/admin',
    entryCode: 'YOUR_ENTRY_CODE',  // IM 入口管理中的入口编码(GUID)
    mode:      'fab'   // 悬浮按钮模式
  });
</script>
🔔

方式二:主动弹窗问候

页面加载后自动弹出聊天窗口,AI 主动向客户打招呼

适合营销落地页、活动页、促销页面。自动弹出 + AI 问候,提升转化率。可通过 popupDelay 控制弹出延时。

HTML
<!-- 1. 引入 SDK -->
<script src="https://im.aibotcenter.cn/sdk/xm-im-sdk.js"></script>

<!-- 2. 初始化 -->
<script>
  XmIM.init({
    server:     'https://im.aibotcenter.cn/api/admin',
    entryCode:  'YOUR_ENTRY_CODE',
    mode:       'auto-popup',  // 自动弹窗模式
    popupDelay: 3000,          // 3 秒后弹出
    // greeting 可选;未传则使用入口管理后台配置的欢迎语
    greeting:   '欢迎光临!有什么可以帮您的吗?'
  });
</script>

方式三:编程调用

隐藏默认 UI,通过 JS API 手动控制客服窗口的打开/关闭

适合需要深度定制的场景:自定义触发按钮、根据业务逻辑判断是否显示、集成到已有系统等。

HTML
<!-- 1. 引入 SDK -->
<script src="https://im.aibotcenter.cn/sdk/xm-im-sdk.js"></script>

<!-- 2. 初始化(隐藏模式,不显示默认 FAB) -->
<script>
  XmIM.init({
    server:    'https://im.aibotcenter.cn/api/admin',
    entryCode: 'YOUR_ENTRY_CODE',
    mode:      'hidden'   // 隐藏模式
  });
</script>

<!-- 3. 通过自定义按钮触发 -->
<button onclick="XmIM.open()">联系客服</button>

<!-- 也可在 JS 中手动控制 -->
<script>
  // 打开聊天窗口
  XmIM.open();

  // 关闭聊天窗口
  XmIM.close();

  // 销毁实例,清理所有 DOM 和连接
  XmIM.destroy();
</script>
📖

完整配置项

XmIM.init(options) 支持的全部参数
参数 类型 默认值 说明
server string API 服务地址(必填),如 https://im.aibotcenter.cn/api/admin
entryCode string 'default' 客服入口编码(必填,来自 IM 入口管理,保存后自动生成的 GUID)
tenantId string 租户 ID(可选;不传时由 entryCode 自动解析)
mode string 'fab' 'fab' 悬浮按钮 | 'auto-popup' 自动弹窗 | 'hidden' 隐藏
popupDelay number 3000 auto-popup 模式下弹出延时(毫秒)
greeting string 内置默认 首屏问候语;init 传入则优先于入口管理后台的欢迎语
quickActions array 4 个默认快捷 快捷回复按钮,每项 { icon, label, text }
theme.primary string '#2563eb' 主题色
theme.title string '星敏智能客服' 聊天窗口标题
position string 'right' 'right' 右下角 | 'left' 左下角
zIndex number 99990 组件层级
🔧

JS API

可在任何时候调用这些方法控制客服组件
方法 说明
XmIM.init(options) 初始化 SDK,注入 DOM 和样式,根据 mode 自动启动
XmIM.open() 打开聊天窗口并播放问候动画
XmIM.close() 关闭聊天窗口并断开连接
XmIM.destroy() 销毁实例,移除所有 DOM 元素和事件,释放资源
🎨

进阶示例:自定义主题 + 快捷操作

完全自定义外观和行为
HTML
<script src="https://im.aibotcenter.cn/sdk/xm-im-sdk.js"></script>
<script>
  XmIM.init({
    server:    'https://im.aibotcenter.cn/api/admin',
    entryCode: 'YOUR_ENTRY_CODE',
    mode:      'fab',
    position: 'left',       // 左下角显示
    greeting: 'Hi!需要什么帮助吗?',

    // 自定义主题
    theme: {
      primary: '#2563eb',   // 蓝色主题
      title:   '在线顾问'
    },

    // 自定义快捷操作
    quickActions: [
      { icon: '🛒', label: '购物咨询', text: '我想咨询购物相关问题' },
      { icon: '🔄', label: '退换货',   text: '我想退换货' },
      { icon: '📱', label: '技术支持', text: '我需要技术支持' }
    ]
  });
</script>