我們即將停用內部部署 API。詳情請參閱內部部署 API 停用文件,並從中了解如何轉用新一代雲端 API。

媒體編號

/v1/media/{media-id}

得到特定編號之後,使用此端點檢索或刪除您的媒體。

準備工作

檢索刪除內容之前,您必須先經由 /v1/media 上載您的媒體。

檢索

成功上載您的媒體後,您會收到包含媒體編號的回應。在要求中使用該編號檢索儲存在 WhatsApp Business API 用戶端的媒體。

此檢索媒體的程序亦會在用戶向您傳送圖片時使用,其中該圖片由您的 Webhook 接收。收到含有媒體的訊息時,WhatsApp Business API 用戶端便會下載該媒體。媒體下載完成後,您會透過 Webhook 收到通知;使用該通知中的媒體編號檢索媒體。

您可以透過自動下載媒體設定啟用 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 用戶端刪除,請向 media 節點傳送 DELETE 要求,以及要刪除的媒體之編號。使用回應上載媒體時提供的編號或 Webhook 的媒體訊息提供的編號。

範例

要求:

DELETE /v1/media/media-id

成功回應會顯示 200 OK,以及 null{}。如果找不到媒體,則回應會顯示 404 Not Found,而且不含正文。如果您收到不同的錯誤訊息,請參閱錯誤和狀態訊息以了解詳情。