开发者可以通过本服务,将智能体集成在 Web 网页中,并以网页悬浮窗的形式与用户进行交互。
前提条件
在调用本服务前,请先完成应用的发布,若无,请参见:发布应用,完成相关事项。
安装 SDK
开发者可以在 Web 页面中通过 HTML script 标签的形式完成 SDK 的添加,代码示例如下。
<script src="https://gw.alipayobjects.com/render/p/yuyan_npm/@alipay_tbox-web-sdk/1.0.4/dist/index.umd.min.js"></script> <script> const sdkInstance = new TBoxWebSDK.WebChatClient({ config: { agentId: 'xxxxxx' }, }) </script>
参数说明
参数名 |
是否必填 |
类型 |
说明 |
示例 |
agentId |
是 |
String |
应用 ID,需要通过 API 进行集成的应用 ID。获取方式可参见:获取AppID。 |
|
buttonIconUrl |
否 |
String |
自定义智能体在网页展示的悬浮球图标。 |
- |
方法说明
方法名 |
说明 |
示例 |
toggle |
切换显示/隐藏悬浮窗 |
sdkInstance.toggle() |