メディアID

/v1/media/{media-id}

特定のID。このエンドポイントを使ってメディアを取得または削除します。

開始する前に

取得または削除する前に、まず/v1/mediaを使ってメディアをアップロードしなければなりません。

取得

メディアのアップロードに成功すると、メディアIDを含む応答を受け取ります。このIDをリクエストで使用して、WhatsApp Business APIクライアントに保存されているメディアを取得することができます。

メディアを取得するこのプロセスは、ユーザーがあなたに画像を送信した場合にも使用されます。画像は、Webhookが受信します。メディア付きのメッセージを受信すると、WhatsApp Business APIクライアントはそのメディアをダウンロードします。メディアのダウンロードが終わると、Webhookを通して通知を受け取ります。この通知にあるメディアIDを使用して、メディアを取得できます。

WhatsApp Business APIクライアントでメディアの自動ダウンロードを有効にするには、自動ダウンロードメディアの設定を使用します。

例

GET /v1/media/media-id

例えば、前のセクションでアップロードしたサンプル画像を使用する場合、次のようになります。

curl -X GET \
  https://your-webapp-hostname:your-webapp-port/v1/media/4b5bf27b-8672-4d55-bc21-d096dc200d0f \
  -H 'Authorization: Bearer your-auth-token' 

このサンプルメディアをファイルに送信するには、以下に示すように、-oパラメーターを使用します。

curl -X GET \
  https://your-webapp-hostname:your-webapp-port/v1/media/4b5bf27b-8672-4d55-bc21-d096dc200d0f \
  -H 'Authorization: Bearer your-auth-token' \
  -o path/filename

呼び出しが成功すると、200 OKステータスとバイナリメディアデータが含まれている応答が表示されます。

Content-Type: image/jpeg or other appropriate media type
Content-Length: content-size

binary-media-data

Postmanのようなツールを使っている場合は、画像が表示されます。コマンドラインツールを使っている場合は、バイナリデータが表示されます。データをファイルに送ると、ファイルブラウザーに画像が表示されます。

メディアが見つからない場合は、本文なしで404 Not Found応答コードが返されます。

別のエラーメッセージを受け取った場合は、エラーおよびステータスメッセージで詳細を確認してください。

削除

WhatsApp Business APIクライアントにあるメディアを削除するには、DELETEリクエストをmediaノードに送信します。この際、削除したいメディアのIDを指定します。メディアをアップロードしたときの応答、または WebhookからのメディアメッセージにあるIDを使用してください。

例

リクエスト:

DELETE /v1/media/media-id

成功したときの応答には、200 OKと、nullまたは{}が表示されます。メディアが見つからない場合の応答には、404 Not Foundが表示され、本文はありません。別のエラーメッセージを受け取った場合は、エラーおよびステータスメッセージで詳細を確認してください。