Aily Copilot SDK 接入手册
输入“/”快速插入
Aily Copilot SDK 接入手册
飞书用户5388
飞书用户5929iframe 模式
💡
Iframe 模式下，仅需一个 URL 即可完成接入。
适合在已有 SaaS 系统、网页内快速集成 CUI 会话面板组件，实现同 Aily Bot 的对话。
🚧
访问 CUI 的终端用户，需要具备飞书登录态（并确保在 Aily Bot 的可用范围内），才能发起对话
UI 形态：chatpanel
ChatPanel 是一个 CUI 的会话面板组件，整体类似一个 DIV，宽度和高度都以父节点为准。
参考文档：飞书文档嵌入 Aily Bot
iframe 接入步骤
1.
获取 appkey
2.
拼接 url
URL 规则如下：
•
•
参数规则，参数通过 hash 值以 querystring 的格式拼接到 url 上，目前支持两个参数
◦
appkey：第一步获取到的 appkey
◦
config：所有剩余参数的 base64 码
3.
config 参数详解
config 参数构造示例：
const params = {
conversation: {
userAvatar: "https://s1-imfile.feishucdn.com/static-resource/v1/v3_00ae_73b4091f-35a4-4399-bc41-53d95a2c347g",
initUserMessage: encodeURIComponent('你好')
}
};
const stringParams = JSON.stringify(params);
const configValue = btoa(stringParams);
const iframeHost = 'https://ae.feishu.cn';
const appKey = "<App Key>";
`${iframeHost}/cui#appkey=${appKey}&config=${configValue}`
// 最终访问链接为：
// https://ae.feishu.cn/cui#appkey=xxxxx&config=eyJjb252ZXJzaW9uIjp7InVzZXJBdmF0YXIiOiJodHRwczovL3h4eHh4In19
SDK 模式
💡
SDK 模式提供更友好的开发接入体验，包括更丰富的参数传递、以及支持同宿主站点的深度集成。