A participant is a person joined to a
call or that uses Companion
mode, watching as a viewer, or
a room device connected to a call. There's one
conferenceRecords.participants
resource for each person.
A participant session is a
unique session ID created for each participant-device pair that joins a call.
There's one
conferenceRecords.participants.participantSessions
resource for each session. If the participant joins the same call multiple times
from the same participant-device pair, they're each assigned unique session IDs.
This page describes how to get information about all participants who attended or are in a conference, or about just a single participant, along with their session info.
Participants
The following sections detail how to get information about participants.
The
conferenceRecords.participants
resource includes the user
field. A user
can be only one of the following
objects:
A
signedinUser
is either:An individual joining from a personal computer, a mobile device, or through Companion mode.
A robot account used by conference room devices.
An
anonymousUser
is an unidentified user who's not signed in to a Google Account.A
phoneUser
is a user dialing in from a phone where the user's identity is unknown because they have not signed in with a Google Account.
Search for all participants
To get details about all participants in a conference record, use the
list()
method on the
conferenceRecords.participants
resource with the parent
path parameter.
You can use the earliestStartTime
or latestEndTime
fields to filter for
users who joined before or left after a certain time. Both fields use the
Timestamp
format in RFC 3339
UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits:
{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z
. For example:
earliestStartTime < 2023-10-01T15:01:23Z
latestEndTime < 2023-10-01T15:01:23Z
To get active participants in an existing conference, use latestEndTime IS
NULL
.
The method returns a list of conference participants, ordered by join time in
descending order, as an instance of a conferenceRecords.participants
resource.
The following code sample shows how to list all participants in a conference record:
Java
Node.js
Python
Replace the parent value with the name of the conference record.
Search for a specific participant
To search for a specific participant, use the
get()
method on the
conferenceRecords.participants
resource with the name
path parameter. To retrieve the name of the
participant, use the conferenceRecords.participants.list
method.
The method returns a participant name as an instance of a
conferenceRecords.participants
resource.
The following code sample shows how to retrieve a specific participant:
Java
Node.js
Python
Replace the participant name with the name of the specific participant to find.
Participant sessions
The following sections detail how to get information about participant sessions.
Search for all participant sessions
To get details about all participant sessions of a participant in a conference
record, use the
list()
method on the
conferenceRecords.participants.participantSessions
resource with the parent
path parameter.
You can use the startTime
or endTime
fields to filter for users who joined
before or left after a certain time. Both fields use the
Timestamp
format in RFC
3339 UTC
"Zulu" format, with nanosecond resolution and up to nine fractional digits:
{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z
. For example:
startTime < 2023-10-01T15:01:23Z
endTime < 2023-10-01T15:01:23Z
The method returns a list of participant sessions, ordered by join time in
descending order, as an instance of a
conferenceRecords.participants.participantSession
resource.
The following code sample shows how to list all participant sessions in a conference record:
Java
Node.js
Python
Replace the parent value with the name of the conference record and the participant name.
Search for a specific participant session
To search for a specific participant session, use the
get()
method on the
conferenceRecords.participants.participantSessions
resource with the name
path parameter. To retrieve the name of the
participant, use the list()
method.
The method returns a participant name as an instance of a
conferenceRecords.participants.participantSessions
resource.
The following code sample shows how to retrieve a specific participant session:
Java
Node.js
Python
Replace the participant name with the name of the specific participant to find.
Retrieve participant details with the People API
To retrieve details about a participant, use the
people.get
method in the
People API.
- Extract the ID of the person from the participant resource name using the
trailing component of the path. For example, if the participant resource name
is
conferenceRecords/abc-123/participants/12345
the ID for the People API is12345
. - Include the sources
READ_SOURCE_TYPE_PROFILE
,READ_SOURCE_TYPE_CONTACT
, andREAD_SOURCE_TYPE_OTHER_CONTACT
. This ensures both internal users to a Google Workspace organization and external contacts are included in the response.
The following example searches both organization profiles and contacts for a person:
cURL
curl \
'https://people.googleapis.com/v1/people/PERSON_ID?personFields=names%2CemailAddresses&sources=READ_SOURCE_TYPE_OTHER_CONTACT&sources=READ_SOURCE_TYPE_PROFILE&sources=READ_SOURCE_TYPE_CONTACT' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--header 'Accept: application/json' \
--compressed