Aller au contenu

Statut de la vidéo

Ce guide API fournit un aperçu du processus de vérification de l'état de votre demande groupée.

Le traitement des demandes groupées peut prendre du temps, en fonction du nombre de contacts dans votre fichier CSV. Après avoir lancé la demande, vous devrez vérifier son état pour surveiller la progression, qui sera fournie sous forme de pourcentage. 🦊

Démarrage rapide

Plongeons-nous dans le vif du sujet et explorons comment vérifier la progression de votre demande groupée.

Obtenir l'état groupé

Pour vérifier la progression de votre demande groupée, fournissez le 'id' comme 'video_id' obtenu à partir de la génération de la demande ou via l'API de liste groupée. En réponse, vous recevrez :

  • 'progress' : La progression actuelle de la demande en pourcentage.
  • 'status' : L'état global de la demande.
  • 'video_links_csv' : Contient les URL pour télécharger les vidéos.

Vous pouvez appeler ce point de terminaison plusieurs fois. Cela renverra également des résultats partiels au format csv. Lorsque la génération de vidéos est en cours, le statut sera « en cours » et la progression sera inférieure à 100. Si toutes les vidéos sont générées, le statut sera « terminé » et la progression sera de 100.

curl --request GET  \
     --url 'https://api.immersive-fox.com/v1/bulk_requests/video/<video_id>'  \
     --header 'X-Api-Key: <your-api-key>'  \
     --header 'Content-Type: application/json'

{
    "id": 494,
    "csv_file_name": "my_contacts.csv",
    "progress": 55,
    "status": "in-progress",
    "video_links_csv": "https://my-bucket-name.s3.eu-central-1.amazonaws.com/my_contact_videos.csv"
}

{
    "id": 494,
    "csv_file_name": "my_contacts.csv",
    "progress": 100,
    "status": "Completed",
    "video_links_csv": "https://my-bucket-name.s3.eu-central-1.amazonaws.com/my_contact_videos.csv"
}