Microsoft Graph Communications is a set of cloud communications APIs and SDKs in Microsoft Graph that lets developers integrate deeply with Microsoft Teams calling and meetings. It provides endpoints to schedule and manage online meetings, place and control calls (answer, transfer, hold, mute), manage participants, and subscribe to real-time call and meeting events.
openapi: 3.1.0
info:
title: Microsoft Graph Communications
description: Needs a description.
paths:
/communications:
description: Provides operations to manage the cloudCommunications singleton.
get:
tags:
- communications.cloudCommunications
summary: Microsoft Graph Get communications
operationId: communications.cloudCommunications.GetCloudCommunications
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved entity
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.cloudCommunications'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- communications.cloudCommunications
summary: Microsoft Graph Update communications
operationId: communications.cloudCommunications.UpdateCloudCommunications
requestBody:
description: New property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.cloudCommunications'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.cloudCommunications'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/communications/callRecords:
description: >-
Provides operations to manage the callRecords property of the
microsoft.graph.cloudCommunications entity.
get:
tags:
- communications.callRecord
summary: Microsoft Graph List callRecords
description: >-
Get the list of callRecord objects and their properties. The results can
be optionally filtered using the $filter query parameter on the
startDateTime and participant id properties. Note that the listed call
records don't include expandable relationships such as sessions and
participants_v2. You can expand these relationships using Get callRecord
for a specific record.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/callrecords-cloudcommunications-list-callrecords?view=graph-rest-1.0
operationId: communications.ListCallRecords
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.callRecords.callRecordCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- communications.callRecord
summary: Microsoft Graph Create new navigation property to callRecords for communications
operationId: communications.CreateCallRecords
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.callRecord'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.callRecord'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
/communications/callRecords/{callRecord-id}:
description: >-
Provides operations to manage the callRecords property of the
microsoft.graph.cloudCommunications entity.
get:
tags:
- communications.callRecord
summary: Microsoft Graph Get callRecord
description: "Retrieve the properties and relationships of a callRecord object. You can get the id of a callRecord in two ways:\r\n* Subscribe to change notifications to the /communications/callRecords endpoint.\r\n* Use the callChainId property of a call. The call record is available only after the associated call is completed."
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/callrecords-callrecord-get?view=graph-rest-1.0
operationId: communications.GetCallRecords
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.callRecord'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- communications.callRecord
summary: Microsoft Graph Update the navigation property callRecords in communications
operationId: communications.UpdateCallRecords
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.callRecord'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.callRecord'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- communications.callRecord
summary: Microsoft Graph Delete navigation property callRecords for communications
operationId: communications.DeleteCallRecords
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: callRecord-id
in: path
description: The unique identifier of callRecord
required: true
schema:
type: string
x-ms-docs-key-type: callRecord
/communications/callRecords/{callRecord-id}/organizer_v2:
description: >-
Provides operations to manage the organizer_v2 property of the
microsoft.graph.callRecords.callRecord entity.
get:
tags:
- communications.callRecord
summary: Microsoft Graph Get organizer_v2 from communications
description: >-
Identity of the organizer of the call. This relationship is expanded by
default in callRecord methods.
operationId: communications.callRecords.GetOrganizer_v2
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.organizer'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- communications.callRecord
summary: Microsoft Graph Update the navigation property organizer_v2 in communications
operationId: communications.callRecords.UpdateOrganizer_v2
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.organizer'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.organizer'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- communications.callRecord
summary: Microsoft Graph Delete navigation property organizer_v2 for communications
operationId: communications.callRecords.DeleteOrganizer_v2
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: callRecord-id
in: path
description: The unique identifier of callRecord
required: true
schema:
type: string
x-ms-docs-key-type: callRecord
/communications/callRecords/{callRecord-id}/participants_v2:
description: >-
Provides operations to manage the participants_v2 property of the
microsoft.graph.callRecords.callRecord entity.
get:
tags:
- communications.callRecord
summary: Microsoft Graph List participants_v2
description: Get the list of participant objects associated with a callRecord.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/callrecords-callrecord-list-participants_v2?view=graph-rest-1.0
operationId: communications.callRecords.ListParticipants_v2
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.callRecords.participantCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- communications.callRecord
summary: Microsoft Graph Create new navigation property to participants_v2 for communications
operationId: communications.callRecords.CreateParticipants_v2
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.participant'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.participant'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: callRecord-id
in: path
description: The unique identifier of callRecord
required: true
schema:
type: string
x-ms-docs-key-type: callRecord
/communications/callRecords/{callRecord-id}/participants_v2/{participant-id}:
description: >-
Provides operations to manage the participants_v2 property of the
microsoft.graph.callRecords.callRecord entity.
get:
tags:
- communications.callRecord
summary: Microsoft Graph Get participants_v2 from communications
description: List of distinct participants in the call.
operationId: communications.callRecords.GetParticipants_v2
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.participant'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- communications.callRecord
summary: Microsoft Graph Update the navigation property participants_v2 in communications
operationId: communications.callRecords.UpdateParticipants_v2
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.participant'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.participant'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- communications.callRecord
summary: Microsoft Graph Delete navigation property participants_v2 for communications
operationId: communications.callRecords.DeleteParticipants_v2
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: callRecord-id
in: path
description: The unique identifier of callRecord
required: true
schema:
type: string
x-ms-docs-key-type: callRecord
- name: participant-id
in: path
description: The unique identifier of participant
required: true
schema:
type: string
x-ms-docs-key-type: participant
/communications/callRecords/{callRecord-id}/participants_v2/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- communications.callRecord
summary: Microsoft Graph Get the number of the resource
operationId: communications.callRecords.participants_v2.GetCount-ecf7
parameters:
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
responses:
2XX:
$ref: '#/components/responses/ODataCountResponse'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
parameters:
- name: callRecord-id
in: path
description: The unique identifier of callRecord
required: true
schema:
type: string
x-ms-docs-key-type: callRecord
/communications/callRecords/{callRecord-id}/sessions:
description: >-
Provides operations to manage the sessions property of the
microsoft.graph.callRecords.callRecord entity.
get:
tags:
- communications.callRecord
summary: Microsoft Graph List sessions
description: >-
Retrieve the list of sessions associated with a callRecord object. If
the sessions list is truncated, a [email protected] value will be
provided to retrieve the next page of sessions. The maximum page size
for sessions is 60 entries.
externalDocs:
description: Find more info here
url: >-
https://learn.microsoft.com/graph/api/callrecords-callrecord-list-sessions?view=graph-rest-1.0
operationId: communications.callRecords.ListSessions
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.callRecords.sessionCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- communications.callRecord
summary: Microsoft Graph Create new navigation property to sessions for communications
operationId: communications.callRecords.CreateSessions
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.session'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.session'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: callRecord-id
in: path
description: The unique identifier of callRecord
required: true
schema:
type: string
x-ms-docs-key-type: callRecord
/communications/callRecords/{callRecord-id}/sessions/{session-id}:
description: >-
Provides operations to manage the sessions property of the
microsoft.graph.callRecords.callRecord entity.
get:
tags:
- communications.callRecord
summary: Microsoft Graph Get sessions from communications
description: >-
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. Read-only. Nullable.
operationId: communications.callRecords.GetSessions
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.session'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- communications.callRecord
summary: Microsoft Graph Update the navigation property sessions in communications
operationId: communications.callRecords.UpdateSessions
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.session'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.session'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- communications.callRecord
summary: Microsoft Graph Delete navigation property sessions for communications
operationId: communications.callRecords.DeleteSessions
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: callRecord-id
in: path
description: The unique identifier of callRecord
required: true
schema:
type: string
x-ms-docs-key-type: callRecord
- name: session-id
in: path
description: The unique identifier of session
required: true
schema:
type: string
x-ms-docs-key-type: session
/communications/callRecords/{callRecord-id}/sessions/{session-id}/segments:
description: >-
Provides operations to manage the segments property of the
microsoft.graph.callRecords.session entity.
get:
tags:
- communications.callRecord
summary: Microsoft Graph Get segments from communications
description: The list of segments involved in the session. Read-only. Nullable.
operationId: communications.callRecords.sessions.ListSegments
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
$ref: >-
#/components/responses/microsoft.graph.callRecords.segmentCollectionResponse
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
x-ms-docs-operation-type: operation
post:
tags:
- communications.callRecord
summary: Microsoft Graph Create new navigation property to segments for communications
operationId: communications.callRecords.sessions.CreateSegments
requestBody:
description: New navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.segment'
required: true
responses:
2XX:
description: Created navigation property.
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.segment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: callRecord-id
in: path
description: The unique identifier of callRecord
required: true
schema:
type: string
x-ms-docs-key-type: callRecord
- name: session-id
in: path
description: The unique identifier of session
required: true
schema:
type: string
x-ms-docs-key-type: session
/communications/callRecords/{callRecord-id}/sessions/{session-id}/segments/{segment-id}:
description: >-
Provides operations to manage the segments property of the
microsoft.graph.callRecords.session entity.
get:
tags:
- communications.callRecord
summary: Microsoft Graph Get segments from communications
description: The list of segments involved in the session. Read-only. Nullable.
operationId: communications.callRecords.sessions.GetSegments
parameters:
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Retrieved navigation property
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.segment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
patch:
tags:
- communications.callRecord
summary: Microsoft Graph Update the navigation property segments in communications
operationId: communications.callRecords.sessions.UpdateSegments
requestBody:
description: New navigation property values
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.segment'
required: true
responses:
2XX:
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/microsoft.graph.callRecords.segment'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
delete:
tags:
- communications.callRecord
summary: Microsoft Graph Delete navigation property segments for communications
operationId: communications.callRecords.sessions.DeleteSegments
parameters:
- name: If-Match
in: header
description: ETag
schema:
type: string
responses:
'204':
description: Success
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: operation
parameters:
- name: callRecord-id
in: path
description: The unique identifier of callRecord
required: true
schema:
type: string
x-ms-docs-key-type: callRecord
- name: session-id
in: path
description: The unique identifier of session
required: true
schema:
type: string
x-ms-docs-key-type: session
- name: segment-id
in: path
description: The unique identifier of segment
required: true
schema:
type: string
x-ms-docs-key-type: segment
/communications/callRecords/{callRecord-id}/sessions/{session-id}/segments/$count:
description: Provides operations to count the resources in the collection.
get:
tags:
- communications.callRecord
summary: Microsoft Graph Get the number of the r
# --- truncated at 32 KB (350 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-graph/refs/heads/main/openapi/communications-openapi-original.yml