開発ガイドイベントサブスクリプションとは
DingTalk のイベントサブスクリプションは、DingTalk Open Platform が提供するサービスです。開発者は、DingTalk プラットフォームで生成されるさまざまな重要な通知を、自社のアプリ内でリアルタイムに受信できます。イベントサブスクリプションを設定すると、部門構成の変更、社員のチェックイン、出退勤の打刻など、DingTalk 内で発生するイベントをアプリで受信し、アプリ内で速やかに応答・処理できます。この機能により、企業向けアプリを DingTalk プラットフォームとより深く連携させ、情報共有と業務コラボレーションを実現できます。ユースケース
連絡先イベントのシナリオ
新入社員の入社や社員の退職が発生した際、アプリはユーザーデータを即座に更新する必要があります。この場合、連絡先関連のイベントをサブスクライブします。連絡先データを定期的に取得して比較する代わりに、変更された連絡先情報をリアルタイムに受信して同期できます。グループイベントのシナリオ
グループ内のユーザー操作に速やかに応答するには、イベントをサブスクライブします。たとえば、ユーザーがグループチャットに参加したときに、アプリで IM Chat Management 配下の関連イベントをサブスクライブし、ユーザーがグループチャットに入室したタイミングでウェルカムメッセージを送信できます。 その他のイベントについては、イベントサブスクリプション概要を参照してください。サブスクリプション方式
サブスクリプションルール
DingTalk のイベントサブスクリプションでは、必要に応じてサブスクライブできます。具体的なルールは次のとおりです。構文
イベントサブスクリプションのマッチングルールは、Glob 構文を使用してパターンマッチングを行います。Glob は正規表現に似たマッチング方式ですが、より直感的でシンプルな構文を備えています。Glob ルールでは、*、?、{}、[] などの特殊文字を使用してパターンを定義できます。DingTalk のイベントカスタムフィルタリングでは、イベントを正確にフィルタリングするために * と {} の文字のみを使用します。
注意
ルールが設定されていない場合、または設定済みのルールがすべて削除された場合、そのタイプのすべてのイベントがプッシュされます。
- 単一アスタリスク
*
/ や \ は含みません。たとえば、/path/*/abc は /path/a/abc、/path/b/abc などにマッチします。
-
二重アスタリスク
**単一アスタリスクと似ていますが、パス境界を越えることができ、通常は複数階層のディレクトリにマッチさせるために使用します。たとえば、/path/**/abcは/eventkey/a/abc、/eventkey/b/abc、/eventkey/a/b/abc、/eventkey/a/b/c/abcなどにマッチします。 -
波括弧
{}波括弧はサブパターンのマッチング集合を指定します。たとえば、{sun,moon,stars}はsun、moon、starsにマッチし、{temp*, tmp*}はtempまたはtmpで始まる任意の文字列にマッチします。
関連するパラメータ情報については、承認イベントを参照してください。