Skip to main content

Conference Rooms

Conference rooms provide multi-party audio bridges for meetings.

Purpose

Use this module to:

  • Create conference bridges
  • Configure PIN and host PIN protection
  • Enable recording and host controls
  • Set participant limits and entry behavior

Features

FeatureDescription
PIN ProtectionOptional numeric PIN required to join
Host PINSpecial PIN for host controls
RecordingRecord conference sessions
Auto-Start RecordingStart recording automatically when the conference begins
Wait for HostKeep participants on hold until the host joins
Mute on EntryAutomatically mute new participants
Announce Join/LeavePlay sounds when participants join or leave
Talk DetectionEmit webhooks when participants speak
Max ParticipantsLimit the number of simultaneous participants (2-1000)

Permissions

ActionOwnerPBX AdminPBX UserReporter
View conference roomsYesYesYesYes
Create conference roomsYesYesNoNo
Update conference roomsYesYesNoNo
Delete conference roomsYesYesNoNo

UI Workflow

Create a Conference Room

  1. Navigate to Conference Rooms in the sidebar
  2. Click Create Conference Room
  3. Enter a name and optional description
  4. Set the maximum number of participants
  5. Enable PIN protection and enter PINs if required
  6. Configure recording and host behavior
  7. Save

The room can then be assigned to an extension or used as a DID routing destination.

Key Data Fields

conference_rooms Table

ColumnTypeNotes
idbigintPrimary key
organization_idFKTenant scope
namestringUnique per org
descriptionstring nullable
max_participantsinteger2-1000
statusenumactive, inactive (uses UserStatus)
pinstring nullableNumeric, max 20
pin_requiredboolean
host_pinstring nullable
recording_enabledboolean
recording_auto_startboolean
recording_webhook_urlURL nullable
wait_for_hostboolean
mute_on_entryboolean
announce_join_leaveboolean
music_on_holdboolean
talk_detection_enabledboolean
talk_detection_webhook_urlURL nullableRequired when talk detection is enabled
MethodEndpointPurpose
GET/POST/PUT/DELETE/v1/conference-rooms[/{conferenceRoom}]Standard CRUD

See the OPBX REST API reference for full schemas.

  • Extensions — CONFERENCE type extensions link to rooms
  • Phone Numbers — DIDs can route to conference rooms
  • IVR Menus — IVR options can route to conference rooms