概要
Note リソースに関する webhook イベントです。すべての note イベントはresourceType: "Note" を使用します。
イベントの詳細
note.created
- ライブ音声ノートの録音を開始したとき
- 録音ファイルからノートを作成したとき
note.deleted
- ユーザーがノートを完全に削除したとき
note.recording.completed
- すべての音声データの処理が完了し、テキスト変換と段落の生成が終わったとき
- 重要: このイベントは、リアルタイム会議ノートでは複数回発生することがあります。1 回の会議セッション中に録音と停止が複数回行われる場合があるためです
- このイベントを受信した時点で、その時点のノート情報をすべて取得できます
note.user_content.updated
- ユーザーがノートの内容を手動で編集したとき
note.ended
- ノートが完全に終了したとき(すべての処理が完了した後)にトリガーされます
- 複数回発生しうる
note.recording.completedとは異なり、ノートのライフサイクルごとに 1 回だけ発生します - これはノートの完了を示す、確定的なイベントです
- ノートが最終状態に達したことを把握する必要がある場合に、このイベントを利用してください
note.participants.updated
- ノートに会議の参加者が追加または削除されたときにトリガーされます
- 既存の参加者の名前やメールアドレスが更新された場合には発生しません
resourceフィールドには、更新後のparticipants配列を含む完全な Note オブジェクトが含まれます
payload の例
リソースデータ
Note イベントには、完全な Note リソースデータが含まれます。各フィールドの説明については、Note API をご覧ください。 重要: Note リソースには metadata のみが含まれます。transcript の内容を取得するには、List Note Paragraphs API を使用して、実際のテキストデータを取得してください。ガイド
リアルタイム会議ノート
- リアルタイム会議では、
recording.completedが同じノートに対して複数回発生することがあります - このイベントを受信した際は、常に最新のノートデータを取得してください
note.ended イベントの利用:
note.endedはノートが完全に終了したときに 1 回だけ発生するため、ライフサイクルの管理がより明確になります- 会議中に複数回発生しうる
recording.completedとは異なり、note.endedは確定的な終了を示します recording.completedとnote.endedの両方のイベントがサポートされており、ニーズに応じて併用できます
- 会議が開始 → 録音が開始
- 録音が一時停止 → transcript と要約の処理 →
note.recording.completedが発生(イベント #1) - 録音が再開 → 処理を継続
- 録音が停止 → transcript と要約の処理 →
note.recording.completedが発生(イベント #2)