Widget SDK

OAIM 网页客服接入文档

把下面这段代码放到商户网站页面底部，即可显示在线客服 Widget。正式接入使用商户后台生成的邀请码，访客来源页面、IP 和设备来源会同步到客服 PC 端。

快速接入

公开演示邀请码是 8888；正式接入时，请到商户后台获取自己的接入代码。

<script
  src="https://oaim.im/static/plug/js/oaim-widget.js?v=9"
  data-invite-code="8888"
  data-title="OAIM 在线客服"
  data-auto-open="1"
  data-auto-open-delay="0"
  data-auto-open-once="1"
  data-position="right"
  defer></script>

建议放在页面底部、</body> 之前。SDK 会自动创建客服浮窗，不需要额外写 HTML。

参数说明

参数	必填	说明	示例
`data-invite-code`	是	商户邀请码，用于识别访客归属。	`8888`
`data-title`	否	Widget 顶部标题；商户后台配置优先同步到访客端。	`OAIM 在线客服`
`data-auto-open`	否	是否自动弹窗，`1` 打开，`0` 关闭。	`1`
`data-auto-open-delay`	否	自动弹窗延迟秒数。	`3`
`data-auto-open-once`	否	访客关闭后，本次浏览会话是否不再自动弹出。	`1`
`data-base-url`	否	Widget 服务地址，默认自动取脚本域名。	`https://oaim.im`
`data-page-url`	否	访客来源页面，默认使用当前页面 URL。	`https://oaim.im/help`
`data-position`	否	浮窗位置，支持 `right` 或 `left`。	`right`

商户配置

商户后台可以配置 Widget 标题、欢迎语和快捷按钮。
支持自动弹窗、延迟弹窗、关闭后本次不再弹出。
支持域名白名单，留空表示不限制；可填写 oaim.im 或 *.oaim.im。
客服 PC 端会显示访客 IP、访问页面、来源域名、设备来源和访问时间。
过期 Widget 访客会被维护任务定时清理。

常见问题

Widget 没弹出来？

先检查接入代码是否放在页面里、邀请码是否正确、当前域名是否在商户后台白名单内。

客服端看不到访问页面？

SDK 会自动上报当前页面地址；如果页面被特殊浏览器策略限制，可在客服端刷新该访客资料后再确认。

能不能只显示浮标，不自动弹窗？

可以，把 data-auto-open 设置为 0，或在商户后台关闭自动弹窗。