会話添付ファイル管理 API

ファイルライブラリ API で会話の添付ファイルを照会・削除し、一覧の可視範囲と有効期限のフィールドを確認します。

会話の添付ファイルを照会するには、会話の添付ファイル API を使用できます。一覧には、ファイルライブラリのファイルに直接リンクされた添付ファイルは含まれません。自動アーカイブでは別途ファイルライブラリの項目が作成されるため、元の会話の添付ファイルが引き続きこの一覧に表示される場合があります。一覧に添付ファイルがあるかどうかだけで、ファイルがアーカイブ済みかを判断しないでください。添付ファイルのアップロード方法は、Presigned ファイルアップロードモード を参照してください。

アクセス条件と可視範囲

Authorization: Api-Key <ご自身の API キー> で認証してください。キーの取得方法は、クイックスタート を参照してください。組織でファイルライブラリが有効になっており、呼び出し元がファイルライブラリに関連する権限を持っている必要があります。組織の所有者は、組織内で上記の条件を満たす会話の添付ファイルを閲覧できます。その他のメンバーは、自分がメッセージを送信したことのある会話の添付ファイルのみ閲覧できます。一覧は作成日時の新しい順に並びます。

エンドポイント

GET /api/v1/file-library/conversation-attachments/ は呼び出し元が閲覧できる会話の添付ファイルを一覧表示し、DELETE /api/v1/file-library/conversation-attachments/{id}/ は添付ファイルを1件削除します。パラメータとレスポンスのフィールドは、API ドキュメントの 会話の添付ファイル一覧 と 会話の添付ファイルの削除 を参照してください。

{id} は一覧で返される添付ファイル ID です。削除時には、共有されていない保存ファイルも削除されるため、選択した添付ファイルを事前に確認してください。他の添付ファイルやファイルが同じストレージオブジェクトを使用している場合、そのオブジェクトは保持されます。

ページネーションと一覧のフィールド

一覧はデフォルトで1ページあたり20件です。pageSize（page_size も使用できます）で調整でき、上限は100件です。添付ファイルはレスポンスの results に含まれます。next が null になるまで、next の URL に従って次のページを取得してください。最初のページだけで取得を終えないでください。

各添付ファイルのフィールドは、API ドキュメントの 会話の添付ファイル一覧 を参照してください。連携側では conversationId を使用して元の会話を特定できます。expiresAt はクリーンアップ設定に基づいて計算される有効期限で、ISO 8601 形式の文字列です（createdAt のミリ秒単位のタイムスタンプとは異なります）。クリーンアップの適用時刻が設定されていない場合は null です。会話に最終メッセージの時刻がある場合は、その時刻を基準に有効期限が計算されます。ない場合は、添付ファイルの作成時刻が基準になります。