CtrlK
BlogDocsLog inGet started
Tessl Logo

dingtalk-event

钉钉个人 IM 与 OA 审批事件长连接监听。Use when 用户说监听消息/@我/某人/某群/全部消息、已读/撤回/reaction、群成员加入/群成员退出/群状态变化,或监听审批任务创建/完成/转交、审批实例发起/抄送/终止/完成。命令前缀:dws event。

76

Quality

96%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide

SecuritybySnyk

Low

Low-risk findings worth noting

SKILL.md
Quality
Evals
Security

钉钉个人 IM 与 OA 审批事件

**前置:执行 dws 前必须完整读取 dingtalk-shared。**Shared references 仅按需加载。

本 Skill 只负责未来个人 IM/OA 实时事件;发送和历史消息走 dingtalk-chat,审批查询与处理走 dingtalk-misc 的 OA,开放平台应用事件配置走其 DevApp。子 reference 按需加载。

实时监听必须使用事件长连接,不写轮询脚本,不用历史消息或审批列表查询模拟事件。高频 IM 意图优先交给 dws event +listen-im;它在 CLI 内解析自然目标、选择 EventKey,并复用现有订阅与 bus 生命周期。OA 审批事件使用显式 dws event consume

消息、reaction、已读和撤回的默认监听入口是 `dws event +listen-im`;

只有群生命周期、Filter DSL、原始 envelope 或底层订阅控制才使用 event consume fallback。

OA 审批任务与审批实例的实时变化使用 `dws event consume`;查询或操作已有审批走 `dws oa`,不要用轮询模拟事件。

Golden Route

用户意图唯一推荐入口
监听 @我的消息dws event +listen-im --kind at-me
监听某人发来的消息dws event +listen-im --kind sender --user-query <姓名>
监听指定群消息dws event +listen-im --kind group --chat-query <群名>
同一人/群的消息、表情、已读或撤回`dws event +listen-im --kind <sender
监听全部单聊或全部群消息`dws event +listen-im --kind <all-direct
群改名、成员进退、群解散读取 EventKey 索引,使用精确 event consume EventKey
OA 审批任务或实例事件读取 OA 事件参考,使用精确 event consume EventKey
查看 OA 事件目录dws event list --category oa
已知 EventKey 或需要底层订阅控制dws event consume;参数与约束以 leaf Schema 为准
查看状态 / 停止dws event status / dws event stop <subscribe_id> --dry-run,确认后再 --yes

默认 --events message。可选事件为 messagereactionreadrecall

  • at-meall-directall-group 只支持 message,且不接受目标。
  • sender 必须且只能传 --user--open-dingtalk-id--user-query 之一。
  • group 必须且只能传 --chat-id--chat-query 之一。
  • --query 只用于纯 message 监听;混入 reaction/read/recall 时不得使用。

OA 事件不进入 +listen-im。七个公开 OA EventKey 都订阅当前 OAuth 用户相关的全部审批事件,使用 ruleType=allfilterRule={};不接受 --user--open-dingtalk-id--group--query--filter-json。七项可放入同一个 consume,每项建立独立订阅并共享 bus。

自然姓名和群名由 CLI 内部唯一解析:零命中或多候选返回结构化失败,在创建任何订阅前停止。--dry-run 走同一解析链。解析、监听、状态和停止必须使用同一个 --profile,不得跨组织搬运 ID。

兼容 EventKey 索引

+listen-im 覆盖高频路径;只有需要精确底层控制时才直接使用以下 16 个 EventKey:

user_im_message_receive_at
user_im_message_receive_o2o        user_im_message_receive_user
user_im_message_receive_group      user_im_message_receive_o2o_all
user_im_message_receive_group_all  user_im_message_read_o2o
user_im_message_read_group         user_im_message_recall_o2o
user_im_message_recall_group       user_im_message_reaction_o2o
user_im_message_reaction_group     user_im_group_updated
user_im_group_member_added         user_im_group_member_exited
user_im_group_disbanded

七个 OA EventKey 及其输出字段见 OA 事件参考

用户类事件传 --user--open-dingtalk-id,群类事件传 --group。群生命周期输出可含 operator_open_dingtalk_idmembers;成员项使用 open_dingtalk_id。精确组合、兼容性和 Filter 规则见 reference。

公开层与内部统一边界

+listen-im 是意图编译层,不是第二套事件系统。它只负责:

kind + events + target
→ typed resolver
→ 确定 EventKey 集合
→ 一次 event consume 生命周期

