Conference
Put the caller into a named conference room.
Put the caller into a named conference room.
conference puts the caller into a named conference room. Everyone who joins the same room name can hear each other.
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The room to join. |
maxParticipants | integer | No | Largest number of callers in the room. 0 or omitted uses the default. |
muted | boolean | No | true lets this caller listen but not speak. |
beep | boolean | No | Play a tone when someone joins or leaves. |
startOnEnter | boolean | No | Start the conference when this caller joins. Leave it out for the default. |
endOnExit | boolean | No | End the conference for everyone when this caller leaves. |
waitUrl | string | No | Hold music played until the conference starts. |
record | boolean | No | Record the conference. |
statusEventsCallbackUrl | string | No | URL that Sautikit POSTs conference events to, such as start, end, join and leave. |
statusEvents | string | No | The events you want, separated by spaces, for example start end join leave mute unmute. |
collectDigits | boolean | No | Let the caller enter keypad digits while in the conference. |
numDigits | integer | No | With collectDigits: stop after this many digits. 0 means no limit. |
finishOnKey | string | No | With collectDigits: the key that submits the digits early. |
digitsCallbackUrl | string | No | URL that Sautikit POSTs a DigitsCollected event to when digits are entered. |
flags | string | No | Advanced. Conference flags, separated by commas, spaces or pipes. |
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>Build a call center with conferences shows rooms in use.