1 Star 0 Fork 0

xuyan2680 / h5app-cool-app-demo

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README

酷应用示例demo

  • 此demo展示了酷应用的应用场景,包括群机器人、消息卡片、群应用入口等。
  • 项目结构
    • backend:后端模块,springboot构建,接口功能包括:接收机器人回调、发送消息卡片等功能。
    • frontend:前端模块,react构建,场景功能包括:构建使用场景、公告、日程表单等。

研发环境准备

  1. 需要有一个钉钉注册企业,如果没有可以创建:https://oa.dingtalk.com/register_new.htm#/

  2. 成为钉钉开发者,参考文档:https://developers.dingtalk.com/document/app/become-a-dingtalk-developer

  3. 登录钉钉开放平台后台创建一个H5应用: https://open-dev.dingtalk.com/#/index

  4. 配置应用

    配置开发管理,参考文档:https://developers.dingtalk.com/document/app/configure-orgapp

image-20210706171740868

配置相关权限:https://developers.dingtalk.com/document/app/address-book-permissions

本demo使用接口相关权限:

  • 成员信息读权限
  • chat相关接口的管理权限
  • chat相关接口的读取权限

image-20210706172027870

酷应用相关配置:(必要步骤)

在以下配置中,我们需要使用此应用的首页地址,应用首页地址配置参考文档:https://developers.dingtalk.com/document/app/configure-orgapp

接下来以首页地址为:"http://dingtalkcool.vaiwan.cn" 进行举例

  1. 配置群机器人,参考文档:https://open.dingtalk.com/document/org/configure-push-settings

    图标和名称可自行定义,消息接收地址参考下方

  2. 配置群应用和群入口,参考文档:https://open.dingtalk.com/document/org/configure-the-basic-information-of-the-group-application

    此应用需配置两个群入口:小酷公告、小酷日程。头像和名称可自行定义,链接配置请参考下方

小酷公告:

- 移动端地址:
dingtalk://dingtalkclient/action/im_open_hybrid_panel?panelHeight=percent60&hybridType=online&pageUrl={URL编码后的首页地址}%2F%23%2FAnnouncement%2F$DOUBLE_ENCCID$
- 示例:
dingtalk://dingtalkclient/action/im_open_hybrid_panel?panelHeight=percent60&hybridType=online&pageUrl=http%3A%2F%2Fdingtalkcool.vaiwan.cn%2F%23%2FAnnouncement%2F$DOUBLE_ENCCID$
- 桌面端地址:
dingtalk://dingtalkclient/page/link?url={URL编码后的首页地址}%2F%23%2FAnnouncement%2F$DOUBLE_ENCCID$&pc_slide=true
- 示例:
dingtalk://dingtalkclient/page/link?url=http%3A%2F%2Fdingtalkcool.vaiwan.cn%2F%23%2FAnnouncement%2F$DOUBLE_ENCCID$&pc_slide=true

小酷日程:

- 移动端地址:
dingtalk://dingtalkclient/action/im_open_hybrid_panel?panelHeight=percent60&hybridType=online&pageUrl={URL编码后的首页地址}%2F%23%2FSchedule%2F$DOUBLE_ENCCID$
- 示例:
dingtalk://dingtalkclient/action/im_open_hybrid_panel?panelHeight=percent60&hybridType=online&pageUrl=http%3A%2F%2Fdingtalkcool.vaiwan.cn%2F%23%2FSchedule%2F$DOUBLE_ENCCID$
- 桌面端地址:
dingtalk://dingtalkclient/page/link?url={URL编码后的首页地址}%2F%23%2FSchedule%2F$DOUBLE_ENCCID$&pc_slide=true
- 示例:
dingtalk://dingtalkclient/page/link?url=http%3A%2F%2Fdingtalkcool.vaiwan.cn%2F%23%2FSchedule%2F$DOUBLE_ENCCID$&pc_slide=true

以上链接的配置原理,请查看群相关跳转协议,参考文档:https://open.dingtalk.com/document/org/group-related-redirection-protocol

  1. 启动群应用,参考文档::https://open.dingtalk.com/document/org/install-group-applications

  2. 在群内添加应用入口后启动应用,然后@机器人一次,完成初始化。

脚本启动(推荐)

脚本说明

脚本中内置了内网穿透工具,不需要再额外启动

dingBoot-linux.sh     # linux版本
dingBoot-mac.sh       # mac版本
dingBoot-windows.bat  # windows版本

启动命令

执行时将其中参数替换为对应的应用参数,在backend目录下执行(脚本同级目录),参数获取方法:

  1. 获取corpId——开发者后台首页:https://open-dev.dingtalk.com/#/index
  2. 进入应用开发-企业内部开发-点击进入应用-基础信息-获取appKey、appSecret、agentId
  • 启动linux脚本
./dingBoot-linux.sh start {项目名} {端口号} {appKey} {appSecret} {agentId} {corpId}
  • mac系统(mac m1芯片暂不支持)
./dingBoot-mac.sh start {项目名} {端口号} {appKey} {appSecret} {agentId} {corpId}
  • windows系统 使用cmd命令行启动
./dingBoot-windows.bat {项目名} {端口号} {appKey} {appSecret} {agentId} {corpId}
  • 示例(linux脚本执行)
 ./dingBoot-linux.sh start h5-demo 8080 ding1jmkwa4o19bxxxx ua2qNVhleIx14ld6xgoZqtg84EE94sbizRvCimfXrIqYCeyj7b8QvqYxxx 122549400 ding9f50b15bccd1000

启动后配置

  1. 配置地址

启动完成会自动生成临时域名,配置方法:进入开发者后台->进入应用->开发管理->应用首页地址和PC端首页地址

  1. 发布应用

配置好地址后进入“版本管理与发布页面”,发布应用,发布后即可在PC钉钉或移动钉钉工作台访问应用

手动启动

下载本项目至本地

git clone https://github.com/open-dingtalk/h5app-cool-app-demo.git

获取相应参数

获取到以下参数,修改后端application.yaml

app:
  app_key: *****
  app_secret: *****
  agent_id: *****
  corp_id: *****

参数获取方法:登录开发者后台

  1. 获取corpId:https://open-dev.dingtalk.com/#/index
  2. 进入应用开发-企业内部开发-点击进入应用-基础信息-获取appKey、appSecret、agentId

修改前端页面

打开项目,命令行中执行以下命令,编译打包生成build文件

cd front-end
npm install
npm run build

将打包好的静态资源文件放入后端

image-20210706173224172

启动项目

  • 启动springboot
  • 移动端钉钉点击工作台,找到应用,进入应用

页面展示

启动首页

公告页面

日程页面

群互动卡片

群入口应用

参考文档

  1. 获取企业内部应用access_token,文档链接:https://developers.dingtalk.com/document/app/obtain-orgapp-token
  2. 轻量级互动卡片消息,文档链接:https://open.dingtalk.com/document/group/lightweight-access-document-of-interactive-cards
  3. 群机器人接收消息,文档链接:https://open.dingtalk.com/document/group/receive-message-2
  4. 设置消息推送,文档链接:https://open.dingtalk.com/document/org/configure-push-settings
  5. 配置群应用基本信息,文档链接:https://open.dingtalk.com/document/org/configure-the-basic-information-of-the-group-application
  6. 启用和使用群应用,文档链接:https://open.dingtalk.com/document/org/install-group-applications

空文件

简介

取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/xuyan2680/h5app-cool-app-demo.git
git@gitee.com:xuyan2680/h5app-cool-app-demo.git
xuyan2680
h5app-cool-app-demo
h5app-cool-app-demo
main

搜索帮助