🔍 Code Extractor

Represents a single peer-to-peer call or a group call between multiple participants in Microsoft 365, sometimes referred to as an online meeting.

Purpose

This class models call records from Microsoft 365 communications, providing access to call metadata including the meeting URL, organizer information, and associated sessions. It extends the Entity base class and is used to retrieve and manage information about completed or ongoing calls, whether they are peer-to-peer or group calls. The class provides read-only properties to access call details and is typically instantiated by the Office 365 SDK when fetching call records from the Microsoft Graph API.

Source Code

class CallRecord(Entity):
    """Represents a single peer-to-peer call or a group call between multiple participants,
    sometimes referred to as an online meeting."""

    @property
    def join_web_url(self):
        """Meeting URL associated to the call. May not be available for a peerToPeer call record type."""
        return self.properties.get("joinWebUrl", None)

    @property
    def organizer(self):
        """The organizing party's identity.."""
        return self.properties.get("organizer", IdentitySet())

    @property
    def sessions(self):
        """
        List of sessions involved in the call. Peer-to-peer calls typically only have one session, whereas group
        calls typically have at least one session per participant.
        """
        return self.properties.get(
            "sessions",
            EntityCollection(
                self.context, Session, ResourcePath("sessions", self.resource_path)
            ),
        )

Parameters

Parameter Details

bases: Inherits from Entity class, which provides base functionality for Microsoft Graph API entities including context management, property storage, and resource path handling. The Entity base class handles the underlying data structure and API communication.

Return Value

Instantiation returns a CallRecord object that represents a call record entity from Microsoft Graph API. The object provides access to call properties through read-only properties: join_web_url (string or None), organizer (IdentitySet object), and sessions (EntityCollection of Session objects).

Class Interface

Methods

Attributes

Dependencies

• office365

Required Imports

from office365.communications.callrecords.call_record import CallRecord
from office365.communications.callrecords.session import Session
from office365.directory.permissions.identity_set import IdentitySet
from office365.entity import Entity
from office365.entity_collection import EntityCollection
from office365.runtime.paths.resource_path import ResourcePath

Usage Example

from office365.graph_client import GraphClient
from office365.communications.callrecords.call_record import CallRecord

# Authenticate with Microsoft Graph
client = GraphClient.with_client_secret(tenant_id, client_id, client_secret)

# Retrieve a specific call record by ID
call_record = client.communications.call_records['call-record-id'].get().execute_query()

# Access call record properties
if call_record.join_web_url:
    print(f"Meeting URL: {call_record.join_web_url}")

# Access organizer information
organizer = call_record.organizer
if organizer.user:
    print(f"Organizer: {organizer.user.display_name}")

# Access sessions in the call
sessions = call_record.sessions
for session in sessions:
    print(f"Session ID: {session.id}")
    print(f"Start time: {session.start_date_time}")
    print(f"End time: {session.end_date_time}")

Best Practices

• This class is typically instantiated by the Office 365 SDK framework, not directly by users. Access CallRecord instances through the GraphClient API.
• All properties are read-only and lazily loaded from the underlying properties dictionary. Call execute_query() on the parent context to ensure data is fetched from the API.
• The join_web_url property may return None for peer-to-peer calls, always check for None before using.
• The organizer property returns an IdentitySet object which may contain user, application, or device identity information.
• The sessions property returns an EntityCollection that can be iterated. For peer-to-peer calls, expect one session; for group calls, expect multiple sessions (typically one per participant).
• Ensure proper Microsoft Graph API permissions are configured before attempting to access call records.
• Call records are typically available after a call has ended and may take time to be fully populated in the system.
• Use the context property inherited from Entity to manage API requests and batch operations efficiently.

Tags

Similar Components

AI-powered semantic similarity - components with related functionality:

• class Call 70.1% similar

  Represents a call resource in Microsoft Graph Communications API, managing both incoming and outgoing calls for applications with capabilities for call control, media operations, and participant management.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/communications/calls/call.py

• class CallCollection 64.6% similar

  CallCollection is a specialized entity collection class for managing Microsoft Teams/Graph API call operations, including creating outgoing calls and logging teleconferencing device quality data.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/communications/calls/collection.py

• class Session 62.7% similar

  Represents a user-user communication or a user-meeting communication session, such as a conference call, in the Office 365 communications system.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/communications/callrecords/session.py

• class CloudCommunications 61.8% similar

  CloudCommunications is a class that provides access to Microsoft Graph API cloud communications resources including calls, call records, online meetings, and user presence information.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/communications/cloud_communications.py

• class Participant 59.9% similar

  Represents a participant in a call, providing methods to manage participant state including inviting others, controlling hold music, and accessing participant information.

  From: /tf/active/vicechatdev/SPFCsync/venv/lib64/python3.11/site-packages/office365/communications/calls/participant.py