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 file format of a composed archive is 640x480 MP4 (H.264/AAC) video file.

You can configure archiving via the TokBox Account Portal. To save archives, you will need access to an Amazon S3 bucket, or a Windows Azure container. You can also download your files manually from the Account Portal. See Using an Amazon S3 bucket with OpenTok archiving and Using an Windows Azure container with OpenTok archiving to learn how to set configure archiving.

If you do not define 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 is unable to upload archives to your designated S3 or Azure storage , the file will be uploaded to OpenTok Cloud and stored there for 72 hours. You will also receive an email reporting the upload failure to the email address associated with the account.

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

You can use the Archive Beta tool to view the status or an archive, or you can configure a callback that receives archiving status messages. To define an archiving callback, log into your Account Portal and follow 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