飞书智能伙伴Aily的对外共享功能帮助文档

飞书智能伙伴Aily的对外共享功能帮助文档

智能伙伴Aily手册精选NaN-NaN-NaN
产品功能
功能概述
Aily对外共享功能,支持开发者通过简单的发布配置将自己搭建的Aily应用分享给外部飞书用户使用。外部飞书用户无需去切换飞书租户,申请确认后即可访问应用,快速展开对话。
能力边界
本期仅支持部分技能允许外部用户使用,包括知识问答、数据表等能力,飞书OpenAPI能力受限使用
能力边界
能力简介
能力说明
支持✅
支持将开启对外共享的应用加入外部群
如果应用开启对外共享后,开发者可以在外部群中的添加机器人入口,搜索到机器人,并且添加到外部群
支持飞书消息和群组相关能力,能够在外部群与bot会话
开启对外共享并通过审批后,会自动开通消息和群组允许在外部群使用的权限点,开发者无需额外申请
支持用户与对外共享的应用单聊
开启对话后即可与应用进行单聊
支持Aily内置飞书能力
数据更新、数据分析等
知识问答
导入和直连的模式定义,是在知识问答板块连接数据时的区别
  • 导入:将数据导入到aily里来处理,需要做数据同步,可能存是延时,但效果更好
  • 直连:数据存在上游业务中,数据及时感知变化,效果通常会有折损。
  • 本地文档支持跨租户召回
  • 飞书云文档
  • 导入模式:支持跨租户召回
  • 直连模式:对于提问用户点击过的文档支持召回,未点击则不支持召回
详情请查看连接知识并开始问答
支持通过tenant_access_token+应用身份调用Aily业务域的接口
不支持❌
选择飞书用户授权调用飞书OpenAPI
250px|700px|reset
250px|700px|reset
选择飞书应用授权但是涉及外部用户的openid
250px|700px|reset
250px|700px|reset
如何操作
开发者无需新建应用,在原有应用基础上开启对外共享重新发布后,即可实现。具体需要以下四个步骤。
250px|700px|reset
步骤一:开启对外共享
开发者进入飞书智能伙伴创建平台,进入应用开发页面,准备去发布应用。对于新版Aily应用和存量应用,发布配置体验会有所不同。请先判断自身应用是新版Aily应用还是历史版本应用,遵循分别的发布操作步骤即可。如何判断请按照下图说明:
情况一:新版Aily应用
如果你看到的应用创建&应用管理交互体验如右侧截图所示,则是是新版Aily应用
250px|700px|reset
创建交互体验
250px|700px|reset
应用管理交互
情况二:历史版本Aily应用
如果你看到的应用管理交互体验如右侧截图所示,则是是历史Aily应用
250px|700px|reset
应用管理交互
情况一:新版Aily应用
  1. 当应用创建后但仍然未发布,则可以通过首次发布来开启对外共享、支持使用应用身份调用 API 和 SDK,审批通过后即可开启对外共享,开启成功的应用在主页面会带有外部标签。
250px|700px|reset
image.png
250px|700px|reset
image.png
250px|700px|reset
image.png
250px|700px|reset
image.png
  1. 当应用已经发布了,想要为应用开启对外共享、支持使用应用身份调用 API 和 SDK,则需要访问用户与渠道菜单进行配置。区别是,开启和关闭对外共享需要经过发布审批,但支持使用应用身份调用 API 和 SDK的配置无需审批,修改后即可生效。
  1. 如需打开对外共享:访问用户管理-->可用范围页面,可以看到外部用户开关是关闭状态,点击开启,可用范围即可进入编辑态(待提交未生效),页面会有相关提醒,点击Tag:修改需申请通过后生效,或者点击前往配置,即可进入可用范围变更申请页;填写申请理由并且提交申请后,会进入修改待审批页,点击Tag:修改待审批中,即可打开当前申请单,在该页面用户可以复制审批链接,也可以撤回申请,申请撤回会回到修改需申请通过后生效状态,用户可以继续修改可用范围申请再提交;审批通过后,对外共享即可开启。
250px|700px|reset
image.png
250px|700px|reset
image.png
250px|700px|reset
image.png
250px|700px|reset
image.png
  1. 如需打开支持使用应用身份调用 API 和 SDK:访问渠道管理菜单,在开放能力模块,勾选支持使用应用身份调用 API 和 SDK,勾选后即可立即生效。可以在postman中,验证使用tenant access token调用aily接口是否可以成功。
