A API Local está sendo descontinuada. Consulte o documento Descontinuação da API Local para ver mais informações e saber como migrar para nossa API de Nuvem de última geração.

ID de mídia

/v1/media/{media-id}

Com um ID específico, use este ponto de extremidade para recuperar ou excluir a mídia.

Antes de começar

Antes de recuperar a exclusão, é preciso carregar a mídia por meio de /v1/media.

Recuperação

Após o carregamento da mídia, você receberá uma resposta com o ID dela. Use essa informação em solicitações para recuperar a mídia armazenada no cliente da WhatsApp Business API.

O processo de recuperação também pode ser usado quando imagens enviadas por usuários forem recebidas pelo seu Webhook. Quando a mensagem com mídia é recebida, o cliente da WhatsApp Business API baixa a mídia. Depois que o download for concluído, você receberá uma notificação via Webhook. Use o ID fornecido nessa mensagem para recuperar a mídia desejada.

É possível habilitar o cliente da WhatsApp Business API para baixar automaticamente a mídia com as configurações para download automático de mídia.

Exemplo

GET /v1/media/media-id

Por exemplo, usando a imagem carregada na seção anterior:

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

Para enviar essa mídia a um arquivo, use o parâmetro -o, conforme mostrado abaixo:

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

Se a chamada for bem-sucedida, você verá uma resposta com o status 200 OK e os dados binários da mídia.

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

binary-media-data

Você verá a imagem se tiver usado uma ferramenta como o Postman. Se estiver usando uma ferramenta de linha de comando, você verá os dados binários. Caso tenha enviado os dados a um arquivo, você verá a imagem no navegador de arquivos.

Se a mídia não for encontrada, um código de resposta 404 Not Found será retornado sem texto.

Caso você receba uma mensagem de erro diferente, consulte Mensagens de erro e status para saber mais.

Exclusão

Para excluir uma mídia no cliente da WhatsApp Business API, envie uma solicitação DELETE ao nó media com o ID da mídia a ser excluída. Para isso, use o ID obtido na resposta do carregamento da mídia ou da mensagem de mídia do Webhook.

Exemplo

Solicitação:

DELETE /v1/media/media-id

Uma resposta bem-sucedida mostra 200 OK e null ou {}. Se a mídia não for encontrada, a resposta será 404 Not Found e não conterá texto. Caso você receba uma mensagem de erro diferente, consulte Mensagens de erro e status para saber mais.