Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The archive file is a single, compressed file (zip) that holds aggregated information about a conference, including data such as:

  • folder whiteboard:

    • whiteboard event history (JSON)

    • uploaded documents (binary)

    folder themis:

    • text-chat history (JSON)

    • uploaded files (binary)

    • multimedia recordings of video and audio tracks and shared screen (mp4)

    • metadata of the conference (JSON), including (but not limited to):

      • the tenant ID

      • moderator E-Mail, name, and account ID

      • participant E-Mails and names (when given), account IDs, and permissions

      • start and end date-time of the conference

  • folder mithra:

    • contracts signed via E-Signature as part of a conference (PDF), this does not include asynchronous contract sessions created on the dashboard

...

These API endpoints are relevant for the archiving process:

Colloquial Name

Endpoint

Description

list archive records

GET /communication/conferences/archives

Lists all available archive records of the tenant

get archive record

GET /communication/archives/archives/{archiveId}

Finds a single archive record by its unique ID.

download archive

GET /communication/archives/archives/{archiveId}/download

Downloads the compressed archive file.

abandon archive

POST /communication/conferences/conferences/{conferenceId}/archive/abandon

Abandons an archive, which signals that it has been claimed. After an archive has been abandoned, it is marked for deletion, which is triggered three days after abandoning it.

register webhook

POST /communication/subscriptions/subscriptions/webhook

Registers a webhook that is triggered once an archive becomes available.

Info

These endpoints can only be accessed by via API token by authenticated admins of the platform.

...