API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · pbx_voicemails

PBX Voicemail Message Schema

Schema-ID
pbx_voicemail
Collection
pbx_voicemails
Permissions
  • Lesenpbx_voicemail_view
  • Anlegenpbx_voicemail_create
  • Ändernpbx_voicemail_edit
  • Löschenpbx_voicemail_delete

Felder

PBX Voicemail Message Schema

pbx_voicemails4 Permissions

Schema for a voicemail message left on a PBX extension

extensionIduuiderforderlich

UUID of the pbx_extension this voicemail was left on

callerNumberstringerforderlich

Phone number of the caller who left the voicemail

durationSecondsnumbererforderlich

Duration of the voicemail message in seconds

≥ 0
fileKeystringerforderlich

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

read-only
isReadbooleanerforderlich

Whether this voicemail has been listened to / marked as read

callerNamestringoptional

Caller name resolved from PBX directory or CRM

nullable
transcriptTextstringoptional

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

nullable
transcriptStatusstringoptional

Current status of the transcription job

Werte
PENDINGPROCESSINGDONEFAILED
nullable
partyIduuidoptional

UUID of the linked party (customer/contact) resolved from the caller number

nullable
phoneCallIduuidoptional

UUID of the phone_call entity associated with this voicemail

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_voicemails — Liste, paginiert + filterbar
  • GET /api/v1/pbx_voicemails/<id> — Einzelne Entity
  • POST /api/v1/pbx_voicemails — Anlegen
  • PATCH /api/v1/pbx_voicemails/<id> — Teil-Update
  • DELETE /api/v1/pbx_voicemails/<id> — Soft-Delete
  • GET /api/v1/pbx_voicemails/<id>/timeline — Audit + Aktivitäten

Suche