Conference
ConferenceAction places the caller into a named conference room. The field set tracks the live PBX conference webhook contract and the canonical JSON
ConferenceAction places the caller into a named conference room. The field set tracks the live PBX conference webhook contract and the canonical JSON schema at docs/voice-actions.schema.json.
| Parameter | Type | JSON key | Required | Description |
|---|---|---|---|---|
Name | string | name | Yes | Name is the conference room identifier. Required. |
Flags | string | flags | No | Flags is raw conference flags (comma/space/pipe-separated). Forwarded verbatim to the PBX conference engine. |
MaxParticipants | int | maxParticipants | No | MaxParticipants caps the conference size. 0 means PBX default. |
Record | bool | record | No | Record requests recording of the conference. Default false. |
Beep | bool | beep | No | Beep plays an entry/exit tone. Default false. |
Muted | bool | muted | No | Muted places the caller in listen-only mode. Default false. |
StartOnEnter | *bool | startOnEnter | No | StartOnEnter starts the conference when this caller joins. Tri-state: nil = unset (PBX default), pointer to value otherwise. |
EndOnExit | bool | endOnExit | No | EndOnExit ends the conference when this caller leaves. |
WaitURL | string | waitUrl | No | WaitURL is the hold-music URL played before the conference starts. |
StatusEventsCallbackURL | string | statusEventsCallbackUrl | No | StatusEventsCallbackURL is the URL the PBX posts conference status events to (e.g. start/end/join/leave/mute/unmute). |
StatusEvents | string | statusEvents | No | StatusEvents is a space-separated list of conference event types to subscribe to (e.g. "start end join leave mute unmute"). |
CollectDigits | bool | collectDigits | No | CollectDigits enables in-conference DTMF collection. Default false. |
FinishOnKey | string | finishOnKey | No | FinishOnKey is the DTMF key that submits collected digits early (when CollectDigits=true). |
NumDigits | int | numDigits | No | NumDigits caps in-conference digit collection. 0 = unlimited. |
DigitsCallbackURL | string | digitsCallbackUrl | No | DigitsCallbackURL is the URL the PBX posts a DigitsCollected event to when in-conference DTMF is captured. |
import { sauti } from "@sautikit/node";
res.json(sauti.conference("support-room-42", {
muted: false,
beep: true,
startOnEnter: true,
endOnExit: false,
maxParticipants: 10,
}));{
"actions": [
{
"conference": {
"name": "support-room-42",
"muted": false,
"beep": true,
"startOnEnter": true,
"endOnExit": false,
"maxParticipants": 10
}
}
]
}<Conference muted="false" beep="true" startOnEnter="true" endOnExit="false" maxParticipants="10">support-room-42</Conference>