Conference
Conference rooms let users in your organization and persons outside it meet by video and by phone. Persons join from a web browser or dial in.
For information about meetings in a room, refer to Telemedicine.
Conference Modes
The conference_mode field sets the limits of a room.
basic
Maximum room duration of 120 minutes
Maximum room size of 5 persons
advanced
Maximum room size of 25 persons
advanced mode is available only if your account has advanced conferencing. If it does not, we change the room to basic. If a basic room has a limit that is too high, we decrease the limit.
Note
A meeting stops after 5 hours, for all modes.
Conference Recording
You can record a room if your account has recording enabled. Set record_conference to true. We attach the recording to the call record of the meeting.
Room Access
Click the access info link next to a room to see how persons join it. There are two tabs.
- Participant:
Copy this information into an email or a calendar invitation. Persons who use it join as participants.
- Moderator:
This information is for moderators only. It includes the moderator PIN and the moderator link. Do not share it.
The access information includes:
The web link
The meeting ID
The access phone numbers, and one tap mobile numbers
The extension and the short name
Conference Parameters
These are the parameters of the conference object in our API that you can set, in the same order.
name
- Default:
empty
- Description:
The name of the conference room. The name must have 2 or more characters.
extension
- Default:
The next free extension
- Description:
The extension that users dial from their desk phone or mobile app to join the room. The extension must be a number and must be unique in the account.
For a room with a pbx_user_id, the extension is the same as the room_id.
shortname
- Default:
Made from the
name- Description:
A name that users can dial from their desk phone or mobile app.
room_id
- Default:
A 9-digit number that we make
- Description:
The permanent ID of the room. We use it in the web link and as the meeting ID. The room ID must be unique. If you give a room ID with more than 9 characters, we make a new one.
To get a new room ID for a personal room or a one-time room, recreate the room.
pbx_user_id
- Default:
empty
- Description:
The user who owns a personal room or a one-time room. The owner must have enable_telemedicine set to true.
When a room has an owner:
The moderator_pin is the same as the pin of the owner.
The owner is the only moderator. We remove all pbx_conference_moderators.
enable_public_access
- Default:
true
- Description:
Lets persons outside your organization join the room.
- true:
Persons can join from the web link, from guest invite links and from access phone numbers.
- false:
Only users of your organization can join. They join from the portal, or dial the extension or the short name.
start_locked
- Default:
false for a shared room, true for a room with a pbx_user_id
- Description:
Locks the room at the start of each meeting.
When the room is locked:
Moderators go directly into the room.
Other persons who join from a web browser wait until a moderator admits them.
Persons who join by phone go directly into the room. They are muted until a moderator joins.
moderator_pin
- Default:
A random 5-digit PIN
- Description:
The PIN that a moderator types when the moderator dials in from an access number.
moh
- Default:
empty
- Description:
This parameter has no effect on meetings.
conference_mode
- Default:
advancedif your account has advanced conferencing, elsebasic- Description:
The mode of the room. Refer to Conference Modes.
begins_at
- Default:
empty
- Description:
The start time of the room. Persons can join 15 minutes before this time. Before then, we refuse all persons. A room with a start time is a one-time room.
record_conference
- Default:
false
- Description:
Records the meeting. Your account must have recording enabled.
For a room with a pbx_user_id, the default is true if the owner records calls. Refer to call_recording.
max_participants
- Default:
5 for
basic, 25 foradvanced- Description:
The maximum number of persons in the room.
basicrooms are limited to 5.advancedrooms are limited to 25.
max_duration
- Default:
120
- Description:
The maximum length of one meeting, in minutes.
For a room with a begins_at time, we remove the room at the start time plus this duration.
moderator_grace_period
- Default:
2
- Description:
The number of minutes that an empty room stays open.
email_mod_on_participant
- Default:
false
- Description:
Sends an email to all moderators when a person joins the room and no moderator is present.
message_mod_on_participant
- Default:
false
- Description:
Sends an SMS to all moderators when a person joins the room and no moderator is present.
announce_arrivals
- Default:
false
- Description:
This parameter has no effect on meetings.
announce_departures
- Default:
false
- Description:
This parameter has no effect on meetings.
pbx_conference_moderators
- Default:
empty
- Description:
A list of the users who are moderators of the room.
Each item has this parameter:
- pbx_user_id:
The user who is a moderator.
A moderator can:
Admit or deny persons in the waiting room
Lock and unlock the room
Mute and remove participants
Start and stop captions and the recording
End the meeting
Important
A room with no moderators and no pbx_user_id makes all users in the account moderators.