Skip to main content

Interface: RecordingInfoResponse

Defined in: packages/sdk/src/types/generated/recording.ts:24

PHI-safe provenance metadata for the recording served by GET /recordings/chat/{chat_id}/audio.wav.

Returned by GET /recordings/chat/{chat_id}/info to drive the chat side-panel recording-info chip/popover. Every field is a scalar Recording column (or a value derived from one) — NEVER phone numbers, member names, message content, S3 bucket/key, Twilio account SID, presigned URLs, or key material. Display labels stay in the client; the API returns only the machine source token so i18n stays on the frontend.

twilioRecordingSid / twilioCallSid are staff-only diagnostics: the service leaves them None for non-superusers and the route serializes with response_model_exclude_none=True so the KEYS are absent (not null) from a non-superuser body — the fields are never sent then hidden.

Properties​

byteSize?​

optional byteSize: number | null

Defined in: packages/sdk/src/types/generated/recording.ts:35

capturedAt?​

optional capturedAt: string | null

Defined in: packages/sdk/src/types/generated/recording.ts:37

ISO8601 capture time: started_at ?? completed_at ?? created_at.

channels?​

optional channels: number | null

Defined in: packages/sdk/src/types/generated/recording.ts:31

completedAt?​

optional completedAt: string | null

Defined in: packages/sdk/src/types/generated/recording.ts:39

contentType?​

optional contentType: string | null

Defined in: packages/sdk/src/types/generated/recording.ts:34

durationMs?​

optional durationMs: number | null

Defined in: packages/sdk/src/types/generated/recording.ts:33

encryptedAtRest​

encryptedAtRest: boolean

Defined in: packages/sdk/src/types/generated/recording.ts:28

True only for a native Twilio recording captured under a registered recording-encryption key (both recording_key_version and twilio_public_key_sid present). Not a generic S3-SSE flag.

keyVersion?​

optional keyVersion: number | null

Defined in: packages/sdk/src/types/generated/recording.ts:30

Recording-encryption key version, when encrypted at rest.

sampleRate?​

optional sampleRate: number | null

Defined in: packages/sdk/src/types/generated/recording.ts:32

source​

source: RecordingInfoResponseSource

Defined in: packages/sdk/src/types/generated/recording.ts:26

Response-level provenance token, decoupled from the DB source string: one of twilio_native, captured_call, voicemail. The client maps this to a localized chip label.

startedAt?​

optional startedAt: string | null

Defined in: packages/sdk/src/types/generated/recording.ts:38

status​

status: string

Defined in: packages/sdk/src/types/generated/recording.ts:41

Recording lifecycle status (e.g. ready).

twilioCallSid?​

optional twilioCallSid: string | null

Defined in: packages/sdk/src/types/generated/recording.ts:45

Staff-only Twilio CallSid. Omitted for non-superusers.

twilioRecordingSid?​

optional twilioRecordingSid: string | null

Defined in: packages/sdk/src/types/generated/recording.ts:43

Staff-only Twilio RecordingSid. Omitted for non-superusers.