魔笔平台提供了强大的钉钉日程集成功能,允许用户通过简单的配置,实现对钉钉日程服务的无缝连接和数据交互。本文档将指导您如何创建和使用钉钉日程集成。
功能介绍
魔笔平台的钉钉日程集成功能支持以下特点:
自定义触发方式:集成操作可以设置为手动触发或自动运行,满足不同的业务场景需求。
回调和数据转换:支持在查询成功或失败时执行特定的集成操作事件,以及对返回的数据进行自定义处理。
高级设置:提供防抖和禁止执行条件的高级配置,以优化集成操作的执行。
事件相关内容可参考:集成操作事件
使用钉钉日程集成
步骤 1:创建钉钉日程集成
登录魔笔平台,进入管控台。
导航至“资源”->“集成”,点击“创建集成”。
选择“钉钉日程配置”,并填写集成名称及描述。
配置不同环境的钉钉日程集成信息,包括
appKey
、appSecret
等。点击“确定”以创建钉钉日程集成。
步骤 2:在应用内部创建集成操作
打开“代码”面板,点击对应作用域的“+”后选中“集成操作”。
选择之前创建的钉钉日程集成作为资源,选择操作类型,根据需求填写参数,最后选择集成操作的触发方式,增加更多细节配置。
点击“运行”预览查询效果。
配置面板详解
集成配置
appKey 与 appSecret:钉钉应用开发平台的访问凭证,需要在开发者后台查看应用的 Cilent ID(原企业内部应用AppKey)和 Cilent Secret(原企业内部应用AppSecret)。详情请参考获取企业内部应用 accessToken。
请确保您的应用拥有日历应用中日程读写权限。关于如何给应用添加权限,请参考添加接口调用权限。
通用配置
创建日程:
组织者:日程的组织者的 unionId,unionId是应用内用户的唯一标识符,可以通过集成钉钉用户中通过查询用户详情操作,使用用户 ID 查询该用户的 unionId。关于使用钉钉用户集成,请参考集成钉钉用户。
参与者:参与者 unionId 的数组,具体写法为
[{"id":"用户1的unionId"},{"id":"用户2的unionId"}]
标题:日程标题。
开始时间:日程开始时间,格式为ISO-8601的date-time格式,例如2025-08-25T17:30:08+08:00
结束时间:日程结束时间,格式为ISO-8601的date-time格式,例如2025-08-25T17:30:08+08:00
修改日程:
组织者:日程的组织者的 unionId,unionId是应用内用户的唯一标识符,可以通过集成钉钉用户中通过查询用户详情操作,使用用户 ID 查询该用户的 unionId。关于使用钉钉用户集成,请参考集成钉钉用户。
日程 Id:日程的标识符,创建日程或查询日程列表结果中返回。
参与者:参与者 unionId 的数组,具体写法为
[{"id":"用户1的unionId"},{"id":"用户2的unionId"}]
标题:日程标题。
开始时间:日程开始时间,格式为ISO-8601的date-time格式,例如2025-08-25T17:30:08+08:00
结束时间:日程结束时间,格式为ISO-8601的date-time格式,例如2025-08-25T17:30:08+08:00
删除日程:
组织者:日程的组织者的 unionId,unionId是应用内用户的唯一标识符,可以通过集成钉钉用户中通过查询用户详情操作,使用用户 ID 查询该用户的 unionId。关于使用钉钉用户集成,请参考集成钉钉用户。
日程 Id:日程的标识符,创建日程或查询日程列表结果中返回。
查询单个日程详情:
组织者:日程的组织者的 unionId,unionId是应用内用户的唯一标识符,可以通过集成钉钉用户中通过查询用户详情操作,使用用户 ID 查询该用户的 unionId。关于使用钉钉用户集成,请参考集成钉钉用户。
日程 Id:日程的标识符,创建日程或查询日程列表结果中返回。
查询日程列表:
组织者:日程的组织者的 unionId,unionId是应用内用户的唯一标识符,可以通过集成钉钉用户中通过查询用户详情操作,使用用户 ID 查询该用户的 unionId。关于使用钉钉用户集成,请参考集成钉钉用户。
最小时间:日程开始时间的最小值,格式为ISO-8601的date-time格式,例如2025-08-25T17:30:08+08:00
最大时间:日常开始时间的最大值,格式为ISO-8601的date-time格式,例如2025-08-25T17:30:08+08:00
显示删除日程:是否显示已取消/删除日程,默认false
最大数量:返回日程的最大数量,最大值是100,默认值是100
分页游标:下一页的token,用于分页,如果一个查询条件一次无法全部返回结果,会返回分页token,下次查询带上该token后会返回后续数据,直到分页token为null表示数据已经全部查询完毕。
回调配置
数据转化:对接口返回的数据进行处理,默认为
return data
,即不进行处理。流式接收回调:配置流式调用接口 chunk 数据获取时触发的事件。
成功回调:配置接口调用成功时触发的事件。
失败回调:配置接口调用失败时触发的事件。
高级配置
防抖:设置防抖表达式,避免接口的频繁调用。
禁止执行条件:根据条件表达式确定是否执行此集成操作。
手动触发集成
事件触发
在需要触发集成操作的组件中,配置事件处理器。
将动作类型设置为集成操作,并选择相应的集成。
以对象形式填写已配置的参数。
API 触发
若此集成操作的名称为action1
,则在任何可以执行脚本的地方,可以使用action1.trigger()
方法触发集成操作,若集成操作配置了参数,则需要以对象形式填写已配置的参数。