开发飞书自定义机器人
【https://open.feishu.cn/document/home/develop-a-bot-in-5-minutes/coding】
1.进入飞书开发者后台
2.创建应用
【此处创建企业自建应用】
3.配置凭证与基础信息
①查看应用凭证并记录
②.配置综合信息
机器人的头像
③国际化配置
配置应用名称,描述,地址等信息
4.打开机器人
选择 【应用功能】 - 【机器人】 - 【启用机器人】
5.事件订阅配置-请求地址配置
【注意:需要安装python:通过dos窗口命令进入python安装的路径】
Ⅰ、下载配置
①.Mac/Linux版本
# curl https://sf3-cn.feishucdn.com/obj/open-platform-opendoc/21bdfdf4e65db6b49a6820105d307ef5_TaTqAS74kZ.zip -o robot_quick_start.zip
# unzip robot_quick_start.zip
# cd robot_quick_start/python
②.Windows版本
# curl https://sf3-cn.feishucdn.com/obj/open-platform-opendoc/21bdfdf4e65db6b49a6820105d307ef5_TaTqAS74kZ.zip -o robot_quick_start.zip
# robot_quick_start.zip
# cd robot_quick_start/python
修改环境值,修改 .env 文件中应用凭证数据为真实数据
把下载下来的robot_quick_start.zip包解压到python目录下,并进入 robot_quick_start 中的 python
文件夹下找到 .env 文件,进行编辑添加如下内容:
vim ./.env
APP_ID=cli_9fxxxx00b
APP_SECRET=EX6xxxxOF
VERIFICATION_TOKEN=cq3xxxxxxkUS
ENCRYPT_KEY=
Ⅱ、运行配置
方式1:Docker运行【在运行钱需要确保Docker已经安装】
①.mac/linux版本
sh exec.sh
②.windows版本
.\exec.ps1
方式2:本地运行
创建并激活一个新的虚拟环境
①.mac/linux
python3 -m venv venv
. venv/bin/activate
②.windows
python3 -m venv venv
venv\Scripts\activate
激活后,终端会显示虚拟环境名称
安装相应的依赖:
pip install -r requirements.txt
运行
python server.py
Ⅲ、安装反向代理工具【本地】
机器人接收的消息都会以回调事件请求形式,通过 POST 请求方式,送达到服务端处理。所以本地服务端启动之后,回调事件无法请求到内网,需要配置公网请求 URL。
配置分为如下两步:使用工具完成内网穿透、在应用的事件订阅页面配置公网请求 URL。
1、使用工具暴露本地服务的公网访问入口,此处给出ngrok使用示例,若本地未安装可以访问ngrok,按照教程完成安装 。
【https://ngrok.com/download】
使用以下命令获得公网 URL
注意:①使用反向代理工具(ngrok)之前需要确定是否符合公司网络安全策略;②需要提前在 ngrok 获取token值。
ngrok authtoken <token> // <token>需要替换
ngrok http 3000
此处的token在本地的环境中运行可以不用替换,直接运行ngrok.exe,输入ngrok http 3000即可。
6.为机器人选择监听事件。
在事件订阅页面,点击添加事件,选择 接收消息 事件并订阅。
7.申请权限。
在权限管理页面,搜索需要的权限配置,并开通权限。
依赖权限清单
获取与发送单聊、群组消息
获取用户发给机器人的单聊消息
8.发布&体验机器人
1、点击版本管理与发布,创建版本并发布上线。
点击创建版本,填写发版必须内容,点击保存,完成版本创建。
点击申请发布,应用即时上线生效。
注意:
本次涉及需要审核的权限,可以利用测试企业与人员功能,生成测试版应用(无需发布,配置直接生效),完成测试。
成功发布后,可以根据是否能搜到机器人,判断用户是否在机器人可用性范围内。