...
What is in an archive?
The archive file is a single, compressed file (zip) that holds aggregated information about a conference, including data such as:
...
Archive files are kept on the platform until they are claimed, at which point they enter an expiration period. After a short delay (3 days by default), the archives are deleted.
The archive record (retrievable via the API) is a JSON object describing relevant associative data of the archive, including conference start and end dates, expert and participant information. The object structure is described in the CommunicationConferencesArchiveResponse
model in our API documentation.
...
GET /communication/archives/archives
lists all archive records of the tenant.GET /communication/archives/archives/{archiveId}
finds a single archive by its unique ID.GET /communication/archives/archives/{archiveId}/download
downloads the compressed archive file.POST /communication/archives/archives/{archiveId}/abandon
signals that an archive has been claimed. After an archive has been claimed it will be deleted from flexperto’s platform at a later point in time.POST /communication/notificationssubscriptions/notificationssubscriptions/webhook
affords registering a web hook that is triggered once an archive becomes available.
...
Assuming a conference has been recorded, and the archiving feature is enabled on the platform, flexperto creates an archive record and begins processing the relevant files. The archive goes through several states:
While the archive is being processed, the status field is
PROCESSING
. In this state, the compressed file is not yet available, and can not yet be downloaded via the/download
endpoint.Once all data has been aggregated, and the zip finalized, the status moves to
AVAILABLE
. Now the archive can be downloaded via the API.If there have been any failures in the process, the status is set to
FAILED
, and theerror
field describes the failure.When the
/abandon
endpoint has been called, the archive is scheduled for expiration. The status changes toABANDONED
. In the expiration period (which defaults to 3 days), the archive file can still be downloaded via the/download
endpoint.After the expiration period has passed, the archive record transitions to the
EXPIRED
status, and the file can no longer be downloaded via the/download
endpoint. The file is deleted from the flexperto platform.
When are archives deleted?
...