Cisco Cisco TelePresence MCU 4510 Developer's Guide
participant.status
Returns information about an individual participant.This call returns a participant struct as described in
, containing information about the participant identified by the call.
A fault code of “no such participant” is returned if the participant does not exist.
Note: The device will respond to participant.status if you omit operationScope. However, this
behavior is deprecated and may not be supported in future versions. See
behavior is deprecated and may not be supported in future versions. See
for details.
Input parameters
Required inputs
Parameter name
Type
Short description
conferenceName
string
The name of the conference.
If the participant is in a conference, the call requires the conferenceName; if the participant is in an
autoattendant, the call requires the autoAttendantUniqueId instead. The call does not require both
parameters.
autoattendant, the call requires the autoAttendantUniqueId instead. The call does not require both
parameters.
autoAttendantUniqueID
string
Unique identifier for the auto attendant.
participantName
string
The unique name of a participant.
participantProtocol
string
h323
, sip, or vnc.
participantType
string
One of: by_address, by_name, or ad_hoc.
operationScope
array
The array should contain one or two string parameters.
That is, it should contain either or both of the strings
currentState
That is, it should contain either or both of the strings
currentState
or configuredState.
Returned data
Conditionally returned
The response struct may contain the following data:
Parameter name
Type
Short description
participantName
string
The unique name of a participant.
participantProtocol
string
h323
, sip, or vnc.
participantType
string
One of: by_address, by_name, or ad_hoc.
conferenceName
string
The name of the conference.
If the participant is in a conference, the response includes the conferenceName; if the participant is in an
autoattendant, the response includes the autoAttendantUniqueId instead. The response will not
include both parameters.
autoattendant, the response includes the autoAttendantUniqueId instead. The response will not
include both parameters.
autoAttendantUniqueID
string
Unique identifier for the auto attendant.
Cisco TelePresence MCU API 2.10
Page 139 of 296
API commands
participant.status