订阅创建/复用、单 bus、多 consumer、ready marker、扁平 NDJSON、超时/取消、部分失败回滚和退出清理全部复用现有 Runtime。低频 EventKey、群生命周期、OA 审批、Filter DSL、原始 envelope、复用 subscribe_id 等仍由 event consume 承担。

运行与结果契约

  • 正常消费固定使用当前用户 OAuth 身份、--flatten 和 NDJSON;stdout 只输出事件,stderr 输出订阅、ready、退出和错误状态。
  • 单事件 ready:[event] ready event_key=<key> bus_pid=<pid> subscribe_id=<id>
  • 多事件先逐条输出 subscription,全部就绪后输出 [event] ready event_count=<n> bus_pid=<pid>。必须等待 ready,不用 sleep 猜测。
  • 有界任务使用 --max-events N--duration 10m;无界任务需要宿主管理进程并持续读取 stdout。
  • 干净退出会取消本次新建的订阅;使用 SIGTERM、关闭符合条件的管道 stdin,或 Runtime 的 bounded exit。不要 kill -9
  • 当前用户自己发送的消息会被 self-loop 过滤;自测事件应由另一用户或机器人发送。
  • 事件只负责监听;需要回复时按 输出与 Chat 交接 把真实 conversation_idsender_open_dingtalk_id 交给 dws chat +messages-send,不要从显示名猜 ID。
  • 扁平消息/动作字段按事件类型读取:已读为 reader_open_dingtalk_id,撤回为 recaller_open_dingtalk_id,回应为 reaction_nameoperation_type。媒体优先通过聊天读取命令加 --download-resources;已知消息 ID 的底层降级入口是 dws chat message download-media
  • OA 扁平事件提供审批实例、任务和状态字段;字段差异、原始回退条件及与 OA 命令的稳定 ID 交接以 OA 事件参考 为准。

安全与失败处理

  • event stop 会取消订阅并影响本地 consumer:先 --dry-run,用户确认后再加 --yes
  • 多事件属于一次原始操作;任一订阅启动失败时 Runtime 回滚本次已创建项,不拆成新命令绕过重试预算。
  • 这套 0/2/1Agent/host 编排预算,适用于全部 23 个公开个人 EventKey(16 个 IM + 7 个 OA):retryable=false 对应 max_additional_attempts=0retryable=true 对应 max_additional_attempts=2retryable=unknown 对应 max_additional_attempts=1。它不是 CLI 持久化硬总次数上限;每次调用最多创建一次,进程内不会自动重试,CLI 也不持久化或计算跨调用的 Agent/host 尝试次数。
  • 重试必须遵守 retry_after_seconds / next_retry_at。遇到 in_flightcooldownterminal_hold 不并发或递归重启同一逻辑订阅,也不换 subscribe_id / trace_id 绕过保护。
  • 认证、profile、订阅保护状态和 bus 排障按失败类型读取 订阅运维,不要在正常路径预加载完整运维手册。

本地订阅保护契约

  • open 版状态路径为 ~/.dws/events/open/personal_stream/<identity_hash>/personal_subscription_attempts.json;设置 DWS_CONFIG_DIR 后根目录随之变化。
  • identity 目录权限为 0700personal_subscription_attempts.jsonpersonal_subscription_attempts.lock 权限为 0600
  • 连续 24h 无失败后重置计数;terminal_hold 持续 1h。优先等待 next_retry_at,不要把删状态当常规重试。
  • 仅在确认该 identity 没有订阅创建进程的紧急恢复场景,只删除 personal_subscription_attempts.json,不要删除 lock 文件。该操作会清空该 identity 的全部保护记录,而非单个事件。

何时查询 Schema

  • 已知 Golden Route 时直接执行,不先跑 event list
  • 只有解析业务字段时才用 dws event schema <event_key> --flatten
  • 只有参数或安全不确定时才用 dws schema --cli-path "event +listen-im" --compact 或对应 compact leaf。
  • event schema 描述事件 payload;顶层 dws schema 描述 CLI 命令,两者不要混用。

Reference

TopicReference何时读取
任务索引event-im.md还不能判断应该加载哪一个子 reference
EventKey、目标规则与底层 consumeevent-im-keys.md群生命周期、显式 EventKey 或多事件组合
ready、bounded consume 与退出清理event-im-lifecycle.md启动/托管/关闭 consumer
扁平字段与事件到 Chat 交接event-im-output.md解析事件或自动回复
Filter、status/stop、重试与排障event-im-operations.md订阅控制或失败恢复
OA 审批事件event-oa.md选择七个 OA EventKey、组合消费或解析审批字段
Repository
DingTalk-Real-AI/dingtalk-workspace-cli
Last updated
First committed

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.