This documentation is archived and is not being maintained.

ListVisitors Message

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Reports the visitors to a meeting in a conference center.

Component Type

XML Element

Request

ListVisitorsRequest

Reply

ListVisitorsReply

A caller must be a member of the Administrator role or be the Organizer that owns the meeting.

The returned data might not be accurate until a short time after the meeting ends.

This example shows how to determine who attended the Strategy meeting between 16:00:00 UTC and 18:00:00 UTC on July 28, 2000.

A TimeIntervalQuery represents a half-open interval. This query searches for all recordings that have a startTime greater than or equal to the startTime and less than the endTime defined in the TimeInterval element.

The following is a request sent to a conference center. Note that the mid value is the same value received when the meeting was created. deletedOK can be set to True because mid values are always unique across all meetings in the conference center, including deleted meetings.

<PlaceWareConfCenter authUser="apiuser" authPassword="Pa$$w0rd">
  <ListVisitorsRequest deletedOK="True">
    <StringQuery fieldName="mid" operator="=" value="bvntuc1ix4mr"/>
    <TimeIntervalQuery fieldName="startTime">
      <TimeInterval startTime="2000-07-28T16:00:00Z"
                    endTime="2000-07-28T18:00:00Z"/>
    </TimeIntervalQuery>
    <FieldList>
      <Name>endTime</Name>
      <Name>startTime</Name>
      <Name>userName</Name>
      <Name>vid</Name>
    </FieldList>
  </ListVisitorsRequest>
</PlaceWareConfCenter>

The following is a reply returned from the conference center and contains a list of attendants at the Strategy meeting between 16:00:00 UTC and 18:00:00 UTC.

<PlaceWareConfCenter>
  <ListVisitorsReply>
    <Visitor>
      <OptionList>
        <TimeOption name="endTime" value="2000-07-28T16:30:41Z"/>
        <TimeOption name="startTime" value="2000-07-28T16:07:20Z"/>
        <StringOption name="userName" value="ken"/>
        <StringOption name="vid" value="1kghubzjwdm23"/>
      </OptionList>
      <OptionList>
        <TimeOption name="endTime" value="2000-07-28T17:55:24Z"/>
        <TimeOption name="startTime" value="2000-07-28T17:00:40Z"/>
        <StringOption name="userName" value="ken"/>
        <StringOption name="vid" value="mx3gujcdhl45m"/>
      </OptionList>
    </Visitor>
   </ListVisitorsReply>
</PlaceWareConfCenter>

Ken connected at 16:07:20 UTC and disconnected at 16:30:41 UTC. Ken reconnected at 17:00:40 UTC and disconnected at 17:55:24 UTC. The userName is the same, but the vid is different for each session.

Show: