report-meeting-session-users

Search
Adobe Connect User Guide
Applies to: Adobe Connect

某些 Creative Cloud 应用程序、服务和功能在中国不可用。

Fetch information about a specific user-session of a meeting session.

Availability

Adobe Connect 8.1

Description

Provides information about all the user sessions for an Adobe Connect meeting session. A user session is created when a participant enters a meeting session. As more participants join the meeting, they join the meeting session. The user session ends when the user leaves the meeting session. When a new participant enters an empty meeting, a new meeting session and new user session is started.

Request URL

http://server_name/api/xml 
?action=report-meeting-session-users 
&sco-id=integer 
&asset-id=integer 
&filter-definition=value 
&sort-definition=value 
&session=BreezeSessionCookieValue

Parameters

Name

Type

Required

Description

sco-id

BIGINT

Y

The ID of a meeting for which you want user session information.

asset-id

BIGINT

Y

The ID of the meeting session. As returned by report-meetings-sessions.

filter-definition

Filter definition

N

A filter to reduce the volume of the response.

sort-definition

Filter definition

N

A sort to return results in a certain sequence.

session

String

N

The value of the BREEZESESSION cookie. Use this parameter if you do not use a client-side cookie management library.

Filters

You can filter or sort the response on any element or attribute it contains.

Response structure

<?xml version="1.0" encoding="utf-8"?> 
<results> 
                <status code="ok"/> 
                <report-meeting-session-users> 
                                <row principal-id=integer> 
                                                <principal-name>string</principal-name> 
                                                <date-created>datetime</date-created> 
                                                <date-end>datetime</date-end> 
                                </row> 
                                ... 
                </report-meeting-session-users> 
</results>

Response values

Element

Attribute

Type

Description

results

 

Container

All results that the action returns.

status

 

Empty, with attributes

The status of the response.

 

code

Allowed value

A code indicating the response status (see status).

report-meeting-session-users

 

Container

The list of user-sessions for the meeting session.

row

 

Container

The information for one user-session.
  principal-id BIGINT Unique ID of a user/participant.

principal-name

 

String

Name of a user/participant.

date-created

 

Datetime

The date and time the user-session was created when the participant entered the meeting session.

date-end

 

Datetime

The date and time the user-session ended when the participant exited the meeting session.

Sample request

https://example.com/api/xml?action=report-meeting-session-users&sco-id=2006811328&asset-id=446653455

Sample response

<?xml version="1.0" encoding="utf-8"?> 
<results> 
                <status code="ok"/> 
                <report-meeting-session-users> 
                                <row principal-id="52904333"> 
                                                <principal-name>John Doe</principal-name> 
                                                <date-created>2011-08-30T15:46:46.190-04:00</date-created> 
                                                <date-end>2011-08-30T16:51:30.950-04:00</date-end> 
                                </row> 
                </report-meeting-session-users> 
</results>