Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 296
participant.status (deprecated)
Note: The participant.status call now requires the operationScope parameter in the call. This
topic explains the response of the device when you omit operationScope. This use of the call is
deprecated and may not be supported in future versions. See
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.
Input parameters
Required inputs
Parameter name
Type
Short description
participantName
string
The unique name of a participant.
participantType
string
One of: by_addressby_name, or ad_hoc.
participantProtocol
string
h323
sip, or vnc.
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.
autoAttendantUniqueID
string
Unique identifier for the auto attendant.
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_addressby_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
Cisco TelePresence MCU API 2.10
Page 147 of 296
API commands
participant.status (deprecated)