Cisco Cisco TelePresence MCU 4510 Developer's Guide

API reference 

Cisco TelePresence MCU API 2.8 

Page 65 of 120

 

maxMediaTxBitRate 

Integer 

Max media transmit bit rate. 

maxMediaRxBitRate 

Integer 

Max media receive bit rate. 

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.  
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. 

 If a participantName matches the name of an endpoint in the list of configured endpoints (go to 

 in the web interface) the two are treated as unrelated. This is because in the web 

interface named, configured, endpoints have the participantType value by_name, whereas API 

participants are of type by_address. 

 

conferenceName 

String 

The name of the conference to which to add the 

participant. 

participantName 

String 

The name of the participant to be added. This 

must be a unique value, i.e. not the same as any 

existing participant. Note that for ad_hoc 

participants, this is not used, but must be present 

otherwise. 

participantProtocol  

String 

If present, must be h323

, 

sip

 or 

vnc – these are 

the only protocols that the API can currently use. 

participantType  

String 

If present, must be by_address or ad_hoc. Note 

that if this conference is an ad_hoc conference, 

this value should also be ad_hoc. Ad hoc 

participants can only be added to active 

conferences. 

address 

string (< 64 

chars)  

The participant’s E.164 directory number, 

hostname or IP address. 

gatewayAddress  

string (< 64 

chars) 

IP address or hostname of an H.323 gateway. 

useSIPRegistrar  

Boolean 

Whether to use a registrar in making this a call. 

(Ignored if the protocol is not sip) 

transportProtocol  

String 

One of: default, tcp, udp or tls. (Ignored if the 

protocol is not SIP).