{"id":15013995,"url":"https://github.com/wechaty/puppet-lark","last_synced_at":"2025-04-12T05:53:28.375Z","repository":{"id":46769624,"uuid":"283367229","full_name":"wechaty/puppet-lark","owner":"wechaty","description":"Wechaty Puppet for Lark","archived":false,"fork":false,"pushed_at":"2021-09-27T06:39:17.000Z","size":150,"stargazers_count":23,"open_issues_count":4,"forks_count":13,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-12T05:53:22.641Z","etag":null,"topics":["lark","puppet","wechaty"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/wechaty-puppet-lark","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wechaty.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-29T01:26:22.000Z","updated_at":"2024-07-21T10:46:20.000Z","dependencies_parsed_at":"2022-08-27T13:03:29.928Z","dependency_job_id":null,"html_url":"https://github.com/wechaty/puppet-lark","commit_stats":null,"previous_names":["wechaty/wechaty-puppet-lark"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpuppet-lark","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpuppet-lark/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpuppet-lark/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fpuppet-lark/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wechaty","download_url":"https://codeload.github.com/wechaty/puppet-lark/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248525156,"owners_count":21118616,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lark","puppet","wechaty"],"created_at":"2024-09-24T19:45:02.688Z","updated_at":"2025-04-12T05:53:28.345Z","avatar_url":"https://github.com/wechaty.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WECHATY PUPPET LARK (飞书)\n\n[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-brightgreen.svg)](https://wechaty.js.org)\n\n[![NPM Version](https://badge.fury.io/js/wechaty-puppet-lark.svg)](https://badge.fury.io/js/wechaty-puppet-lark)\n[![npm (tag)](https://img.shields.io/npm/v/wechaty-puppet-lark/next.svg)](https://www.npmjs.com/package/wechaty-puppet-lark?activeTab=versions)\n\n## 运行方法\n\n### 安装依赖\n\n将代码clone到本地，执行`npm install`\n\n### 在飞书开放平台申请权限\n\n1. 打开飞书开放平台的后台，以申请机器人权限。[飞书开放平台](https://open.feishu.cn/app)\n\n2. 创建应用，应用名称为`wechaty-puppet-lark`(当然你也可以起任何名字)\n\n3. 在应用功能栏，点击启用机器人\n\n### 配置系统环境变量\n\n1. `WECHATY_PUPPET_LARK_APPID`：飞书应用的App ID\n\n2. `WECHATY_PUPPET_LARK_APPSECRET`：飞书应用的App Secret\n\n3. `WECHATY_PUPPET_LARK_TOKEN`：飞书事件订阅平台提供的Verification Token\n\n### 运行示例代码\n\n`ts-node .\\examples\\ding-dong-bot.ts`\n\n### 添加事件订阅URL\n\n当示例代码运行成功后，会出现一行URL。\n\n将URL填入`事件订阅`的`请求网址 URL`即可。\n\n### 使用机器人\n\n在飞书中搜索机器人的名字，比如`wechaty-puppet-lark`。\n\n对机器人发送`ding`，机器人回复`dong`则证明运行成功。\n\n若运行不成功，则返回检查设置是否正确。\n\n## Getting Started with Wechaty\n\n```sh\nexport WECHATY_PUPPET=wechaty-puppet-lark\nnpm start\n```\n\nLearn more for building your first Wechaty bot at \u003chttps://github.com/wechaty/wechaty-getting-started\u003e\n\n## 项目介绍\n\n“开源软件供应链点亮计划-暑期2020”（以下简称暑期2020）是由中科院软件所与 openEuler 社区共同举办的一项面向高校学生的暑期活动。旨在鼓励在校学生积极参与开源软件的开发维护，促进国内优秀开源软件社区的蓬勃发展。\n\n根据项目的难易程度和完成情况，参与者还可获取“开源软件供应链点亮计划-暑期2020”活动奖金和奖杯。\n官网：[Summer2020](https://isrc.iscas.ac.cn/summer2020) 官方新闻：[News](http://www.iscas.ac.cn/xshd2016/xshy2016/202004/t20200426_5563484.html)\n\n本项目 [基于开放 API 封装 Wechaty 接口下的飞书聊天机器人] 系 暑期2020 支持的开源项目。\n\n- 导师：高原 吴京京\n- 学生：范蕊\n- 模块列表\n  - [x] 接收消息\n  - [x] 通讯录获取\n  - [x] 实现 puppet 上各个类型的消息接口\n  - [ ] 设计配置参数\n  - [x] 使用文档\n- 计划安排：\n  - 阅读源代码\n    - 7.29 - 7.31\n    - 阅读 wechaty 源代码\n    - 学习飞书服务端 API\n    - 整理需要实现的 puppet list\n  - 接收消息\n    - 8.1 - 8.5\n    - 通过飞书订阅消息事件实现消息接收\n  - 通讯录获取\n    - 8.6 - 8.10\n    - 通过飞书订阅通讯录事件实现通讯录更新信息的接收\n  - 实现 puppet 上各个类型的消息接口\n    - 8.10 - 8.30\n    - 对接飞书接口, 实现各个类型的消息接口\n    - 消息类型包括: 文字, 图片, 富文本, 群名片\n  - 设计配置参数\n    - 8.31 - 9.7\n  - 使用文档\n    - 9.8 - 9.12\n  - 项目完善\n    - 9.12 - 9.30\n    - 代码重构\n- 项目链接：[https://github.com/Roxanne718/wechaty-puppet-lark](https://github.com/Roxanne718/wechaty-puppet-lark)\n- 联系方式：+86 17822015718 | email: 953299708@qq.com\n\n## 相关链接\n\n- [飞书开放平台](https://open.feishu.cn/document/ukTMukTMukTM/uUTNz4SN1MjL1UzM)\n- [Wechaty](https://wechaty.js.org/v/zh/)\n- [Express](https://www.runoob.com/nodejs/nodejs-express-framework.html)\n- [TypeScripts中文手册](https://www.tslang.cn/docs/handbook/basic-types.html)\n\n## History\n\n### master\n\n### v0.4 (Feb 10, 2021)\n\n1. Fix linting\n1. Clean \u0026 Upgrade dependencies\n1. Fix CI/CD\n\n### v0.3 (Oct 2020)\n\n1. Move Repo to Wechaty Organization\n1. Blog: [基于开放 API 封装 Wechaty 接口下的飞书聊天机器人：期末](https://wechaty.js.org/2020/09/30/wechaty-puppet-lark-final-blog/)\n\n### v0.0.1 (Jul 29, 2020)\n\n1. Init version.\n1. Blog: [基于开放 API 封装 Wechaty 接口下的飞书聊天机器人：期初](https://wechaty.js.org/2020/07/29/wechaty-puppet-lark-plan-blog/)\n\n## Author\n\n[Fairy FAN](https://github.com/Roxanne718) (范蕊), study NAS (Neural Architecture Search) in Nankai University\n\n## Maintainer\n\n- [Huan LI](https://github.com/huan) ([李卓桓](http://linkedin.com/in/zixia)), Tencent TVP of Chatbot, \\\u003czixia@zixia.net\\\u003e\n\n## Copyright \u0026 License\n\n- Code \u0026 Docs © 2020-2021 Fairy FAN and Wechaty Contributors\n- Code released under the Apache-2.0 License\n- Docs released under Creative Commons\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechaty%2Fpuppet-lark","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwechaty%2Fpuppet-lark","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechaty%2Fpuppet-lark/lists"}