Migrating Recordings from External Systems

This guide provides you with instructions on how to use Zoom APIs to migrate historical recordings from external systems into Zoom Revenue Accelerator (ZRA).

You can use these Zoom Revenue Accelerator API endpoints for migration:

Before you begin

  • The ZRA APIs support these file formats: .mov, .mp4, .avi, .wmv, and H.264. You may need to convert the file format or associated metadata into a supported format for ZRA APIs to properly render the recordings. Note: If the original transcript is not uploaded, ZRA creates a transcript from the media file, though speaker identification results may vary based on the file format (e.g. mono or stereo format).
  • ZRA APIs accept JSON-formatted metadata and transcript files from Gong. For more details, refer to Supported metadata and transcript file formats.
  • (Optional, but recommended) - Uploading speaker timeline information allows for speaker attribution. Without it, ZRA labels speakers as Speaker 1, Speaker 2, and so on.

Prerequisites

For a successful migration, as an Account Admin, ensure that:

  • Your account has an active ZRA product plan.
  • Your account has been added to the upload whitelist ZRA APIs. To request Zoom add your account to the whitelist:
    • Send an email to your SE, CSM or Support with "ZRA Recording Migration - Whitelist for Upload request" in the subject line.
    • Specify the start and end date of your intended migration.
    • Limit your date range to 30 days. This process is required for product security reasons.
  • You have created a Server-to-Server (S2S) OAuth app in the Zoom Marketplace and added the appropriate ZRA scopes to the S2S App: iq_conversation:write:admin, iq_conversation:write.
    • You use the above credentials to authorize ZRA APIs.
  • Your API developer, has been assigned:
    • A paid ZRA license.
    • A ZRA Admin role. This role must have the Edit permission enabled for All Conversations.
    • Role or permission to access the Zoom Marketplace and create apps.

As an Account Admin, you can assign all users for whom you are migrating recordings with a paid ZRA license (any role that is not a ZRA External Admin or ZRA Collaborator).

You can now associate uploaded recordings with the provisioned users.

Methods to add recordings

There are three available methods to add recordings into Zoom Revenue Accelerator.

  • Use the Add Conversation API to directly upload a file and add a conversation into ZRA with a download_url to an active file service. We recommend using the host_id parameter to properly associate each conversation to the correct user when using this method.
  • Use the Upload File API to add conversations by uploading meeting recording files.This method requires multiple API calls
  • Use the Upload File API to upload existing transcript, participant, and speaker attribute files.

Best practice We strongly advise you to conduct a preliminary test of the procedure using a limited number of recordings. This will help ensure that the final outcomes align with your anticipated results before proceeding with widespread implementation.