Skip to content

SIP PBX Queue Actions

Andrey Egorov edited this page May 16, 2026 · 3 revisions

Overview

The Queue resource controls daemon-owned queue placement, callback behavior, and queue statistics.

Operations

Operation Purpose Output branches
Put Leg In Queue Add a caller leg to a daemon-owned queue. Result
Set Callback Control whether queue callback mode is preserved after hangup. Result
Get Queue Stats Return queue-level or caller-level queue metrics. Result

Operation: Put Leg In Queue

Parameters

Parameter Required Description
Queue Ref Yes Public queue name. If omitted, resolves from item.json.ref, then item.json.sipPbx.ref.
Options -> Leg ID No Explicit caller leg. If omitted, resolves from current item leg metadata.
Options -> Placement No Back or Front.
Options -> Rejoin Existing No If enabled, an existing callback-preserved entry for the same caller is reused.
Options -> Retry Attempts No Maximum number of failed dispatch retries before the entry goes to Offline.
Options -> Retry Cooldown (Seconds) No Delay between failed dispatch retries.
Options -> Call Strategy No All In Parallel or Sequential for operator dispatch dialing.
Options -> Sequential Attempt Timeout (Seconds) No Timeout per sequential operator attempt.
Options -> Sequential Gap (Seconds) No Delay between sequential operator attempts.
Options -> Caller Number No Caller number override used by queue-owned operator dial attempts.
Options -> Caller Name No Caller display name override used by queue-owned operator dial attempts.
Options -> Custom SIP Headers No Extra SIP headers used by queue-owned operator dial attempts.

Output

Branch Fields
Result legId

Operation: Set Callback

Parameters

Parameter Required Description
Callback Enabled Yes If enabled, hanging up moves the queue entry into callback mode instead of removing it.
Options -> Leg ID No Explicit queue leg target. If omitted, resolves from current item leg metadata.

Output

Branch Fields
Result legId

Operation: Get Queue Stats

Parameters

Parameter Required Description
Target Yes Queue Ref or Leg ID.
Queue Ref Yes when Target = Queue Ref Queue to inspect. If omitted, resolves from item.json.ref, then item.json.sipPbx.ref.
Options -> Leg ID Yes when Target = Leg ID Caller leg to inspect. If omitted, resolves from current item leg metadata.

Output

Branch Typical fields
Result ref, size, averageWaitSeconds, completedCount, updatedAt, optional legId, optional position, optional estimatedAnswerSeconds

Clone this wiki locally