Fetch active recording

client.RealtimeKit.Recordings.GetActiveRecordings(ctx, appID, meetingID, query) (*RecordingGetActiveRecordingsResponse, error)

GET/accounts/{account_id}/realtime/kit/{app_id}/recordings/active-recording/{meeting_id}

Returns the active recording details for the given meeting ID.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Realtime AdminRealtime

ParametersExpand Collapse

appID string

The app identifier tag.

maxLength32

meetingID string

query RecordingGetActiveRecordingsParams

AccountID param.Field[string]

The account identifier tag.

maxLength32

ReturnsExpand Collapse

type RecordingGetActiveRecordingsResponse struct{…}

Data RecordingGetActiveRecordingsResponseData

Data returned by the operation

ID string

ID of the recording

formatuuid

AudioDownloadURL string

If the audio_config is passed, the URL for downloading the audio recording is returned.

formaturi

DownloadURL string

URL where the recording can be downloaded.

formaturi

DownloadURLExpiry Time

Timestamp when the download URL expires.

formatdate-time

FileSize float64

File size of the recording, in bytes.

InvokedTime Time

Timestamp when this recording was invoked.

formatdate-time

OutputFileName string

File name of the recording.

SessionID string

ID of the meeting session this recording is for.

formatuuid

StartedTime Time

Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time.

formatdate-time

Status RecordingGetActiveRecordingsResponseDataStatus

Current status of the recording.

One of the following:

const RecordingGetActiveRecordingsResponseDataStatusInvoked RecordingGetActiveRecordingsResponseDataStatus = "INVOKED"

const RecordingGetActiveRecordingsResponseDataStatusRecording RecordingGetActiveRecordingsResponseDataStatus = "RECORDING"

const RecordingGetActiveRecordingsResponseDataStatusUploading RecordingGetActiveRecordingsResponseDataStatus = "UPLOADING"

const RecordingGetActiveRecordingsResponseDataStatusUploaded RecordingGetActiveRecordingsResponseDataStatus = "UPLOADED"

const RecordingGetActiveRecordingsResponseDataStatusErrored RecordingGetActiveRecordingsResponseDataStatus = "ERRORED"

const RecordingGetActiveRecordingsResponseDataStatusPaused RecordingGetActiveRecordingsResponseDataStatus = "PAUSED"

StoppedTime Time

Timestamp when this recording was stopped. Optional; is present only when the recording has actually been stopped.

formatdate-time

RecordingDuration int64Optional

Total recording time in seconds.

Success bool

Success status of the operation

Fetch active recording

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/realtime_kit"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  response, err := client.RealtimeKit.Recordings.GetActiveRecordings(
    context.TODO(),
    "app_id",
    "meeting_id",
    realtime_kit.RecordingGetActiveRecordingsParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "audio_download_url": "https://example.com",
    "download_url": "https://example.com",
    "download_url_expiry": "2019-12-27T18:11:19.117Z",
    "file_size": 0,
    "invoked_time": "2019-12-27T18:11:19.117Z",
    "output_file_name": "output_file_name",
    "session_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "started_time": "2019-12-27T18:11:19.117Z",
    "status": "INVOKED",
    "stopped_time": "2019-12-27T18:11:19.117Z",
    "recording_duration": 0
  },
  "success": true
}

Returns Examples

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "audio_download_url": "https://example.com",
    "download_url": "https://example.com",
    "download_url_expiry": "2019-12-27T18:11:19.117Z",
    "file_size": 0,
    "invoked_time": "2019-12-27T18:11:19.117Z",
    "output_file_name": "output_file_name",
    "session_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "started_time": "2019-12-27T18:11:19.117Z",
    "status": "INVOKED",
    "stopped_time": "2019-12-27T18:11:19.117Z",
    "recording_duration": 0
  },
  "success": true
}