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.

What file format is used for composed archives?

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

How can I add a storage location for archives to be uploaded?

You can configure a cloud archiving storage location 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 configure these.

What happens if I don't have a cloud storage location set up? What happens if my archive fails to upload to S3/Azure?

If you do not define an Amazon S3 bucket or Windows Azure container, or if uploading to the specified bucket/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. You will also receive an email reporting the upload failure to the email address associated with the account.

When setting up the cloud storage endpoint in your account, you can optionally disable OpenTok cloud fallback. This may be required based on industry or government security policies. Please be aware that in case of failure, archives will not be recoverable.

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

You can use the Archive Inspector 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. 
  3. 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