Rapport de fin d'appel
À la fin d’une session, Vizalia établit son rapport : horaires, conseiller, événements, photos, documents, mesures, réponses au questionnaire. C’est le rapport que lit le conseiller, en JSON ou dans le même PDF.
Quand il est prêt
Section intitulée « Quand il est prêt »report.status, dans la session, vaut pending tant que la session n’est pas terminée, puis available. Le webhook report.ready suit session.ended, parfois de quelques minutes : il annonce le rapport complet, résumé compris quand la transcription est active. Avant la fin de la session, la lecture répond 409 report_not_ready.
Le plus simple : abonnez-vous à report.ready, et lisez le rapport à sa réception.
# JSONcurl https://api.vizalia.ai/v1/sessions/$SESSION_ID/report \ -H "Authorization: Bearer $VIZALIA_API_KEY"
# PDF, en anglais, aux horaires de New Yorkcurl "https://api.vizalia.ai/v1/sessions/$SESSION_ID/report?format=pdf&lang=en&time_zone=America/New_York" \ -H "Authorization: Bearer $VIZALIA_API_KEY" \ --output rapport.pdfreport.url et report.pdf_url sont des routes de l’API : appelez-les avec votre clé, portée sessions:read.
lang:fr,en,es,deoupt, la langue du conseiller par défaut.time_zone: un fuseau IANA pour les horaires du PDF,Europe/Parispar défaut. Le JSON reste en UTC.- Le PDF se produit à la demande : s’il ne peut pas l’être tout de suite, l’API répond
503 report_renderer_unavailableou503 report_attachment_unavailableavecRetry-After; réessayez après ce délai. - Un espace peut interdire le téléchargement : le PDF répond alors
403 report_download_disabled, et les URL des photos sont nulles.
Le contenu JSON
Section intitulée « Le contenu JSON »Le rapport suit le contrat schema_version 1, celui du rapport de l’API historique. Les dates sont en UTC, les durées en secondes ; une collection vide est un tableau vide.
| Champ | Contenu |
|---|---|
schema_version |
Version du contrat, 1. |
generated_at |
Date de génération. |
media_urls_expire_at |
Échéance des URL temporaires des médias, une heure après la génération. |
pdf_url |
Lien du PDF de ce rapport, à appeler avec votre clé. |
intervention |
id, number, created_at, finish, champs personnalisés, horaires de l’appel et duration_seconds. |
operator |
Le conseiller : id, first_name, last_name, email. |
room |
L’espace : id, name et les intitulés de ses champs. |
contact |
Téléphone et e-mail de contact configurés pour le rapport. |
events |
Les événements visibles de l’appel, dans l’ordre. |
pictures |
Les photos : légende, date, lien de téléchargement, position. |
documents |
Les documents partagés : envoyé, téléchargé, à signer, signé, lien du PDF. |
measures |
Les mesures : libellé, dimensions, surface, incertitudes, image. |
answers |
Les réponses au questionnaire. |
impact |
Kilomètres et CO2 évités, ou null. |
geolocation, location |
L’option de géolocalisation de l’espace, et la position de l’appel, nulle sans elle. |
block_picture_download |
Vrai si l’espace interdit le téléchargement des photos et du PDF. |
Sur un document, to_sign dit que le modèle exige une signature, et signature que le client l’a validée : signature: false sur un document où to_sign est faux veut dire « n’avait pas à être signé », pas « non signé ».
Les URL des médias du rapport expirent comme les autres (Médias) : relisez le rapport pour les renouveler. Ses photos ne portent pas l’identifiant pho_… de la liste des photos.
