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

PBX ACD Call Queue Schema

Schema-ID
pbx_queue
Collection
pbx_queues
Permissions
  • Lesencall_queue_view
  • Anlegencall_queue_create
  • Änderncall_queue_edit
  • Löschencall_queue_delete

Felder

PBX ACD Call Queue Schema

pbx_queues4 Permissions

Schema for an ACD (Automatic Call Distribution) call queue in the FreeSWITCH PBX module

namestringerforderlich

Human-readable name for this queue

1–200 Zeichen
extensionNumberstringerforderlich

Extension number callers dial to reach this queue

strategystringoptional

Agent ring strategy for distributing incoming calls

RING_ALLROUND_ROBINLEAST_RECENTFEWEST_CALLSRANDOMLINEARBROADCAST
Default: "RING_ALL"nullable
maxWaitSecondsintegeroptional

Maximum time in seconds a caller waits before being removed from the queue

≥ 0nullable
maxQueueSizeintegeroptional

Maximum number of callers that can be queued at once

≥ 1nullable
announcePositionbooleanoptional

Whether to announce the caller's position in the queue

nullable
announceFrequencyintegeroptional

How often (in seconds) to announce position/wait time

≥ 10nullable
musicOnHoldstringoptional

Music-on-hold class or audio file reference

nullable
welcomePromptstringoptional

Audio file key played when caller enters the queue

nullable
memberExtensionIdsstring[]optional

List of pbx_extension IDs (UUIDs) that are members of this queue

nullable
wrapUpSecondsintegeroptional

Seconds an agent has after a call ends before receiving another (wrap-up time)

≥ 0nullable
isActivebooleanoptional

Whether this queue is active in FreeSWITCH

nullable
ringTimeoutPerMemberintegeroptional

Seconds to ring each member before moving to the next (LINEAR strategy)

5 – 120nullable
fallbackActionstringoptional

Action when all members exhausted or max wait time reached

VOICEMAILIVRQUEUEHANGUPFORWARD
nullable
fallbackTargetstringoptional

Target for fallback action (extension, IVR ID, queue ID, or external number)

nullable
pagingModebooleanoptional

When true with BROADCAST strategy, members auto-answer for one-way paging

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

Suche