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

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

Webhookブロックのファイル送信機能

自動ガイドボットを外部システムと連携する際には、WebhookブロックでAPIを使用して外部システムの情報を取得、表示できます。これまで、自動ガイドボットのWebhookブロックは、JSON形式（テキストデータ）にのみ対応していました。データの送受信は問題なく行われていましたが、ボットを通じて請求書、レポート、配送ラベルなどのファイルを共有することはできませんでした。
新機能であるファイル送信機能を利用すると、APIを通じて外部システムからファイルを取得して、表示できます。チャットの利用者は、チャット画面から直接ファイルのプレビューを表示したり、ファイルをダウンロードしたりすることが可能です。
関連情報：自動ガイドボットのWebhookブロックの概要

ファイル送信機能とは

ファイル送信機能を使用すると、APIを通じて外部システムからファイルを取得し、チャット内で利用者に共有できます。以下のファイルをチャットに表示したい場合に役立ちます。
  • 請求書、レポートなどのPDFファイル
  • 画像ファイル、動画ファイル
  • チケット、領収書などの文書ファイル
テキスト形式のデータだけでなく、実際のファイルを表示できます。Webhookを通じてファイルを受信すると、チャット画面にダウンロード用のリンクが表示されます。リンクをクリックすると、新しいページでファイルが開きます。チャットの利用者は、こちらからファイルのプレビューを表示したり、ファイルをダウンロードしたりできます。

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

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

設定方法

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

サーバー側の各種上限

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

主な状況とシステムの動作

状況 動作
［レスポンスの種類］として［ファイル］を選択した ［フォーマット］の項目が非表示になり、［レスポンス］には値があらかじめ入力され、［データの種類］では標準で［ファイル］が選択されます。
［レスポンスの種類］を［ファイル］から［JSON］に変更した ［レスポンス］の設定内容がすべてリセットされます。
APIを通じてファイルを受信した チャット画面にダウンロード用のリンクが表示され、利用者に共有されます。
利用者がファイルのリンクをクリックした 新しいページでファイルが開き、ファイル形式に応じてプレビューまたはダウンロードの操作を実行できます。
APIを通じてJSON形式のデータとファイルの両方が送信される レスポンスの種類ごとに別々のWebhookブロックを使用します。
ファイルサイズが14MBを超えている ファイルは処理されません。

メリット

  • チャット画面にファイルを表示できます。
  • 外部サイトへのリンクを設定する代わりに、APIを通じて直接ファイルを取得できるため、手間を省くことができます。
  • 利用者は、チャット画面からすぐにファイルのプレビューを表示したり、ファイルをダウンロードしたりすることが可能になります。顧客満足度を高めるのに役立ちます。