Work with participants

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, 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.

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.

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.

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.