Cisco Cisco TelePresence MCU 4510 Developer's Guide
participant.add
Adds a participant to a conference. All participants in a conference must have a participantName that is
unique to the conference but it need not be unique across all conferences. Add the participant as type by_
address
unique to the conference but it need not be unique across all conferences. Add the participant as type by_
address
unless you are adding the participant to an ad hoc conference.
Send the addResponse parameter if you want the call to return the details of the added participant (in a
participant
participant
struct.)
Participants can be added before or during a conference. A participant which is added at any time via the API
will be added to the configured list of participants, and thus will be called at the start of the conference by the
MCU for any conference which has any sort of repetition; to avoid this, a participant must be removed
directly using participant.remove. Also, the MCU allows a maximum of 500 API-configured
participants, and participants will persist after conferences have ended unless you use
will be added to the configured list of participants, and thus will be called at the start of the conference by the
MCU for any conference which has any sort of repetition; to avoid this, a participant must be removed
directly using participant.remove. Also, the MCU allows a maximum of 500 API-configured
participants, and participants will persist after conferences have ended unless you use
.
Note: If a participantName matches the name of an endpoint in the list of configured endpoints (go to
Endpoints
in the web interface) the two are not necessarily related. This is because the MCU uses the
combination of both participantName and participantType to ensure unique participants.
Input parameters
Required inputs
Parameter name
Type
Short description
conferenceName
string
The name of the conference.
participantName
string
The unique name of a participant.
Optional or conditional inputs
All of the following parameters are optional, and control the conferencing behavior of the MCU with respect to
the endpoint in question; for example, the maximum resolution of the video streams used, or whether the
participant is able to control their conference view layout.
the endpoint in question; for example, the maximum resolution of the video streams used, or whether the
participant is able to control their conference view layout.
Parameter name
Type
Short description
addResponse
boolean
true
to return the details of the added participant.
participantProtocol
string
h323
, sip, or vnc.
participantType
string
One of: by_address or ad_hoc.
address (endpoint)
string (63) The address of the endpoint; may be hostname, IP address,
E.164 number, SIP URI, or H.323 ID.
gatewayAddress
string (63) The address of an H.323 gateway, if required. Only used if
protocol is h323. This corresponds to the address
parameter of the gateway as returned by
gateway.enumerate
parameter of the gateway as returned by
gateway.enumerate
.
useSIPRegistrar
boolean
Not valid unless the protocol is SIP. true if the endpoint
uses the SIP registrar. Defaults to false.
uses the SIP registrar. Defaults to false.
Cisco TelePresence MCU API 2.10
Page 103 of 296
API commands
participant.add