我们将弃用本地 API。请参阅我们的本地 API 弃用文档,了解弃用详情以及如何迁移到我们的下一代云端 API。

媒体编号

/v1/media/{media-id}

给定一个特定编号后,可使用此端点检索或删除媒体。

准备工作

在检索要删除的媒体之前,您必须先通过 /v1/media 上传媒体。

检索

成功上传媒体后,您会收到一个响应,其中包含媒体编号。您可以在任何请求中使用该编号来检索 WhatsApp Business API 客户端中存储的媒体。

当用户向您发送由 Webhooks 接收的图像时,也会使用此过程检索媒体。如果收到的消息包含媒体,则 WhatsApp Business API 客户端会下载该媒体。媒体下载完成后,您将通过 Webhooks 收到通知;请使用该通知中提供的媒体编号来检索相关媒体。

您可以通过自动下载媒体设置,让 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 请求,并附加要删除的媒体的编号。请使用上传媒体后系统返回的响应中的编号,或 Webhooks 发送的媒体消息中的编号。

示例

请求:

DELETE /v1/media/media-id

若请求成功,响应会显示 200 OKnull{}。如果未找到媒体,则响应会显示 404 Not Found,且不包含正文。如果您收到其他错误消息,请参阅错误和状态消息,了解详情。