Cisco Cisco TelePresence Management Suite (TMS) Version 15 Developer's Guide
Booking API reference
Cisco TMSBA Programming Reference Guide
Page 34 of 53
Participant
Attribute
Read/Write Description
ParticipantId
r/w –
optional
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.
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
optional
For external participants, the participant name for dial-ins, or the fully
qualified number to dial for dial-outs.
qualified number to dial for dial-outs.
For example:
n
A dial-in can be given the value Placeholder for John Doe.
n
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.
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:
n
CC=Country Code
n
AC=Area Code
n
BN=Base Number
If the country does not use Area Codes, that element can be omitted
completely, and the format would be +CC BN.
completely, and the format would be +CC BN.
ParticipantCallType r/w –
required
The participant type. Valid values are:
n
TMS, a TMS System Entity. When this is specified, the ParticipantId must
be the Cisco TMS System Entity ID as given in Cisco TMS.
be the Cisco TMS System Entity ID as given in Cisco TMS.
n
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 an ID (less than 0).
you may give the participant a name using the NameOrNumber field.
Cisco TMS will automatically give the participant an ID (less than 0).
n
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 an ID (less than 0).
may give the participant a name using the NameOrNumber field. Cisco
TMS will automatically give the participant an ID (less than 0).
n
IP Video -> or ISDN Video ->, an IP/ISDN video dial-out site. Specifying
this value requires providing Cisco TMS with the number to use in the
NameOrNumber field. (Formats: ISDN: +1 (555) 1231234, H.323 IP
E.164: 12312321, H323 IP Address: 10.0.0.10).
this value requires providing Cisco TMS with the number to use in the
NameOrNumber field. (Formats: ISDN: +1 (555) 1231234, H.323 IP
E.164: 12312321, H323 IP Address: 10.0.0.10).
n
IP Tel -> or Telephone ->, an IP/ISDN audio 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, H.323 IP E.164: 12312321, H.323 IP
Address: 10.0.0.10). Call will be placed using 64kbps/54kbps
depending on restrictions.
you must give Cisco TMS the number to use in the NameOrNumber field
(Formats: ISDN: +1 (555) 1231234, H.323 IP E.164: 12312321, H.323 IP
Address: 10.0.0.10). Call will be placed using 64kbps/54kbps
depending on restrictions.
n
TMS Master Participant, the conference master. When this entity is
specified, the ParticipantId must be the Cisco TMS System Entity ID as
given in Cisco TMS. It is only possible to specify a single Master
Participant per conference, which must be a Cisco TMS System.
specified, the ParticipantId must be the Cisco TMS System Entity ID as
given in Cisco TMS. It is only possible to specify a single Master
Participant per conference, which must be a Cisco TMS System.
User is not currently supported by the API.