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

PBX Extension Schema

Schema-ID
pbx_extension
Collection
pbx_extensions
Permissions
  • Lesenpbx_extension_view
  • Anlegenpbx_extension_create
  • Ändernpbx_extension_edit
  • Löschenpbx_extension_delete

Felder

PBX Extension Schema

pbx_extensions4 Permissions

Schema for a user extension (one per user) in the FreeSWITCH PBX module

extensionNumberstringerforderlich

Internal extension number (1–6 digits)

Pattern
displayNamestringerforderlich

Display name shown in calls and directory

1–200 Zeichen
userIduuidoptional

UUID of the linked user account

nullable
sipUserstringoptional

Auto-generated SIP username for FreeSWITCH registration (protected field)

read-onlynullable
voicemailEnabledbooleanoptional

Whether voicemail is enabled for this extension

nullable
voicemailPinstringoptional

Voicemail PIN (4–6 digits)

Patternnullable
doNotDisturbbooleanoptional

Do Not Disturb flag — all calls go directly to voicemail when enabled

nullable
forwardEnabledbooleanoptional

Whether call forwarding is active for this extension

nullable
forwardTargetstringoptional

Target number or extension for call forwarding

nullable
forwardTypestringoptional

When to apply call forwarding

Werte
UNCONDITIONALBUSYNO_ANSWER
nullable
callRecordingEnabledbooleanoptional

Whether calls on this extension are automatically recorded

nullable
ringTimeoutintegeroptional

Seconds to ring before going to voicemail or forwarding

5 – 120nullable
isActivebooleanoptional

Whether this extension is active in FreeSWITCH

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

Suche