メインコンテンツへ移動
ドキュメント走る外部メッセージ

外部メッセージ

ワークフローと Telegram などの外部チャネルとの間でやり取りされるメッセージをどこで確認し、実行詳細とどう対応付けるか。

ワークフローを実行すると、外部チャネルに何かを送信することがよくあります。Telegram で質問して返信を待つ、日報を Slack チャンネルに送る、DingTalk グループにアラートを 1 件送るなどです。コンソールの「外部メッセージ」ページは、各実行に散在するこれらのメッセージを検索可能な 1 つの一覧に集約し、各メッセージからワンクリックでそれを生成した実行に戻ることができます。入口はコンソールのサイドバー → 外部メッセージです。

メッセージの出所

一覧内の各レコードはいずれかの実行に由来し、主に 3 種類の出所があります。

  • Agent の IM ツール呼び出し — sendMessageToUser（メッセージ送信）、sendFileToUser（ファイル送信）、askUserViaIM（質問して返信を待つ）
  • ステップイベントストリーム内の構造化された外部メッセージイベント — ワークフロー実行時にイベントとともに記録されます
  • 配信型ステップの出力 — レポート / ファイルが Slack または Telegram に正常に配信された後に残る配信記録

外部メッセージには独立した入力経路はありません。一覧は各実行のイベントストリームから抽出してインデックス化されたものであり、実行データが常に事実の情報源です。メッセージ内容は送信時に記録されたテキストを基準とします。

対応チャネル

送信メッセージは 7 つの IM チャネルをカバーします: Telegram、Slack、Discord、WhatsApp、WeChat Work、DingTalk、Feishu。このうち Telegram は双方向に対応し、ワークフローは実行中に質問し、あなたの返信を待ってから継続できます。本ページに一覧表示されるのはワークフローが送信したメッセージです。あなたの返信内容は、対応する実行詳細のイベントタイムラインで確認できます。

一覧とフィルタリング

一覧は送信時刻の降順で表示され、列には時刻、チャネル、方向、ワークフロー、実行 ID、実行ステータス、ステップ、メッセージ内容が含まれます。フィルタ条件は重ねて適用できます。

フィルタ項目説明
キーワード検索メッセージ内容、実行 ID、ワークフロー名、ステップ名、チャネルにマッチします
実行状況待機中 / 実行中 / 完了 / 失敗 / キャンセル済み / 中断
ワークフロー特定のワークフローが送信したメッセージのみを表示します
外部チャネルTelegram、Slack、DingTalk などのチャネルでフィルタリングします
メッセージの方向性送信（テキストメッセージ）またはファイル送信

ページネーションは 1 ページあたり 20 / 50 / 100 / 200 件から選択できます。メッセージ内容または「詳細」をクリックするとドロワーが開きます。完全なメッセージ原文（含まれるリンクは直接クリックして開けます）、送信時刻、所属するワークフローとステップ、および「メッセージをコピー」「実行詳細を表示」の 2 つのボタンが表示されます。

実行詳細との関係

同じメッセージ群はコンソールに 3 つの入口があり、粒度は粗いものから細かいものへと並びます。

  • 外部メッセージページ（本ページ）— すべての実行にわたる集約一覧で、チャネルやキーワードで 1 件のメッセージを追跡するのに適しています
  • 実行一覧 — 外部メッセージを送信した実行にはメッセージバッジが付き、ホバーすると件数と最新のメッセージのプレビューが表示されます
  • 実行詳細 — 「外部メッセージ」タブにはこの実行が送信したメッセージのみが表示されます。イベントタイムラインでは、メッセージの前後の完全なコンテキスト、例えば質問後にユーザーが何を返信したか、タイムアウトしたかどうかを確認できます

各メッセージには、それを生成したステップ名が記録されています。内容に問題のあるメッセージを受け取った場合、ここから実行詳細に進んでそのステップのログを特定する方が、チャット履歴を辿るよりはるかに速いです。

API でメッセージ一覧を取得する

bash
# 最近的外部消息（时间倒序）
curl "https://braidrun.com/api/executions/external-messages?page=1&size=50" \
  -H "Authorization: Bearer <token>"

# 只看某条工作流发到 Telegram 的文本消息
curl "https://braidrun.com/api/executions/external-messages?workflowId=<workflow-id>&service=telegram&direction=outgoing" \
  -H "Authorization: Bearer <token>"
パラメータ説明
page / sizeページネーション。size はデフォルト 50、最大 200 です（Web UI はデフォルトで 1 ページ 20 件）
workflowId特定のワークフローのみを表示
status実行ステータスでフィルタリングします。例: COMPLETED、FAILED
serviceチャネル、小文字。例: telegram、slack、dingtalk、feishu
directionメッセージの方向: outgoing（テキスト）または outgoing_file（ファイル）
searchキーワード。マッチする範囲はページの検索ボックスと同じです

返される各レコードには executionId、workflowId、workflowName、executionStatus、service、direction、content、stepName、timestamp が含まれ、外部システムで「どのワークフローのどのステップが、いつ、どのチャネルに何を送信したか」を復元するのに十分です。

関連ページ