Skip to main content

Snapshot API changes

· 3 min read
Stefan Benicke

This change affects Custom UIs using Eyeson Javascript or one of the mobile SDKs.

When a new snapshot is created, the update event will only include a list with the latest snapshots instead of all existing snapshots of the current meeting.

caution

The old snapshot behaviour will shut down on 11th of September.

Furthermore, there will be 2 new API endpoints for retrieving the most recent snapshot information.

{
  type: 'snapshot_update',
  snapshots: [
    {
      created_at,
      creator: { /* ... */ },
      id,
      links: { download }
      name,
      room: { /* ... */ }
    }
  ]
}

List of snapshots will contain only the new created snapshots

The reason for the change is the expiration of download links. Until now, with every snapshot creation, the list of snapshots was updated with new download links. That means, when no new snapshot is created, the existing download links could become invalid.

This is changing to provide reliable download links whenever needed!

Again, the new snapshot list will only contain the new created snapshots! They already have a download link that can be used to show a thumbnail for example.

New API endpoints​

We provide two new API endpoints for better working with snapshots.

Single snapshot information​

When a recent download link is needed, for example if you want to download or share a snapshot some time after its creation, make a request to the new snapshots API endpoint.

GET /rooms/<access_key>/snapshots/<snapshot_id>
  RESPONSES 200 OK, 404 NOT FOUND

With Javascript you can use the new function eyeson.core.comApi.getSnapshot(id, callback).

import eyeson from 'eyeson';

const openSnapshot = id => {
    eyeson.core.comApi.getSnapshot(id, data => {
        if (data.error) {
            console.error(data.error);
            return;
        }
        // example usage
        window.open(data.links.download, '', 'popup');
    });
};

Read more about snapshot usage:

List of all snapshots of a certain room​

In the same way as recordings, you can retrieve a list of all snapshots of a certain room using the API key.

GET /rooms/<room_id>/snapshots
  HEADERS Authorization
  RESPONSES 200 OK, 404 NOT FOUND, 403 UNAUTHORIZED
ParametersTypeDescription
pageInteger (optional)Fetch next set of snapshots (limit is 25)
started_atISO8601 Timestamp (optional)Filter for a certain room instance (compare to started_at in room response)

Contact​

If you have a question or want to share any feedback, do not hesitate to create a ticket on GitHub.