自動ガイドボットのWebhookブロックにおけるファイルの送信

自動ガイドボットのWebhookブロックにおけるファイルの送信

自動ガイドボットを外部システムと連携する際には、WebhookブロックでAPIを使用して外部システムの情報を取得、表示できます。これまで、自動ガイドボットのWebhookブロックは、JSON形式（テキストデータ）にのみ対応していました。データの送受信は問題なく行われていましたが、ボットを通じて請求書、レポート、配送ラベルなどのファイルを直接共有することはできませんでした。

新機能であるファイル送信機能を利用すると、APIを通じて外部システムからファイルを取得して、表示できます。チャットの利用者は、チャット画面から直接ファイルのプレビューを表示したり、ファイルをダウンロードしたりすることが可能です。

参考情報：自動ガイドボットのWebhookブロックの概要

ファイル送信機能とは   

ファイル送信機能を使用すると、APIを通じて外部システムからファイルを取得し、チャット内で利用者に共有できます。たとえば、以下のファイルをチャットで共有したい場合に役立ちます。
  1. 請求書、レポートなどのPDFファイル
  2. 画像ファイル
  3. 問い合わせ、領収書などの文書ファイル
テキスト形式のデータだけでなく、ファイルを処理できます。

Webhookを通じてファイルを受信すると、チャット画面にダウンロード用のリンクが表示されます。リンクをクリックすると、新しいページでファイルが開きます。チャットの利用者は、こちらからファイルのプレビューを表示したり、ファイルをダウンロードしたりできます。
 

ファイル送信機能のメリット   

ファイル送信機能を利用することで、APIを通じてファイルのプレビューやダウンロード用のリンクを表示できます。ファイル送信機能の主なメリットは、以下のとおりです。
  1. 領収書、レポート、添付ファイルなどのファイルをリアルタイムで表示できます。
  2. チャット画面にファイルのプレビューやダウンロード用のリンクを表示することで、ユーザーの利便性を向上できます。
  3. APIを通じてファイルを自動で取得できます。ファイルを手動でアップロードする手間を省くことが可能です。

設定方法   

WebhookブロックでHTTPメソッドを［GET］に設定すると、この機能を利用できます。
設定するには、以下の手順を実行します。
  1. Webhookブロックで、［レスポンスの種類］として［ファイル］を選択します。
  2. 選択後、以下の手順を実行します。
    1. ［フォーマッター］の項目は、自動で非表示に設定されます。
    2. ［レスポンス］の項目には、選択可能な［ステータスコード］と［変数名］が自動で入力され、表示されます。
    3. ［データの種類］としては、標準で［ファイル］が選択されます。
  3. レスポンスの種類を［ファイル］から［JSON］（またはその逆）に切り替えると、［レスポンス］の設定内容は自動でリセットされます。
    1. レスポンスの種類が［ファイル］の場合は、複数のレスポンス項目を追加することはできません。
    2. ただし、分岐処理で［複数の経路］使用することは可能です。
 

サーバー側の各種上限 

Webhookを通じてファイルをダウンロードできるようにする際には、以下の上限が適用されます。

ファイルサイズの上限：14MB

ファイルの種類
対応しているファイル形式
画像
BMP、GIF、JPEG、JPG、PNG、TIFF、HEIF、HEIC
音声
WAV、VND.WAVE、MPEG、MP3、X-AIFF、OGG、VORBIS
動画
MPEG、MP4、APPLICATION/MP4、QUICKTIME、M4V、X-M4V、X-MATROSKA、X-MSVIDEO、3GPP
文書
PDF、MSWORD、X-MSOFFICE、VND.OPENXMLFORMATS-OFFICEDOCUMENT.WORDPROCESSINGML.DOCUMENT、X-OOXML
その他
PLAIN、ZIP、HTML、VND.MS-EXCEL、VND.MS-POWERPOINT、CSV、XML
  

留意事項   

  1. APIのエンドポイントで、ファイルが正しい形式で出力されることを確認してください（例：PDF、画像、文書）。
  2. ファイル送信機能を使用する場合は、HTTPメソッドに［GET］を設定してください。
  3. ファイルの種類とサイズが上限内であることを確認してください。
  4. APIによってJSONとファイルの両方を出力する場合、それぞれ別のWebhookブロックを使用してください。
  5. テストを実施し、メッセージブロックにファイルが正しく表示されるかどうかを確認してください。
 

ファイル送信機能のメリットのまとめ   

  1. チャット画面でファイルを共有できます。
  2. ファイルを自動で取得できます。手間や時間を省くのに役立ちます。
  3. チャット画面でファイルのプレビュー表示やダウンロード用のリンクを提供できます。顧客満足度を高めるのに役立ちます。