ID медиафайла

/v1/media/{media-id}

С помощью этой конечной точки можно получать или удалять медиафайлы, указывая их ID.

Перед началом работы

Чтобы получать или удалять медиафайлы, их нужно сначала загрузить с помощью /v1/media.

Получение

После загрузки медиафайла вы получите ответ с его ID. Этот ID можно использовать во всех запросах для получения медиафайла, который хранится в клиенте API WhatsApp Business.

Такая процедура получения медиафайла также используется в ситуации, когда пользователь отправляет вам изображение, принимаемое вашим Webhook. При получении сообщения с медиафайлом клиент API WhatsApp Business скачивает этот файл. После скачивания медиафайла вы получите соответствующее уведомление через Webhook. Для получения медиафайла используйте его ID из этого уведомления.

Клиент API WhatsApp Business можно настроить для автоматической загрузки медиафайла, используя параметры автоматической загрузки.

Пример

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 без тела.

В ответе могут содержаться другие сообщения об ошибках. В этом случае обратитесь к разделу Сообщения об ошибках и коды статусов.

Удаление

Чтобы удалить медиафайл в клиенте API WhatsApp Business, отправьте запрос DELETE к узлу media и укажите ID этого медиафайла. Для этого используйте ID, полученный в ответе после операции загрузки медиафайла или в сообщении с медиафайлом от Webhook.

Пример

Запрос:

DELETE /v1/media/media-id

В случае успеха ответ содержит код 200 OK и значение null или {}. Если медиафайл не найден, будет возвращен код ответа 404 Not Found без тела. В ответе могут содержаться другие сообщения об ошибках. В этом случае обратитесь к разделу Сообщения об ошибках и коды статусов.