Cloud recording

Cloud recording is a feature that allows you to record participants' audio and video in both direct calls and group call rooms. For group calls only, you can download the recorded file from Sendbird Dashboard or copy the file from Sendbird's S3 storage to your S3 storage in the same region. You can also directly save the cloud recordings to your S3 storage whenever they're created.

To use this feature, you need to activate the feature on the dashboard first. For a detailed guide, refer to Cloud recording on the Group Call page of each SDK platform.

Note: Downloading recorded files is only available for group calls. If the recorded file is saved directly to your own S3 storage, it can't be downloaded or copied from the Sendbird server.

The following tables show the list of properties in a cloud recording resource.

• API endpoints are relative to the base URL allocated to your application. In this page, the /cloud-recordings endpoint refers to https://api-{application_id}.calls.sendbird.com/v1/cloud-recordings.

Note: To get your application ID, sign in to your dashboard, go to the Settings > Application > General, and then check the Application ID.

• It's recommended that the parameter values such as {recording_id} in API URLs be URL encoded.

The API to copy a recording file to your AWS S3 storage is available. When you call this API, the file you would like to transfer will be copied to an AWS S3 storage you provide which must be in the same AWS region as your Sendbird application.

To view the image in full screen, click on the

Only the files that are in Completed status can be copied to your storage. You can check the file status on Group calls on Sendbird Dashboard.

Note: When a recording file is uploaded to the storage you specified, the total size of the file will be automatically split into 5MB per request for optimal data transfer. Charges incur per number of requests against the specified storage as listed on the Requests & data retrievals section.

Before calling the following API to copy a recording file to your AWS storage, you need to create IAM policies in your AWS account to access the storage by setting s3:PutObject and s3:ListBucket as shown below. If you specify a storage without attaching the two permissions, an error will return.

To securely copy the file to the S3 storage, it is recommended that the AWS account only allows these two permissions. For a detailed guide, visit the Creating IAM policies (console) page.

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Action": [
                "s3:PutObject",
                "s3:ListBucket"
            ],
            "Resource": [
                "arn:aws:s3:::{bucket_name}/*",
                "arn:aws:s3:::{bucket_name}",
            ]
        }
    ]
}

POST https://api-{application_id}.calls.sendbird.com/v1/cloud-recordings/{recording_id}/copy

The following table lists the parameters that this action supports.

{
    "access_key": "my_access_key",
    "secret_key": "my_secret_key",
    "bucket": "my-bucket",
    "region": "us-west-2",
    "recording_file_directory": "test/"
}

If successful, this action returns information of a recording file that has been copied to your AWS storage in the response body.

{
    "recording_id": "f56ee376-b6ee-4ea4-a523-f3ba87653a3e",
    "bucket": "my-bucket",
    "key": "test/230209_041500_f56ee376-b6ee-4ea4-a523-f3ba87653a3e.mp4"
}

You can uploade a recorded file of a direct call or group call directly to your AWS S3 storage. Whenever a new recording file is created, it's automatically sent to the specified S3 bucket on your AWS account. Since Sendbird's storage doesn't store any recorded files, you can manage the files more securely and safely in your own storage.

Cross account access allows you to grant permission for other users and services of another AWS account to use resources in your AWS account. This feature allows the Sendbird server to upload files directly to your S3 storage, which ensures seamless integration between accounts without compromising security.

To view the image in full screen, click on the

To gain cross account access, you must create an IAM role with appropriate permissions. The IAM role needs to have the following actions in the target S3 storage in order to upload the recorded files.

s3:ListBucket
s3:ListMultipartUploadParts
s3:ListBucketMultipartUploads
s3:AbortMultipartUpload
s3:GetObject
s3:Put*

Granting external ID makes it easy to control the conditions in which cross account access is permitted. This provides better security protection as described in the external ID guide.