我們即將停用內部部署 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 用戶端中的多媒體,請傳送 DELETE 要求至 media 節點,並提供所要刪除的多媒體編號。使用上傳多媒體後的回應或 Webhook 傳來的多媒體訊息中的編號。

範例

要求:

DELETE /v1/media/media-id

成功的回應會顯示 200 OK,以及 null{}。如果找不到多媒體,回應會顯示 404 Not Found 且無內文。如果您收到不同的錯誤訊息,請參閱錯誤和狀態訊息以取得詳細資訊。