Cisco Cisco TelePresence Management Suite (TMS) Version 15 Developer's Guide

Booking API reference 

Cisco TMS Extension Booking API Programming Reference Guide (13.0.1) 

Page 20 of 33 

 

 

Participants 

r/w, required 

List of conference participants. When calling 
getdefaultconference, the participant list will be empty. 

RecordedConferenc
eUri 

r – only used when getting 
conference from Cisco TMS 

If the conference is recorded, this is the URI of the conference 
recording. 

WebConferencePre
senterUri 

r – only used when getting 
conference from Cisco TMS 

If the conference includes a web conference, this is the URI of 
the presenters web conference. 

WebConferenceAtte
ndeeUri 

r – only used when getting 
conference from Cisco TMS 

If the conference includes a web conference, this is the URI of 
the attendee web conference. If this field and 
webconferencepresenteruri is the same, they will both include 
the same information 

ISDNBandwidth   

r/w - optional – if not 
specified, Default is 
assumed 

The ISDN bandwidth of the conference 

IPBandwidth 

r/w - optional – if not 
specified, Default is 
assumed 

The IP bandwidth of the conference 

ParticipantId 

r/w – optional 

For Cisco TMS System Entities, this value must be the 
SystemId of the system. For external participants this value 
may be set, but is not required. If not set for external 
participants, Cisco TMS will create an ID with an integer less 
than 0. 
 

NameOrNumber 

r/w – optional 

For external participants, the participant name for dial-ins, or 
the fully quailed number to dial for dial-outs. For example, dial-
in can be given the value ‘Placeholder for John Doe’, whereas 
an ISDN dial-out would be given the value ‘+1 (555) 1231234’. 
This value is required for external dial-out participants, and 
must be the fully qualified number to dial.  Fully qualified 
numbers are of the format +CC (AC) BN  where CC=Country 
Code, AC=AreaCode, BN=Basenumber.  If the country does 
not use Area Codes, that element can be omitted completely 
and the format would be +CC BN. 

ParticipantCallType 

r/w – required 

The participant type. Valid values are: 
TMS – A TMS System Entity. When this is specified, the 
ParticipantId must be the Cisco TMS System Entity ID as given 
in Cisco TMS. 
IP Video <- or ISDN Video <- - An IP/ISDN video dial-in. If 
this is specified, you may give the participant a name using the 
NameOrNumber field. Cisco TMS will automatically give the 
participant and ID (less than 0) 
IP Tel <- or Telephone <- - An IP/ISDN audio dial-in. If this is 
specified, you may give the participant a name using the 
NameOrNumber field. Cisco TMS will automatically give the 
participant and ID (less than 0) 
IP Video -> or ISDN Video -> – An IP/ISDN video dial-out 
site. If this is specified, you must give Cisco TMS the number 
to use in the NameOrNumber field (Formats: ISDN: +1 (555) 
1231234, H323 IP E.164: 12312321, H323 IP Address: 
10.0.0.10). 
IP Tel -> or Telephone -> – An IP/ISDN audio dial-out site. If