How does archiving work and how can I configure it?

The OpenTok platform allows you to record the sessions generated in your application. You can do this through the OpenTok REST API or one of the OpenTok Server SDKs.

The current output of composed archive is 640x480 MP4 (H.264/AAC) video file.

You can configure the recording or your sessions via the TokBox Account page. You will need to own an Amazon S3 bucket, a Windows Azure container or download your files manually. See Using an Amazon S3 bucket with OpenTok archiving and Using an Windows Azure container with OpenTok archiving to learn how to set up your archiving configuration.

If you do not set an Amazon S3 bucket or Windows Azure container, or if uploading to the specified bucket or container fails, recorded archives are available for retrieval from download from the OpenTok cloud. Archives made available on the OpenTok cloud are available for 72 hours from the time they are created.

What happens if my S3 or Azure storage is not available?

If OpenTok unable to upload archives to your designated S3 or Azure storage (for example, because of the problem with credentials), the file will be uploaded to OpenTok Cloud and stored there for 72 hours, we will also send you an automatic failure email with the archive details.

How can I know when the archive is uploaded or available?

In our account you can specify the archiving callback URL by following these steps:

1- In your TokBox Account page, locate the project you want to configure in the left side navigation bar.

2- Navigate to the "Archives" section. 

4- Click "Configure" under Callback URL and enter the desired URL.

For every status change of the archive we will send a POST request to the specified URL with archive details.

Have more questions? Submit a request