WECHATY PUPPET LARK (飞书)

运行方法

安装依赖

将代码clone到本地，执行npm install

在飞书开放平台申请权限

1. 打开飞书开放平台的后台，以申请机器人权限。飞书开放平台

2. 创建应用，应用名称为wechaty-puppet-lark(当然你也可以起任何名字)

3. 在应用功能栏，点击启用机器人

配置系统环境变量

1. WECHATY_PUPPET_LARK_APPID：飞书应用的App ID

2. WECHATY_PUPPET_LARK_APPSECRET：飞书应用的App Secret

3. WECHATY_PUPPET_LARK_TOKEN：飞书事件订阅平台提供的Verification Token

运行示例代码

ts-node .\examples\ding-dong-bot.ts

添加事件订阅URL

当示例代码运行成功后，会出现一行URL。

将URL填入事件订阅的请求网址 URL即可。

使用机器人

在飞书中搜索机器人的名字，比如wechaty-puppet-lark。

对机器人发送ding，机器人回复dong则证明运行成功。

若运行不成功，则返回检查设置是否正确。

Getting Started with Wechaty

export WECHATY_PUPPET=wechaty-puppet-lark
npm start

Learn more for building your first Wechaty bot at https://github.com/wechaty/wechaty-getting-started

项目介绍

“开源软件供应链点亮计划-暑期2020”（以下简称暑期2020）是由中科院软件所与 openEuler 社区共同举办的一项面向高校学生的暑期活动。旨在鼓励在校学生积极参与开源软件的开发维护，促进国内优秀开源软件社区的蓬勃发展。

根据项目的难易程度和完成情况，参与者还可获取“开源软件供应链点亮计划-暑期2020”活动奖金和奖杯。 官网：Summer2020 官方新闻：News

本项目 [基于开放 API 封装 Wechaty 接口下的飞书聊天机器人] 系 暑期2020 支持的开源项目。

• 导师：高原 吴京京
• 学生：范蕊
• 模块列表
  • 接收消息
  • 通讯录获取
  • 实现 puppet 上各个类型的消息接口
  • 设计配置参数
  • 使用文档
• 计划安排：
  • 阅读源代码
    • 7.29 - 7.31
    • 阅读 wechaty 源代码
    • 学习飞书服务端 API
    • 整理需要实现的 puppet list
  • 接收消息
    • 8.1 - 8.5
    • 通过飞书订阅消息事件实现消息接收
  • 通讯录获取
    • 8.6 - 8.10
    • 通过飞书订阅通讯录事件实现通讯录更新信息的接收
  • 实现 puppet 上各个类型的消息接口
    • 8.10 - 8.30
    • 对接飞书接口, 实现各个类型的消息接口
    • 消息类型包括: 文字, 图片, 富文本, 群名片
  • 设计配置参数
    • 8.31 - 9.7
  • 使用文档
    • 9.8 - 9.12
  • 项目完善
    • 9.12 - 9.30
    • 代码重构
• 项目链接：https://github.com/Roxanne718/wechaty-puppet-lark
• 联系方式：+86 17822015718 | email: 953299708@qq.com

相关链接

• 飞书开放平台
• Wechaty
• Express
• TypeScripts中文手册

History

master

v0.4 (Feb 10, 2021)

1. Fix linting
2. Clean & Upgrade dependencies
3. Fix CI/CD

v0.3 (Oct 2020)

1. Move Repo to Wechaty Organization
2. Blog: 基于开放 API 封装 Wechaty 接口下的飞书聊天机器人：期末

v0.0.1 (Jul 29, 2020)

1. Init version.
2. Blog: 基于开放 API 封装 Wechaty 接口下的飞书聊天机器人：期初

Author

Fairy FAN (范蕊), study NAS (Neural Architecture Search) in Nankai University

Maintainer

• Huan LI (李卓桓), Tencent TVP of Chatbot, <zixia@zixia.net>

Copyright & License

• Code & Docs © 2020-2021 Fairy FAN and Wechaty Contributors
• Code released under the Apache-2.0 License
• Docs released under Creative Commons