250px|700px|reset
image.png
250px|700px|reset
image.png
勾选支持使用应用身份调用 API 和 SDK
示例:postman验证
情况二:历史版本Aily应用
开发者进入到应用开发态,点击发布进入发布页面,开启对外共享并且通过审批后,应用即可对外共享。开启成功的应用在主页面会带有对外标签。建议同步开启默认角色为全部权限角色,否则可能会出现技能无法使用的问题。如果你需要使用tenant access token方式调用飞书智能伙伴创建平台提供的OpenAPI接口,请勾选支持使用应用身份调用 API 和 SDK后即可,关于接口调用相关的详细信息请查看OpenAPI 接入与接口说明
250px|700px|reset
image.png
250px|700px|reset
image.png
250px|700px|reset
image.png
250px|700px|reset
image.png
步骤二:机器人进外部群
开发者可以创建外部群或者在已经加入的外部群中添加机器人,机器人列表中可以搜索到允许对外共享的机器人,即可添加进群。开发者仅能将本租户应用添加到外部群。
250px|700px|reset
image.png
250px|700px|reset
image.png
250px|700px|reset
image.png
步骤三:配置技能权限
为了方便外部用户能够流畅使用技能,建议开发者在发布的时候配置默认角色为全部技能权限。如果你有更细粒度的管控诉求,也可以在运维后台配置角色权限,支持按照人员、按照外部群、按照规则(用户.类型==外部用户)来指定外部用户角色。另外,API调用如果开启了支持使用应用身份调用 API 和 SDK又希望可以对允许调用的技能做权限控制,可以按照规则(用户.类型==匿名用户)指定API调用模式下允许调用的技能。
250px|700px|reset
image.png
250px|700px|reset
image.png
250px|700px|reset
image.png
历史版本Aily应用
新版本Aily应用
250px|700px|reset
image.png
250px|700px|reset
image.png
历史版本Aily应用
历史版本Aily应用
步骤四:用户确认并会话
外部用户加入外部群后,可以直接与允许对外共享的应用对话,应用回复方式取决于机器人回复设置。用户也可以通过开启对话单聊对外共享的应用。
250px|700px|reset
image.png
250px|700px|reset
image.png
回复时机设置
群聊
250px|700px|reset
image.png
250px|700px|reset
image.png
开启对话(单聊)
单聊
步骤五:查看已加入应用的用户并且进行用户管理
情况一:新版Aily应用
访问用户管理-->可用范围页面,如果已经开启了对外共享,即可看到已经加入应用可用范围的外部用户。点击配置即对外部用户进行管理,支持移除外部用户、停用外部用户。
对于外部用户可用范围的修改需要经过发布审批,确认调整后,页面会有相关提醒,点击Tag:修改需申请通过后生效,或者点击前往配置,即可进入可用范围变更申请页;填写申请理由并且提交申请后,会进入修改待审批页,审批通过后,对外共享即可开启。
外部用户移除后,单聊会被禁止,外部用户需要再通过开启对话后才能继续进行单聊。
外部用户停用后,对话会被禁止,需要管理员取消停用才能继续进行对话。
Note:这里展示的外部用户是能进行单聊的外部用户,不包括群内可与应用对话的用户。实际可以bot对话的用户,包括群里内的用户和能够单聊的用户。
250px|700px|reset
image.png
250px|700px|reset
image.png
外部用户管理
外部用户管理
250px|700px|reset
image.png
250px|700px|reset
image.png
250px|700px|reset
image.png
修改外部用户可用范围
修改外部用户可用范围
修改外部用户可用范围
250px|700px|reset
image.png
250px|700px|reset
image.png
250px|700px|reset
image.png
移除后
移除后再次加入单聊
账号停用
情况二:历史版本Aily应用
如果需要移除外部用户,则需要进行应用发布页面,在发布页面中配置外部用户,支持移除外部用户。发布审批通过后即可生效。
访问终端用户访问授权-->应用访问管理页面,如果已经开启了对外共享,即可看到已经加入应用可用范围的外部用户。在当前管理页面仅支持禁用/取消禁用外部用户。
移除用户、禁用用户的用户侧表现与新版Aily应用无差异。
外部用户移除后,单聊会被禁止,外部用户需要再通过开启对话后才能继续进行单聊。
外部用户停用后,对话会被禁止,需要管理员取消停用才能继续进行对话。
250px|700px|reset
image.png
250px|700px|reset
image.png
250px|700px|reset
image.png
250px|700px|reset
image.png
先进生产力和业务协同平台
联系我们立即试用

先进团队,先用飞书

欢迎联系我们,飞书效能顾问将为您提供全力支持
分享先进工作方式
输送行业最佳实践
全面协助组织提效
联系我们立即试用