L’API On-Premises ne sera bientôt plus disponible. Consultez notre document Abandon progressif de l’API On-Premises pour de plus amples détails, mais aussi pour connaître la procédure de migration vers notre API Cloud nouvelle génération.

ID du contenu multimédia

/v1/media/{media-id}

Avec un ID spécifique, utilisez ce point de terminaison pour récupérer ou supprimer votre contenu multimédia.

Avant de commencer

Avant toute récupération ou suppression, vous devez d’abord importer votre contenu multimédia via /v1/media.

Récupération

Après avoir importé votre contenu multimédia, vous recevez une réponse contenant un ID de contenu multimédia. Utilisez cet ID dans vos requêtes pour récupérer les contenus multimédias enregistrés dans le client de l’API WhatsApp Business.

Ce processus de récupération des contenus multimédias est également employé quand un utilisateur ou une utilisatrice vous envoie une image qui est reçue par votre Webhook. Quand vous recevez un message multimédia, le client de l’API WhatsApp Business télécharge le contenu multimédia. Une fois le contenu téléchargé, vous recevez une notification via votre Webhook. Utilisez l’ID du contenu multimédia indiqué dans cette notification pour récupérer le contenu multimédia.

Vous pouvez régler les paramètres de téléchargement automatique pour que le client de l’API WhatsApp Business télécharge automatiquement les contenus multimédias.

Exemple

GET /v1/media/media-id

En utilisant l’image importée dans la section précédente :

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

Pour envoyer ce contenu multimédia dans un fichier, utilisez le paramètre -o, comme indiqué ci-dessous :

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

Si l’appel échoue, la réponse contient le statut 200 OK et les données binaires du contenu multimédia.

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

binary-media-data

Si vous avez utilisé un outil comme Postman, vous voyez l’image. Si vous utilisez un outil de ligne de commande, vous voyez les données binaires. Si vous avez envoyé les données dans un fichier, vous voyez l’image dans votre explorateur de fichiers.

Si le contenu multimédia est introuvable, un code de réponse 404 Not Found est renvoyé sans corps de message.

Si vous recevez un autre message d’erreur, consultez l’article Messages d’erreur et d’état pour plus d’informations.

Suppression

Pour supprimer un contenu multimédia du client de l’API WhatsApp Business, envoyez une requête DELETE au nœud media accompagnée de l’ID du média que vous souhaitez supprimer. Utilisez l’ID obtenu dans la réponse lors de l’importation du contenu multimédia ou dans le message multimédia du Webhook.

Exemple

Requête :

DELETE /v1/media/media-id

En cas de réussite, la réponse contient le code 200 OK avec null ou {}. Si le contenu multimédia est introuvable, la réponse contient le code 404 Not Found et aucun corps. Si vous recevez un autre message d’erreur, consultez l’article Messages d’erreur et d’état pour plus d’informations.