CallRecording

An audio recording of a voice call with metadata, storage location, and processing status.

Properties

• id (string): Unique identifier for the recording.
• call ([[Call]]): The call this recording belongs to.
• assistant ([[VapiAssistant]]): The assistant that handled the call.
• phoneNumber ([[VapiPhoneNumber]]): Phone number used for the call.
• status (string): Recording status (processing, completed, failed, deleted).
• url ([[URL]]): URL to access the recording file.
• secureUrl ([[URL]]): Secure, time-limited URL for downloading.
• format (string): Audio format (mp3, wav, ogg, m4a).
• codec (string): Audio codec used.
• sampleRate (number): Audio sample rate in Hz.
• bitrate (number): Audio bitrate in kbps.
• channels (number): Number of audio channels (1 = mono, 2 = stereo).
• duration (number): Recording duration in seconds.
• fileSize (number): File size in bytes.
• startTime (number): Recording start timestamp (Unix timestamp).
• endTime (number): Recording end timestamp (Unix timestamp).
• storage (string): Storage provider (s3, gcs, azure, cloudflare-r2).
• storagePath (string): Path in storage system.
• bucket (string): Storage bucket name.
• region (string): Storage region.
• encrypted (boolean): Whether recording is encrypted at rest.
• encryptionKey (string): Encryption key identifier.
• redacted (boolean): Whether PII has been redacted from audio.
• redactionType (string): Redaction method (silence, beep, deletion).
• transcript ([[CallTranscript]]): Associated call transcript.
• hasTranscript (boolean): Whether transcript is available.
• participants (object[]): Call participants and their speaking time.
• speakerDiarization (boolean): Whether speakers are separated in recording.
• noiseReduction (boolean): Whether noise reduction was applied.
• volumeNormalization (boolean): Whether volume was normalized.
• silenceRemoval (boolean): Whether silent periods were removed.
• compressionRatio (number): Audio compression ratio.
• quality (string): Audio quality (low, medium, high, lossless).
• downloadCount (number): Number of times downloaded.
• lastAccessed (number): Last access timestamp (Unix timestamp).
• expiresAt (number): Expiration timestamp (Unix timestamp).
• retentionPeriod (number): Retention period in days.
• autoDeleteAt (number): Scheduled deletion timestamp (Unix timestamp).
• tags (string[]): Tags for categorization.
• metadata (object): Custom key-value pairs for additional data.
• created (number): Timestamp when recording was created (Unix timestamp).
• updated (number): Timestamp of last update (Unix timestamp).

Actions

create

Create a new recording.

Input: [[RecordingRequest]]
Output: [[CallRecording]]

retrieve

Retrieve recording details.

Input: [[CallRecording]]
Output: [[CallRecording]]

update

Update recording metadata.

Input: [[CallRecording]]
Output: [[CallRecording]]

delete

Delete the recording.

Input: [[CallRecording]]
Output: [[CallRecording]]

download

Download the recording file.

Input: [[CallRecording]]
Output: [[AudioFile]]

generateSecureUrl

Generate time-limited secure URL.

Input: [[UrlRequest]]
Output: [[URL]]

transcribe

Generate transcript from recording.

Input: [[CallRecording]]
Output: [[CallTranscript]]

analyze

Analyze recording for insights.

Input: [[AnalysisRequest]]
Output: [[CallAnalytics]]

redactPII

Redact PII from audio.

Input: [[RedactionRequest]]
Output: [[CallRecording]]

compress

Compress recording to smaller size.

Input: [[CompressionRequest]]
Output: [[CallRecording]]

convert

Convert to different audio format.

Input: [[ConversionRequest]]
Output: [[CallRecording]]

trim

Trim recording to specific time range.

Input: [[TrimRequest]]
Output: [[CallRecording]]

merge

Merge multiple recordings.

Input: [[MergeRequest]]
Output: [[CallRecording]]

enhanceQuality

Enhance audio quality.

Input: [[EnhancementRequest]]
Output: [[CallRecording]]

export

Export recording with metadata.

Input: [[ExportRequest]]
Output: [[URL]]

share

Generate shareable link.

Input: [[ShareRequest]]
Output: [[URL]]

Events

• created: Triggered when recording is created.
• processing: Triggered when processing begins.
• completed: Triggered when recording is ready.
• failed: Triggered when recording fails.
• updated: Triggered when metadata is modified.
• deleted: Triggered when recording is deleted.
• downloaded: Triggered when recording is downloaded.
• transcribed: Triggered when transcription completes.
• analyzed: Triggered when analysis completes.
• redacted: Triggered when PII is redacted.
• compressed: Triggered when compression completes.
• expired: Triggered when recording expires.
• autoDeleted: Triggered when auto-deletion occurs.