Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 296
conference.create
This call creates a new conference on the MCU. Conferences created via the API will appear in the list of
conferences accessible via the web interface, and vice versa.
This call returns an error if the total number of ports exceeds the maximum conference size (currently 80).
The maximum conference size check is also performed for reserved ports.
The MCU allows a maximum number of conferences, which varies by model as follows:
n
MCU 4200 Series, MCU 4500 Series, and MCU MSE 8420: 200 conferences maximum
n
MCU 5300 Series and MCU MSE 8510: 500 conferences maximum
Use
to remove unwanted conferences and thus avoid reaching this limit.
Input parameters
Required inputs
Provide a unique name when creating a conference.
Parameter name
Type
Short description
conferenceName
string
The name of the conference.
Optional or conditional inputs
Parameter name
Type
Short description
private
boolean
Defines whether the conference is public or private. true if
the conference is private. Corresponds to the Visibility
setting on the web UI, which can have the value Public or
Private.
joinAudioMuted
boolean
Audio mute on join.
joinVideoMuted
boolean
Video mute on join.
joinAGC
boolean
Whether AGC should be used by default for participants
joining this conference
enforceMaximumAudioPorts
boolean
Defines whether the conference enforces the
maximumAudioPorts
limit. Assumed to be true if absent.
enforceMaximumVideoPorts
boolean
Defines whether the conference enforces the
maximumVideoPorts
limit. Assumed to be true if absent.
templateName
string
The name of the template. When passed in a call, this
parameter identifies the template that is used for the
purpose of the call.
Pass either templateName or templateNumber if you want to create a conference based on a template.
You can omit both parameters to create the conference using the default template.
templateNumber
integer
An index that uniquely identifies the template. Template
numbers are not preserved when the MCU reboots.
Cisco TelePresence MCU API 2.10
Page 39 of 296
API commands
conference.create