Entity · pbx_recordings

PBX Call Recording Schema

Schema-ID

pbx_recording

Collection

pbx_recordings

Permissions

Lesencall_recording_view
Anlegencall_recording_create
Änderncall_recording_edit
Löschencall_recording_delete

Felder

PBX Call Recording Schema

pbx_recordings4 Permissions

Schema for a call recording entity created by the FreeSWITCH PBX module

phoneCallIduuiderforderlich

UUID of the phone_call entity this recording belongs to

directionstringerforderlich

Direction of the recorded call

Werte

INBOUNDOUTBOUND

durationSecondsnumbererforderlich

Duration of the recording in seconds

≥ 0

fileKeystringerforderlich

S3/MinIO object key where the recording file is stored (protected field)

read-only

consentGivenbooleanerforderlich

Whether explicit consent was obtained before recording (required for GDPR compliance)

fileSizenumberoptional

File size in bytes

≥ 0nullable

transcriptTextstringoptional

Full transcript text generated by speech-to-text (STT)

nullable

transcriptStatusstringoptional

Current status of the transcription job

Werte

PENDINGPROCESSINGDONEFAILED

nullable

deletedAfterdatetimeoptional

Retention date — the recording will be deleted after this timestamp (ISO 8601)

nullable

partyIduuidoptional

UUID of the linked party (customer/contact)

nullable

extensionIduuidoptional

UUID of the pbx_extension that participated in this recording

nullable

formatstringoptional

Audio file format of the recording

Werte

WAVMP3OGG

nullable

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

GET /api/v1/pbx_recordings — Liste, paginiert + filterbar
GET /api/v1/pbx_recordings/<id> — Einzelne Entity
POST /api/v1/pbx_recordings — Anlegen
PATCH /api/v1/pbx_recordings/<id> — Teil-Update
DELETE /api/v1/pbx_recordings/<id> — Soft-Delete
GET /api/v1/pbx_recordings/<id>/timeline — Audit + Aktivitäten