Guides
Signup For Free

Microsoft Teams Meeting API Integration

Suggest Edits

These are the list of integration use cases supported by Knit for Microsoft Teams Meeting API as part of the MEETING category

Delete a user

  • ID: delete_a_user
  • Operation: write
  • Entities: resource, group, user
  • Summary: The 'Delete a user' API allows you to delete a user object from Microsoft Graph. When a user is deleted, their resources, including mailbox and license assignments, are moved to a temporary container. If restored within 30 days, these resources are restored to the user. After 30 days, the user is permanently deleted. The API requires the 'Authorization' header with a Bearer token. The path parameter 'id | userPrincipalName' is required to specify the user to be deleted. The API returns a 204 No Content response if successful, with no content in the response body. Permissions required include 'User.ReadWrite.All' for delegated (work or school account) and application scenarios. The calling user must have appropriate Microsoft Entra roles.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Audio Routing Group

  • ID: delete_audio_routing_group
  • Operation: write
  • Entities: call, audio routing group
  • Summary: The Delete Audio Routing Group API allows you to delete a specified audio routing group associated with a call. This API requires an application permission of either Calls.JoinGroupCall.All or Calls.InitiateGroupCall.All. The request must include an Authorization header with a valid Bearer token. The API endpoint requires the unique identifier for both the call and the audio routing group as path parameters. No request body is needed. Upon successful execution, the API returns a 204 No Content response, indicating that the audio routing group has been successfully deleted. This API is available globally but not in US Government L4, US Government L5 (DOD), or China operated by 21Vianet.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Call

  • ID: delete_call
  • Operation: write
  • Entities: call, notification, permission
  • Summary: The Delete Call API allows you to delete or hang up an active call using the DELETE method. For group calls, this will only delete your call leg, and the underlying group call will continue. The API endpoint is '/communications/calls/{id}', where 'id' is the unique identifier of the call. The request requires an Authorization header with a Bearer token. No request body is needed. If successful, the API returns a 204 No Content response code, indicating the call has been successfully deleted. Notifications are sent to indicate the call's state changes, such as 'terminating' or 'terminated'. The API is available in various national cloud deployments, except for China operated by 21Vianet. Permissions required include 'Calls.Initiate.All' or 'Calls.AccessMedia.All' for application type. The API does not support delegated permissions for work, school, or personal Microsoft accounts.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Event

  • ID: delete_event
  • Operation: write
  • Entities: meeting, event, calendar
  • Summary: The Delete Event API removes a specified event from the user's calendar. If the event is a meeting, deleting it from the organizer's calendar will send a cancellation message to all attendees. This API requires the 'Calendars.ReadWrite' permission and supports multiple national cloud deployments. The request must include an Authorization header with a valid bearer token. The API does not require a request body and will return a 204 No Content response code upon successful deletion.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Online Meeting

  • ID: delete_online_meeting
  • Operation: write
  • Entities: user, application access policy, online meeting
  • Summary: The Delete Online Meeting API allows you to delete an online meeting object using its meeting ID. This API requires the 'OnlineMeetings.ReadWrite' permission for delegated work or school accounts. It is not supported for personal Microsoft accounts. For application permissions, 'OnlineMeetings.ReadWrite.All' is required, and tenant administrators must create an application access policy to authorize the app. The API endpoint is '/me/onlineMeetings/{meetingId}' for delegated permissions and '/users/{userId}/onlineMeetings/{meetingId}' for application permissions. The request must include an 'Authorization' header with a valid bearer token. No request body is needed. A successful request returns a 204 No Content response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Participant from Call

  • ID: delete_participant_from_call
  • Operation: write
  • Entities: call, permission, participant
  • Summary: The Delete Participant from Call API allows an application to remove a specific participant from an active call. This can be done before or after the participant answers the call. When an active caller is removed, they are immediately dropped from the call without any notification. If an invited participant is removed, any pending add participant request is canceled. The API requires the 'Authorization' header with a Bearer token for authentication. The call and participant IDs must be provided as path parameters. Upon successful execution, the API returns a 204 No Content response, indicating that the participant has been successfully removed from the call.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Virtual Event Presenter

  • ID: delete_virtual_event_presenter
  • Operation: write
  • Entities: presenter, townhall, virtual event
  • Summary: The Delete Virtual Event Presenter API allows you to remove a presenter from a virtual event townhall. This API requires the 'VirtualEvent.ReadWrite' permission for delegated work or school accounts. The API endpoint requires the 'townhallId' and 'presenterId' as path parameters to identify the specific virtual event and presenter. The request must include an Authorization header with a valid Bearer token. If successful, the API returns a 204 No Content response, indicating that the presenter has been successfully deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete Virtual Event Registration Question

  • ID: delete_virtual_event_registration_question
  • Operation: write
  • Entities: webinar, virtual event, registration question
  • Summary: The Delete Virtual Event Registration Question API allows you to remove a registration question from a webinar. This can be either a predefined or custom registration question. The API requires the 'VirtualEvent.ReadWrite' permission for delegated work or school accounts. The request is made to the endpoint with the specific webinarId and questionId as path parameters. The Authorization header with a valid Bearer token is required. If successful, the API returns a 204 No Content response, indicating that the question has been successfully deleted.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get a user

  • ID: get_a_user
  • Operation: read
  • Entities: user, permission, extension
  • Summary: The 'Get a user' API retrieves the properties and relationships of a user object. By default, it returns a subset of commonly used properties such as businessPhones, displayName, givenName, id, jobTitle, mail, mobilePhone, officeLocation, preferredLanguage, surname, and userPrincipalName. To retrieve additional properties, the $select OData query parameter can be used. The API requires a Bearer token for authentication and supports delegated permissions such as User.Read. It returns a 200 OK response with the user object if successful, or a 404 Not Found error if the user does not exist.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get addLargeGalleryViewOperation

  • ID: get_add_large_gallery_view_operation
  • Operation: read
  • Entities: call, gallery view, operation
  • Summary: The Get addLargeGalleryViewOperation API retrieves the status of an operation that adds the large gallery view to a call. It requires the 'Authorization' header with a Bearer token for authentication. The API endpoint uses path parameters 'callId' and 'id' to specify the call and operation respectively. The response includes the operation's status and other details in an addLargeGalleryViewOperation object. The API is available in various national cloud deployments except for China operated by 21Vianet.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Recordings of Online Meetings

  • ID: get_all_recordings_of_online_meetings
  • Operation: read
  • Entities: recording, user, online meeting
  • Summary: This API retrieves all recordings from scheduled online meetings for which the specified user is the organizer. It does not support channel meetings. The API supports both full and incremental synchronization using the delta function. The request requires the 'meetingOrganizerUserId' parameter and optionally 'startDateTime' and 'endDateTime' to filter recordings by date. The response includes a collection of callRecording objects with details such as recording ID, meeting ID, creation date, and recording content URL. The API requires an Authorization header with a Bearer token.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get All Transcripts of Online Meetings

  • ID: get_all_transcripts_of_online_meetings
  • Operation: read
  • Entities: transcript, user, online meeting
  • Summary: The 'Get All Transcripts of Online Meetings' API retrieves all transcripts from scheduled online meeting instances for which the specified user is the organizer. It supports both full and incremental synchronization using the delta function. The API requires the 'meetingOrganizerUserId' parameter to filter meetings organized by a specific user. Optional parameters 'startDateTime' and 'endDateTime' can be used to filter transcripts by creation date. The API supports OData query parameters like '$top' to customize the response. The response includes a collection of callTranscript objects, each containing details like the transcript ID, meeting ID, creation date, and a URL to access the transcript content. Authentication is required via a Bearer token in the request header.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Audio Routing Group

  • ID: get_audio_routing_group
  • Operation: read
  • Entities: call, audio routing group
  • Summary: The Get Audio Routing Group API retrieves the properties and relationships of an audioRoutingGroup object. It requires an Authorization header with a Bearer token for authentication. The API supports OData query parameters to customize the response. The request does not require a body. On success, it returns a 200 OK response with an audioRoutingGroup object, which includes details such as the id, routingMode, sources, and receivers.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Retrieve Call Details

  • ID: get_call_details
  • Operation: read
  • Entities: call, media configuration, participant
  • Summary: The 'Retrieve Call Details' API allows you to get the properties and relationships of a call object using its unique identifier. This API is accessible in various national cloud deployments except for China operated by 21Vianet. It requires an Authorization header with a Bearer token for authentication. The API supports OData query parameters to customize the response. The response includes details such as the call state, direction, callback URI, source and target participants, requested modalities, media configuration, and more. The API returns a 200 OK status with a call object in the response body if successful.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Call Record Details

  • ID: get_call_record_details
  • Operation: read
  • Entities: participant, session, call record
  • Summary: The Get Call Record Details API retrieves the properties and relationships of a callRecord object from Microsoft Graph. It requires the callRecord ID as a path parameter and supports optional OData query parameters such as $select and $expand to customize the response. The API requires an Authorization header with a Bearer token for authentication. The response includes details such as the call type, modalities, start and end times, organizer information, and session details. The API does not return records older than 30 days and supports pagination for large result sets.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Call Recording

  • ID: get_call_recording
  • Operation: read
  • Entities: user, call recording, online meeting
  • Summary: The 'Get Call Recording' API retrieves metadata and content of a specific call recording associated with an online meeting. It requires the meetingId and recordingId as path parameters. The API supports the $select OData query parameter to customize the response. The Authorization header with a Bearer token is mandatory for authentication. The API returns a callRecording object containing details such as the recording's ID, meeting ID, call ID, creation and end times, content correlation ID, and the URL to access the recording content. The meeting organizer's information is also included. This API is metered and has specific permissions requirements, supporting only certain national cloud deployments.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Call Recording Delta

  • ID: get_call_recording_delta
  • Operation: read
  • Entities: user, call recording, online meeting
  • Summary: The 'Get Call Recording Delta' API retrieves a set of callRecording resources for online meetings organized by a specified user. It supports both full synchronization to get all recordings and incremental synchronization to get recordings added since the last sync. The API requires a GET request to the specified endpoint with the user's ID and meeting organizer's ID as path parameters. The request must include an Authorization header with a Bearer token. Optional query parameters include $deltaToken, $skipToken, and $top. The response includes a collection of callRecording objects, and may contain an @odata.nextLink or @odata.deltaLink for further synchronization. The API requires the 'OnlineMeetingRecording.Read.All' application permission.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Call Transcript

  • ID: get_call_transcript
  • Operation: read
  • Entities: transcript, user, online meeting
  • Summary: The Get Call Transcript API retrieves a callTranscript object associated with a scheduled online meeting. It does not support channel meetings or meetings created using the create onlineMeeting API that are not associated with a user's calendar event. The API requires an Authorization header with a Bearer token and supports the $select OData query parameter to customize the response. The response includes metadata about the transcript, such as the meeting ID, call ID, creation and end times, and a URL to access the transcript content. The API is metered and available in specific national cloud deployments.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Call Transcripts Delta

  • ID: get_call_transcripts_delta
  • Operation: read
  • Entities: user, online meeting, call transcript
  • Summary: The 'Get Call Transcripts Delta' API retrieves a set of call transcript resources for online meetings organized by a specified user. It supports both full synchronization to get all transcripts and incremental synchronization to get transcripts added since the last synchronization. The API requires an Authorization header with a Bearer token and a path parameter for the user ID. Optional query parameters include $deltaToken, $skipToken, and $top. The response includes a collection of callTranscript objects and may contain an @odata.nextLink or @odata.deltaLink for pagination and change tracking. The API requires the 'OnlineMeetingTranscript.Read.All' application permission.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get contentSharingSession

  • ID: get_contentsharingsession
  • Operation: read
  • Entities: call, content sharing session
  • Summary: The Get contentSharingSession API retrieves the properties of a contentSharingSession object in a call. It requires the call ID and content sharing session ID as path parameters. The request must include an Authorization header with a Bearer token for authentication. The API returns a 200 OK response code with a contentSharingSession object in the response body. This API is available in the global service but not in US Government or China deployments. It requires application permissions such as Calls.JoinGroupCallAsGuest.All.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Direct Routing Call Records

  • ID: get_direct_routing_call_records
  • Operation: read
  • Entities: user, direct routing log row, call record
  • Summary: The 'Get Direct Routing Call Records' API retrieves a log of direct routing calls as a collection of directRoutingLogRow entries. It requires an application permission 'CallRecords.Read.All' and supports querying by a time range using 'fromDateTime' and 'toDateTime' query parameters. The response includes a collection of call records, and if there are more than 1,000 entries, an '@odata.nextLink' is provided for pagination. The API is available in various national cloud deployments except for China operated by 21Vianet.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List attendanceRecords

  • ID: get_list_attendancerecords
  • Operation: read
  • Entities: attendance record, report, meeting
  • Summary: The 'List attendanceRecords' API retrieves a list of attendanceRecord objects and their properties for a specified online meeting and attendance report. It requires the meetingId and reportId as path parameters and supports optional OData query parameters to customize the response. The request must include an Authorization header with a Bearer token for authentication. The response includes a collection of attendance records, each detailing the attendee's email address, total attendance duration, role, identity, and attendance intervals.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Audio Routing Groups

  • ID: get_list_audio_routing_groups
  • Operation: read
  • Entities: call, audio routing group
  • Summary: The List Audio Routing Groups API retrieves a list of audioRoutingGroup objects for a specified call. It requires an Authorization header with a Bearer token for authentication. The API supports OData query parameters to customize the response. The response includes a collection of audioRoutingGroup objects, each with an id, routingMode, sources, and receivers. The API is available globally but not supported in US Government L4, L5, or China operated by 21Vianet. The /app path is deprecated; use the /communications path instead.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Call Records

  • ID: get_list_call_records
  • Operation: read
  • Entities: participant, session, call record
  • Summary: The List Call Records API retrieves a collection of callRecord objects and their properties from Microsoft Graph. The API supports optional OData query parameters such as $select and $filter to customize the response. The $filter parameter can be used to filter call records by startDateTime and participant ID. The API requires an Authorization header with a Bearer token for authentication. The response includes a collection of callRecord objects, each containing details such as id, version, type, modalities, lastModifiedDateTime, startDateTime, endDateTime, and organizer information. The API does not return call records older than 30 days and supports pagination with a default page size of 60 entries.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List contentSharingSessions

  • ID: get_list_contentsharingsessions
  • Operation: read
  • Entities: call, content sharing session
  • Summary: The 'List contentSharingSessions' API retrieves a list of contentSharingSession objects associated with a specific call. It requires an application-level permission with a bearer token for authorization. The API endpoint is '/communications/calls/{id}/contentSharingSessions', where 'id' is the unique identifier of the call. The response includes a collection of contentSharingSession objects, each with its own unique identifier. The API is available globally but not supported in US Government L4, L5, or China operated by 21Vianet.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List events

  • ID: get_list_events
  • Operation: read
  • Entities: user, event, calendar
  • Summary: The List events API retrieves a list of events in a calendar, which can be a user's calendar or the default calendar of a Microsoft 365 group. The API supports OData Query Parameters to customize the response and requires an Authorization header with a Bearer token. The response includes a collection of Event objects, each containing details such as the original start and end time zones, response status, iCalendar UID, reminder settings, and more. The API is available in various national cloud deployments and requires specific permissions based on the calendar type and permission type requested.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List participants in a call

  • ID: get_list_participants_in_a_call
  • Operation: read
  • Entities: call, media stream, participant
  • Summary: The 'List participants in a call' API retrieves a list of participant objects in a specified call. It requires the 'Authorization' header with a Bearer token for authentication. The API endpoint includes a path parameter 'id' which is the unique identifier of the call. This API supports OData query parameters to customize the response. The response includes a collection of participant objects, each containing details such as identity, media streams, mute status, and lobby status. The API is available in various national cloud deployments except for China operated by 21Vianet.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List participants_v2

  • ID: get_list_participants_v2
  • Operation: read
  • Entities: identity, participant, call record
  • Summary: The List participants_v2 API retrieves a collection of participant objects associated with a specific callRecord. It requires an Authorization header with a Bearer token for authentication. The API supports an optional $select query parameter to customize the properties returned. The response includes a collection of participant objects, each with identity information such as user ID, display name, tenant ID, and user principal name. If the result set spans multiple pages, an @odata.nextLink property is provided for pagination.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List presenters for a virtual event

  • ID: get_list_presenters_for_virtual_event
  • Operation: read
  • Entities: virtual event presenter, virtual event townhall, virtual event
  • Summary: This API retrieves a list of all presenters associated with a virtual event townhall. The request requires an Authorization header with a Bearer token for authentication. The townhallId path parameter is required to specify the virtual event. The response includes a collection of virtualEventPresenter objects, each containing details such as the presenter's ID, display name, email, and tenant ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Recordings

  • ID: get_list_recordings
  • Operation: read
  • Entities: user, call recording, online meeting
  • Summary: The 'List Recordings' API retrieves a list of callRecording objects associated with a scheduled online meeting. It does not support channel meetings or meetings created using the create onlineMeeting API that are not associated with a user's calendar event. The API requires an Authorization header with a Bearer token and supports OData query parameters such as $select, $filter, and $top to customize the response. The response includes details about each recording, such as its ID, meeting ID, call ID, creation and end times, and the URL to access the recording content. The API is available in several national cloud deployments, excluding China operated by 21Vianet.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Recordings of Online Meetings

  • ID: get_list_recordings_of_online_meetings
  • Operation: read
  • Entities: user, call recording, online meeting
  • Summary: The 'List Recordings of Online Meetings' API retrieves a list of callRecording objects associated with a scheduled online meeting. It does not support channel meetings or meetings created using the create onlineMeeting API that are not associated with a user's calendar event. The API requires an Authorization header with a Bearer token and supports OData query parameters such as $select, $filter, and $top to customize the response. The response includes details about each recording, such as its ID, meeting ID, call ID, creation and end times, content URL, and organizer information. This API is available in various national cloud deployments, except for China operated by 21Vianet.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Sessions for Call Record

  • ID: get_list_sessions_for_call_record
  • Operation: read
  • Entities: participant, session, call record
  • Summary: The 'List Sessions for Call Record' API retrieves the list of sessions associated with a specific callRecord object. It requires an Authorization header with a Bearer token for authentication. The API supports OData query parameters such as $select and $expand to customize the response. The response includes session details such as id, modalities, start and end times, and participant information. If the sessions list is truncated, an @odata.nextLink is provided for pagination. The API is available in various national cloud deployments except for China operated by 21Vianet.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List sessions for a virtual event

  • ID: get_list_sessions_for_virtual_event
  • Operation: read
  • Entities: webinar, virtual event, session
  • Summary: The 'List sessions for a virtual event' API retrieves a list of all virtual event session summaries under a specified webinar. The session summary includes the endDateTime, id, joinWebUrl, startDateTime, and subject of each session. The API requires an Authorization header with a Bearer token for authentication. The 'webinarId' path parameter is mandatory to specify the webinar for which sessions are to be listed. The response includes a collection of virtualEventSession objects, each containing details such as the session's start and end times, join URL, and subject. This API supports only the 'VirtualEvent.Read' permission for delegated work or school accounts and 'VirtualEvent.Read.All' for applications.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List sessions for a virtual event registration

  • ID: get_list_sessions_for_virtual_event_registration
  • Operation: read
  • Entities: webinar, virtual event, session
  • Summary: This API retrieves a list of session summaries for a specific registration in a virtual event webinar. The session summary includes the endDateTime, id, joinWebUrl, startDateTime, and subject of the session. The API requires the 'Authorization' header with a Bearer token for authentication. The 'webinarId' and 'registrationId' are required path parameters. The response includes a collection of virtualEventSession objects, each containing the session's basic details. Note that virtual event webinars can only have a single session, so only one session summary will be returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List transcripts

  • ID: get_list_transcripts
  • Operation: read
  • Entities: transcript, user, online meeting
  • Summary: The 'List transcripts' API retrieves a list of callTranscript objects associated with a scheduled online meeting. It requires the 'Authorization' header with a Bearer token for authentication. The API endpoint includes a path parameter 'online-meeting-id' to specify the meeting. Optional OData query parameters such as '$select', '$filter', and '$top' can be used to customize the response. The API returns a 200 OK response with a collection of callTranscript objects, each containing details like 'id', 'meetingId', 'callId', 'createdDateTime', 'endDateTime', 'contentCorrelationId', 'transcriptContentUrl', and 'meetingOrganizer'. This API is available in various national cloud deployments but does not support channel meetings or expired meetings.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Users

  • ID: get_list_users
  • Operation: read
  • Entities: user, permission
  • Summary: The List Users API retrieves a list of user objects from Microsoft Graph. It supports various OData query parameters such as $count, $expand, $filter, $orderby, $search, $select, and $top to customize the response. The API requires an Authorization header with a Bearer token for authentication. The ConsistencyLevel header set to 'eventual' is required when using $search or specific $filter queries. The response includes a collection of user objects with properties like displayName, mail, and userPrincipalName. The API returns a 200 OK response code upon success, and supports paging for large collections.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List webinars

  • ID: get_list_webinars
  • Operation: read
  • Entities: virtual event webinar, tenant, organizer
  • Summary: The 'List webinars' API retrieves a list of all virtualEventWebinar objects created in a tenant. It requires an Authorization header with a Bearer token for authentication. The API supports the optional OData query parameter '$count' to include the total count of webinars in the response. The response includes details such as the webinar's ID, status, display name, description, start and end times, creator information, audience, co-organizers, and settings. This API is only available in the global service and requires the 'VirtualEvent.Read.All' application permission.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Meeting Attendance Report

  • ID: get_meeting_attendance_report
  • Operation: read
  • Entities: attendance report, webinar, online meeting
  • Summary: The Get Meeting Attendance Report API retrieves the attendance report for an online meeting or virtual event. It requires the meetingId and reportId as path parameters and supports the $expand query parameter to include attendance records. The API requires an Authorization header with a Bearer token for authentication. The response includes details such as total participant count, meeting start and end times, and a list of attendance records with participant details and attendance intervals. This API is available in various national cloud deployments but does not support channel meetings or breakout room information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List meetingAttendanceReports

  • ID: get_meeting_attendance_reports
  • Operation: read
  • Entities: virtual event, online meeting, meeting attendance report
  • Summary: The List meetingAttendanceReports API retrieves a list of meetingAttendanceReport objects for an online meeting or virtual event. It requires the meetingId as a path parameter and an Authorization header with a Bearer token for authentication. The API supports OData query parameters to customize the response. The response includes a list of attendance reports with details such as the report ID, total participant count, meeting start and end times, and an empty attendanceRecords array. The API is limited to returning up to 50 of the most recent reports and behaves differently for channel meetings by returning reports for all meetings in the channel.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Online Meeting Details

  • ID: get_online_meeting_details
  • Operation: read
  • Entities: attendee report, online meeting, user
  • Summary: The Get Online Meeting Details API retrieves the properties and relationships of an onlineMeeting object using the meeting ID. It requires an Authorization header with a Bearer token for authentication. The API supports optional Accept-Language header to specify the language of the response. The response includes details such as the meeting's creation date, start and end times, join URL, subject, participants, and settings related to lobby bypass and join meeting ID. The API is available in various national cloud deployments and supports delegated permissions for work or school accounts.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Participant

  • ID: get_participant
  • Operation: read
  • Entities: communication, call, participant
  • Summary: The Get Participant API retrieves the properties and relationships of a participant object in a call. It requires the call and participant IDs as path parameters and an authorization token in the headers. The API supports OData query parameters to customize the response. The response includes details about the participant, such as identity, media streams, and status (muted or in lobby). This API is not supported for peer-to-peer calls between a calling bot and another peer, including both VoIP and PSTN calls.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get PSTN Call Records

  • ID: get_pstn_call_records
  • Operation: read
  • Entities: user, pstn call, call record
  • Summary: The Get PSTN Call Records API retrieves a log of PSTN calls as a collection of pstnCallLogRow entries within a specified date range. The API requires an Authorization header with a Bearer token for authentication. The query parameters 'fromDateTime' and 'toDateTime' define the time range for the call records, which must not exceed 90 days. The response includes a collection of call records, and if there are more than 1,000 entries, an '@odata.nextLink' is provided to query the next page of results. The API does not support Telstra or Softbank calling plans and is available in various national cloud deployments except China operated by 21Vianet.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Single Event

  • ID: get_single_event
  • Operation: read
  • Entities: attendee, organizer, event
  • Summary: The 'Get Single Event' API retrieves details of a specific event from a user's calendar using the Microsoft Graph API. It requires a GET request to the endpoint 'https://graph.microsoft.com/v1.0/me/events/{id}', where '{id}' is the unique identifier of the event. The API supports optional query parameters like '$select' to specify which properties to include in the response. Headers can include 'Prefer' to set the time zone for the response. The response includes detailed information about the event, such as its subject, body, start and end times, location, attendees, and organizer. Permissions required to access this API vary based on the account type, with options including 'Calendars.ReadBasic' and 'Calendars.Read'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get User Presence Information

  • ID: get_user_presence_information
  • Operation: read
  • Entities: communication, user, presence
  • Summary: The Get User Presence Information API retrieves the presence information of a specified user in Microsoft Graph. The API requires an Authorization header with a Bearer token for authentication. The user ID must be provided as a path parameter. The API supports different permission levels, such as Presence.Read and Presence.Read.All, depending on whether you are accessing your own presence information or another user's. The response includes the user's availability and activity status, and is returned in JSON format.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Virtual Appointment Join Web URL

  • ID: get_virtual_appointment_join_web_url
  • Operation: read
  • Entities: user, online meeting, virtual appointment
  • Summary: The 'Get Virtual Appointment Join Web URL' API retrieves a join web URL for a Microsoft Virtual Appointment. This URL includes enhanced business-to-customer experiences such as mobile browser join and virtual lobby rooms. The API requires an Authorization header with a Bearer token for authentication. The 'onlineMeetingId' path parameter is required to specify the online meeting. The response includes a 200 OK status code and a JSON body containing the join web URL. This API is available in the global service but not supported in US Government or China deployments. It requires 'VirtualAppointment.Read' permission for delegated work or school accounts.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Virtual Event Presenter

  • ID: get_virtual_event_presenter
  • Operation: read
  • Entities: presenter, townhall, virtual event
  • Summary: The Get Virtual Event Presenter API reads the properties and relationships of a virtualEventPresenter object. It requires the 'Authorization' header with a Bearer token for authentication. The API endpoint includes path parameters 'townhallId' and 'presenterId' to specify the virtual event townhall and presenter respectively. The response includes details about the presenter such as their ID, display name, tenant ID, and email address. This API supports the virtual event types: virtualEventTownhall and virtualEventWebinar, and is available in the global service cloud deployment.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Virtual Event Registration

  • ID: get_virtual_event_registration
  • Operation: read
  • Entities: virtual event registration, webinar, registration
  • Summary: The Get Virtual Event Registration API retrieves the properties and relationships of a virtualEventRegistration object. It requires the Authorization header with a Bearer token. The API endpoint includes path parameters webinarId and registrationId, which are required to specify the webinar and registration respectively. The response includes details such as the registrant's ID, name, email, registration status, and answers to registration questions. This API is available in the global service and requires specific permissions for access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Virtual Event Registrations

  • ID: get_virtual_event_registrations
  • Operation: read
  • Entities: webinar, registration, virtual event
  • Summary: The List Virtual Event Registrations API retrieves a list of all registration records for a specified webinar. It requires the 'Authorization' header with a Bearer token for authentication. The 'webinarId' path parameter is mandatory to identify the webinar. The API does not support OData query parameters. On success, it returns a 200 OK response with a collection of virtualEventRegistration objects, each containing details such as user ID, name, email, registration status, and answers to registration questions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Virtual Event Session

  • ID: get_virtual_event_session
  • Operation: read
  • Entities: virtual event webinar, virtual event townhall, virtual event session
  • Summary: The Get Virtual Event Session API allows you to read the properties and relationships of a virtualEventSession object. It supports virtual event types such as virtualEventTownhall and virtualEventWebinar. The API requires an Authorization header with a Bearer token. The path parameters webinarId and sessionId are required to specify the webinar and session respectively. The API does not support OData query parameters and does not require a request body. On success, it returns a 200 OK response with a virtualEventSession object containing details such as start and end times, join URL, subject, participants, and various settings related to the session.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Virtual Event Townhall Details

  • ID: get_virtual_event_townhall_details
  • Operation: read
  • Entities: virtual event townhall, user, co organizer
  • Summary: This API retrieves the details of a virtual event townhall using its unique identifier. It requires an Authorization header with a Bearer token for authentication. The API endpoint includes a path parameter 'id' which specifies the unique identifier of the townhall. The response includes details such as the status, display name, description, start and end times, creator information, audience, co-organizers, settings, invited attendees, and whether the event is invite-only. The API supports application permissions with specific access policies.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Virtual Event Webinar Details

  • ID: get_virtual_event_webinar_details
  • Operation: read
  • Entities: virtual event webinar, user, co organizer
  • Summary: The Get Virtual Event Webinar Details API allows users to retrieve the properties and relationships of a virtualEventWebinar object. This API requires an Authorization header with a Bearer token for authentication. The path parameter 'webinarId' is required to specify the unique identifier of the webinar. The API does not support OData query parameters and does not require a request body. Upon a successful request, it returns a 200 OK response code with a virtualEventWebinar object containing details such as the webinar's status, display name, description, start and end times, creator information, audience, co-organizers, and settings.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Virtual Event Webinar Registration Configuration

  • ID: get_virtual_event_webinar_registration_configuration
  • Operation: read
  • Entities: webinar, virtual event, registration configuration
  • Summary: This API retrieves the registration configuration for a specific virtual event webinar. It requires the 'webinarId' as a path parameter and an authorization token in the request headers. The API does not support OData query parameters and does not require a request body. Upon successful execution, it returns a 200 OK response with the registration web URL in the response body. The API is available globally but not in US Government or China national cloud deployments. Permissions required include 'VirtualEvent.Read' for delegated work or school accounts and 'VirtualEvent.Read.All' for applications.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Virtual Event Webinars by User ID and Role

  • ID: get_virtual_event_webinars_by_user_id_and_role
  • Operation: read
  • Entities: user, webinar, role
  • Summary: This API retrieves a collection of virtual event webinars where the specified user is either the organizer or a co-organizer. It requires the user ID and role as query parameters. The role can be either 'organizer' or 'coOrganizer'. The request must include an Authorization header with a Bearer token for authentication. The response includes details of the webinars such as their status, display name, description, start and end times, and the list of co-organizers.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Virtual Event Webinars by User Role

  • ID: get_virtual_event_webinars_by_user_role
  • Operation: read
  • Entities: virtual event webinar, permission, user role
  • Summary: The 'Get Virtual Event Webinars by User Role' API retrieves a collection of virtual event webinars where the signed-in user is either the organizer or a co-organizer. This API is accessible via the Microsoft Graph API and requires the 'VirtualEvent.Read' permission for delegated work or school accounts. The API endpoint is '/solutions/virtualEvents/webinars/getByUserRole(role='{role}')', where the 'role' query parameter specifies the user's role in the webinar, with possible values being 'organizer' or 'coOrganizer'. The request must include an 'Authorization' header with a valid bearer token. The response returns a 200 OK status with a collection of webinars, each containing details such as the webinar's ID, status, display name, description, start and end times, creator information, audience, co-organizers, and settings.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List Webinar Registration Questions

  • ID: get_webinar_registration_questions
  • Operation: read
  • Entities: webinar, virtual event, registration question
  • Summary: This API retrieves a list of all registration questions for a specified webinar. The questions can be either predefined or custom. The API requires an Authorization header with a Bearer token for authentication. The 'webinarId' path parameter is required to specify the webinar. The response includes a collection of question objects, each with details such as the question type, display name, whether it is required, and possible answer choices.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Event

  • ID: patch_update_event
  • Operation: write
  • Entities: user, event, calendar
  • Summary: The Update Event API allows you to modify an existing event in a user's calendar or the default calendar of a Microsoft 365 group. The API requires a PATCH request to the endpoint with the event ID. The request body can include various parameters such as original start and end time zones, response status, recurrence pattern, reminder settings, online meeting details, and categories. The response returns the updated event details, including online meeting information if applicable. Permissions required depend on the calendar type and include Calendars.ReadWrite for user calendars and Group.ReadWrite.All for group calendars.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Add Large Gallery View to a Call

  • ID: post_add_large_gallery_view_to_a_call
  • Operation: write
  • Entities: participant, call, large gallery view
  • Summary: This API adds a large gallery view to a call in Microsoft Graph. It requires the call ID as a path parameter and a unique client context string in the request body. The API is accessed via a POST request to the specified URL, with required headers for authorization and content type. Upon success, it returns a 202 Accepted response with an operation object detailing the status and context of the request. The API is available globally but not in certain government or China-operated environments. It requires application permissions such as Calls.JoinGroupCallAsGuest.All.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Answer Incoming Call

  • ID: post_answer_incoming_call
  • Operation: write
  • Entities: call, bot, participant
  • Summary: This API enables a bot to answer an incoming call, which can be an invitation from a participant in a group call or a peer-to-peer call. The bot must answer, reject, or redirect the call before it times out. The API supports various PSTN scenarios and requires specific permissions for operation. The request includes headers for authorization and content type, a path parameter for the call ID, and a body with parameters like callbackUri, acceptedModalities, callOptions, mediaConfig, and participantCapacity. The response returns a 202 Accepted status, indicating the call has been successfully answered.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Cancel Media Processing for Calls

  • ID: post_cancel_media_processing_for_calls
  • Operation: write
  • Entities: call, media operation, IVR operation
  • Summary: The Cancel Media Processing API cancels any in-progress or queued media operations for a call, such as playPrompt and recordResponse, but does not affect subscribeToTone operations. It requires the 'Calls.Initiate.All' or 'Calls.AccessMedia.All' application permissions. The API is available in various national cloud deployments except China operated by 21Vianet. The request requires an Authorization header with a bearer token and a Content-type header set to application/json. The request body must include a 'clientContext' parameter. A successful response returns a 200 OK status with a Location header pointing to the created commsOperation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Cancel Virtual Event Registration

  • ID: post_cancel_virtual_event_registration
  • Operation: write
  • Entities: registrant, webinar, registration
  • Summary: The Cancel Virtual Event Registration API allows you to cancel a registrant's registration record for a webinar. This API is available in the global service and requires the 'VirtualEvent.ReadWrite' permission for delegated work or school accounts, or 'VirtualEvent.ReadWrite.All' for application permissions. The API endpoint requires the 'webinarId' and 'registrationId' as path parameters and an 'Authorization' header with a bearer token. No request body is needed. A successful request returns a 204 No Content response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Cancel Virtual Event Townhall

  • ID: post_cancel_virtual_event_townhall
  • Operation: write
  • Entities: townhall, organizer, virtual event
  • Summary: The Cancel Virtual Event Townhall API allows the organizer to cancel a townhall event, setting its status to canceled permanently. The API requires an Authorization header with a Bearer token for authentication. The townhall ID must be provided as a path parameter. No request body is needed. Upon successful cancellation, the API returns a 204 No Content response, indicating that the operation was successful and no content is returned in the response body. Only the organizer has the permission to cancel the event.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Cancel Virtual Event Webinar

  • ID: post_cancel_virtual_event_webinar
  • Operation: write
  • Entities: webinar, organizer, virtual event
  • Summary: The Cancel Virtual Event Webinar API allows the organizer to cancel a webinar by setting its status to canceled permanently. The API requires an Authorization header with a Bearer token for authentication. The unique identifier of the webinar must be provided as a path parameter. No request body is needed. Upon successful cancellation, the API returns a 204 No Content response, indicating that the operation was successful and no content is returned in the response body. Only the organizer has the permission to cancel a webinar, and the least privileged permission required is VirtualEvent.ReadWrite for delegated work or school accounts.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Change Screen Sharing Role in a Group Call

  • ID: post_change_screen_sharing_role
  • Operation: write
  • Entities: screen sharing, role, participant
  • Summary: The 'Change Screen Sharing Role in a Group Call' API allows applications to change the screen sharing role of a participant in a group call. This is only supported for group calls that use App-Hosted Media. The API requires the 'Calls.AccessMedia.All' permission for applications. The request must include the call ID as a path parameter and the desired role ('viewer' or 'sharer') in the request body. Upon success, the API returns a 202 Accepted response, and all participants receive a roster update with the new screen sharing role.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Clear User Preferred Presence

  • ID: post_clear_user_preferred_presence
  • Operation: write
  • Entities: availability, user, presence
  • Summary: The 'Clear User Preferred Presence' API clears the preferred availability and activity status for a specified user. It requires a POST request to the endpoint '/users/{userId}/presence/clearUserPreferredPresence' with the user's unique identifier as a path parameter. The request must include an 'Authorization' header with a valid Bearer token and a 'Content-Type' header set to 'application/json'. The request body should be an empty JSON object. Upon success, the API returns a 200 OK status with an empty response body. This API is available in various national cloud deployments except for China operated by 21Vianet. The least privileged permission required is 'Presence.ReadWrite' for delegated work or school accounts, and 'Presence.ReadWrite.All' for application permissions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Clear User Presence Session

  • ID: post_clear_user_presence_session
  • Operation: write
  • Entities: user, presence, application
  • Summary: The 'Clear User Presence Session' API allows an application to clear its presence session for a specified user. This is done by sending a POST request to the endpoint with the user's ID and the session ID of the application's presence session. The request requires an Authorization header with a Bearer token and a Content-Type header set to application/json. The request body must include the sessionId parameter, which is the ID of the application's presence session. If successful, the API returns a 200 OK response. If the presence session does not exist, a 404 NotFound response is returned. This API is available in various national cloud deployments, except for China operated by 21Vianet.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create audioRoutingGroup

  • ID: post_create_audioroutinggroup
  • Operation: write
  • Entities: call, permission, audio routing group
  • Summary: The Create audioRoutingGroup API allows you to create a new audio routing group for a specific call identified by its ID. The API requires an Authorization header with a Bearer token for authentication. The request body must include a JSON representation of the audioRoutingGroup object, specifying the id, routingMode, sources, and receivers. The API returns a 200 OK response with the created audioRoutingGroup object in the response body. The API is available globally but not supported in US Government L4, L5, or China operated by 21Vianet. The /app path is deprecated; use the /communications path instead.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create call

  • ID: post_create_call
  • Operation: write
  • Entities: call, bot, meeting
  • Summary: The Create call API allows a bot to create a new outgoing peer-to-peer or group call, or join an existing meeting. It requires the bot to be registered and appropriate permissions to be granted. The API supports various PSTN scenarios and is available in multiple national cloud deployments. The request requires an authorization token and a JSON representation of a call object, including callback URI, targets, requested modalities, call options, and media configuration. A successful response returns a 201 Created status with a call object detailing the call's state, direction, source, targets, and media configuration.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Event

  • ID: post_create_event
  • Operation: write
  • Entities: attendee, event, calendar
  • Summary: The Create Event API allows users to create an event in their default or specified calendar using Microsoft Graph. The API requires an Authorization header with a Bearer token and a Content-Type of application/json. The request body must include details such as the subject, body, start and end times, location, and attendees of the event. Optional parameters include allowing new time proposals, specifying a transaction ID, and enabling the event as an online meeting with a specified provider. The response returns a 201 Created status with the event details, including the start and end times, location, attendees, and online meeting information if applicable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Online Meeting

  • ID: post_create_online_meeting
  • Operation: write
  • Entities: user, permission, online meeting
  • Summary: The Create Online Meeting API allows users to create a standalone online meeting on behalf of a user. This API is not associated with any event on the user's calendar and does not create a Teams live event. It requires specific permissions, such as OnlineMeetings.ReadWrite for delegated work or school accounts. The API accepts headers like Authorization and Content-type, and a JSON body containing meeting details such as startDateTime, endDateTime, and subject. The response includes details about the meeting, such as audio conferencing information, chat info, and participant details. The API supports optional passcode settings for joining the meeting.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create or Get Online Meeting

  • ID: post_create_or_get_online_meeting
  • Operation: write
  • Entities: user, online meeting, participant
  • Summary: The 'Create or Get Online Meeting' API allows users to create a new online meeting or retrieve an existing one using a custom external ID. The API requires an authorization token and a JSON request body containing parameters such as startDateTime, endDateTime, subject, externalId, and participants. If the external ID already exists, the existing meeting is returned; otherwise, a new meeting is created. The response includes details about the meeting, such as its ID, creation time, start and end times, join URL, subject, and participants. The API supports delegated and application permissions, with specific requirements for application access policies.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create User

  • ID: post_create_user
  • Operation: write
  • Entities: account, user, permission
  • Summary: The Create User API allows you to create a new user in Microsoft Graph. The request requires an authorization token and a JSON payload with user details such as accountEnabled, displayName, mailNickname, userPrincipalName, and passwordProfile. The API supports extensions, allowing custom properties to be added to the user instance. Successful requests return a 201 Created status and a user object in the response. This API is available in various national cloud deployments and requires specific permissions to access.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create virtualEventPresenter

  • ID: post_create_virtual_event_presenter
  • Operation: write
  • Entities: presenter, virtual event, identity
  • Summary: The Create virtualEventPresenter API allows you to create a new presenter for a virtual event, specifically for virtualEventTownhall or virtualEventWebinar. The API requires an Authorization header with a Bearer token and a Content-Type of application/json. The request body must include the identity of the presenter, which can be either a communicationsGuestIdentity or communicationsUserIdentity. For webinars, additional presenter details can be provided. Upon successful creation, the API returns a 201 Created response with the details of the newly created presenter.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create virtualEventRegistration

  • ID: post_create_virtual_event_registration
  • Operation: write
  • Entities: registrant, virtual event registration, webinar
  • Summary: The Create virtualEventRegistration API allows you to register a person for a webinar. It supports both delegated and application permissions. For delegated permissions, you need to provide the registrant's preferred timezone, language, and optionally their answers to registration questions. For application permissions, you must provide the registrant's first name, last name, email, preferred timezone, language, and optionally their answers to registration questions. The API returns a 201 Created response with the registration details for delegated permissions and a 204 No Content response for application permissions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Virtual Event Registration Custom Question

  • ID: post_create_virtual_event_registration_custom_question
  • Operation: write
  • Entities: webinar, virtual event, registration question
  • Summary: This API allows you to create a registration question for a webinar, either predefined or custom. It requires an Authorization header with a Bearer token and a Content-Type of application/json. The request body can include properties such as displayName, answerInputType, answerChoices, isRequired for custom questions, or label for predefined questions. The response returns a 201 Created status with the question object details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create virtualEventTownhall

  • ID: post_create_virtual_event_townhall
  • Operation: write
  • Entities: virtual event townhall, coorganizer, audience
  • Summary: The Create virtualEventTownhall API allows you to create a new virtualEventTownhall object in draft mode. This API is available globally but not in US Government or China deployments. It requires the 'VirtualEvent.ReadWrite' permission for delegated work or school accounts. The API endpoint is POST /solutions/virtualEvents/townhalls. The request must include an Authorization header with a Bearer token and a Content-Type of application/json. The request body can include properties such as audience, coOrganizers, description, displayName, endDateTime, invitedAttendees, isInviteOnly, settings, and startDateTime. The response returns a 201 Created status code with a virtualEventTownhall object, including details like id, status, displayName, description, startDateTime, endDateTime, audience, createdBy, coOrganizers, settings, invitedAttendees, and isInviteOnly.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create virtualEventWebinar

  • ID: post_create_virtual_event_webinar
  • Operation: write
  • Entities: virtual event webinar, permission, audience
  • Summary: The Create virtualEventWebinar API allows you to create a new virtualEventWebinar object in draft mode. This API is available globally but not in US Government or China deployments. It requires the 'VirtualEvent.ReadWrite' permission for delegated work or school accounts. The request must include an Authorization header with a bearer token and a Content-Type header set to 'application/json'. The request body should contain details about the webinar, including its display name, description, start and end times, audience, co-organizers, and settings. A successful response returns a 201 Created status and the created virtualEventWebinar object, including its ID, status, and creator information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Presence Information for Multiple Users

  • ID: post_get_presence_information_for_multiple_users
  • Operation: read
  • Entities: communication, user, presence
  • Summary: The 'Get Presence Information for Multiple Users' API allows you to retrieve presence information for multiple users by their user IDs. This API requires an authorization token and a JSON body containing a collection of user IDs (up to 650 per request). The response includes a collection of presence objects, each containing the user's ID, availability, and activity status. The API is available in various national cloud deployments, except for China operated by 21Vianet. It supports a maximum request rate of 1500 API requests in a 30-second period per application per tenant.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Invite Participants to an Active Call

  • ID: post_invite_participants_to_active_call
  • Operation: write
  • Entities: call, operation, participant
  • Summary: This API allows inviting participants to an active call in Microsoft Graph. It supports inviting multiple participants in a group call but only one participant when replacing an existing peer-to-peer call. The request requires an authorization token and a JSON body specifying the participants and a unique client context. The response includes the operation status and details of the invited participants. This API is available in various national cloud deployments except for China operated by 21Vianet.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Keep a Call Alive

  • ID: post_keep_a_call_alive
  • Operation: write
  • Entities: call, permission, http request
  • Summary: The 'Keep a Call Alive' API is used to ensure that an ongoing call remains active by sending a POST request to the specified endpoint every 15 to 45 minutes. The API requires an Authorization header with a Bearer token and the call's unique identifier as a path parameter. No request body is needed. A successful request returns a 200 OK response. If a call does not receive this request within 45 minutes, it is considered inactive and will end. Attempting to send a request to a call that has already ended will result in a 404 Not-Found error. This API is available in various national cloud deployments, except for China operated by 21Vianet. The required permissions are Calls.Initiate.All or Calls.AccessMedia.All for application type.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Log Teleconference Device Quality

  • ID: post_log_teleconference_device_quality
  • Operation: write
  • Entities: CVI bot, video teleconferencing device, teleconference device quality
  • Summary: The Log Teleconference Device Quality API allows Cloud Video Interop (CVI) partners to log the quality data of video teleconferencing (VTC) devices. The API requires an Authorization header with a Bearer token and a User-Agent header specifying the calling application's name and version. The request body must include a JSON object with teleconference device quality data, including call chain ID, participant ID, media leg ID, device name, and a list of media quality metrics. The API returns a 200 OK response code if successful, with no response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Mute a Call Participant

  • ID: post_mute_a_call_participant
  • Operation: write
  • Entities: call, permission, participant
  • Summary: This API allows an application to mute itself in a group call. It is a server-side mute, meaning the server will drop all audio packets for the participant, even if the participant continues to stream audio. The API is only supported for group calls and requires the 'Calls.Initiate.All' or 'Calls.AccessMedia.All' application permissions. The request must include the call ID in the path and a unique client context string in the body. A successful response returns a 200 OK status and a muteParticipantOperation object, indicating the operation's completion.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Mute a Specific Participant in a Call

  • ID: post_mute_specific_participant
  • Operation: write
  • Entities: call, operation, participant
  • Summary: This API mutes a specific participant in a group call by dropping all audio packets for the participant on the server side. It requires the call ID and participant ID as path parameters, and a client context string in the request body. The API is only supported for group calls and requires appropriate permissions. Upon successful execution, it returns a 200 OK response with a muteParticipantOperation object, and all participants receive a roster update.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Participant: Start Hold Music

  • ID: post_participant_start_hold_music
  • Operation: write
  • Entities: participant, call, music
  • Summary: The 'Participant: Start Hold Music' API allows you to put a participant on hold and play music in the background during a call. This API is available in various national cloud deployments except for China operated by 21Vianet. It requires application permissions such as Calls.JoinGroupCallasGuest.All or Calls.JoinGroupCall.All. The API endpoint is POST /communications/calls/{id}/participants/{id}/startHoldMusic, where {id} represents the call and participant IDs. The request headers must include an Authorization token and Content-type as application/json. The request body can optionally include a clientContext string and a customPrompt object specifying the audio prompt. A successful response returns a 202 Accepted status with a startHoldMusicOperation object, indicating the operation's status and client context.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Play a Prompt in a Call

  • ID: post_play_prompt_in_call
  • Operation: write
  • Entities: client context, call, media prompt
  • Summary: The Play a Prompt in a Call API allows you to play a prompt in an ongoing call. This API is part of the Microsoft Graph API and is used to play media prompts in calls that are initiated with serviceHostedMediaConfig. The API requires an Authorization header with a Bearer token for authentication. The request body must include a collection of media prompts and a unique client context string. The response includes a playPromptOperation object with details about the operation, including its status and client context. This API is available in various national cloud deployments except for China operated by 21Vianet.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Publish Virtual Event Townhall

  • ID: post_publish_virtual_event_townhall
  • Operation: write
  • Entities: virtual event townhall, organizer, audience
  • Summary: The 'Publish Virtual Event Townhall' API allows the organizer to publish a virtual event townhall, making it visible to its audience. This API requires an HTTP POST request to the specified endpoint with the townhall ID as a path parameter. The request must include an 'Authorization' header with a valid bearer token. No request body is needed. Upon successful execution, the API returns a 204 No Content response, indicating that the townhall has been successfully published.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Publish Virtual Event Webinar

  • ID: post_publish_virtual_event_webinar
  • Operation: write
  • Entities: webinar, organizer, audience
  • Summary: The 'Publish Virtual Event Webinar' API allows the organizer to publish a webinar, making it visible to its audience. This API requires the 'VirtualEvent.ReadWrite' permission for delegated work or school accounts. The request is made using the POST method to the endpoint '/solutions/virtualEvents/webinars/{id}/publish', where '{id}' is the unique identifier of the webinar. The request must include an 'Authorization' header with a valid bearer token. No request body is needed. A successful request returns a 204 No Content response, indicating that the webinar has been successfully published.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Record a Short Audio Response from Caller

  • ID: post_record_audio_response
  • Operation: write
  • Entities: call, bot, record
  • Summary: This API records a short audio response from a caller using a bot. It is used to capture a voice response after the caller is prompted. The API requires an Authorization header with a Bearer token and a call ID as a path parameter. The request body includes parameters such as prompts, bargeInAllowed, initialSilenceTimeoutInSeconds, maxSilenceTimeoutInSeconds, maxRecordDurationInSeconds, playBeep, stopTones, and clientContext. The response returns a 200 OK status with a Location header pointing to the recordOperation created. The recording is not saved permanently and must be downloaded promptly after the operation finishes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Redirect an Incoming Call

  • ID: post_redirect_an_incoming_call
  • Operation: write
  • Entities: call, bot, participant
  • Summary: This API allows redirecting an incoming call that hasn't been answered or rejected yet. The call can be redirected to one or multiple targets, with the option for simultaneous ringing. The request requires an Authorization header with a Bearer token. The body must include the targets for the redirect, an optional timeout value, and a callback URI. The response returns a 202 Accepted status if successful, with details of the call state and participants.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Reject Incoming Call

  • ID: post_reject_incoming_call
  • Operation: write
  • Entities: call, bot, permission
  • Summary: The 'Reject Incoming Call' API enables a bot to reject an incoming call, which can be an invite from a participant in a group call or a peer-to-peer call. The bot must respond before the call times out, which is set to 15 seconds. This API does not terminate existing calls that have already been answered. The API requires an Authorization header with a Bearer token and a Content-type header set to application/json. The path parameter 'id' is required to specify the call to be rejected. The request body must include a 'reason' for rejection, with possible values being 'None', 'Busy', or 'Forbidden'. Optionally, a 'callbackUri' can be provided for the bot to receive notifications. Upon success, the API returns a 202 Accepted response code with no content in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Send DTMF Tones in a Call

  • ID: post_send_dtmf_tones_in_a_call
  • Operation: write
  • Entities: call, operation, tone
  • Summary: The 'Send DTMF Tones in a Call' API allows you to send Dual-Tone Multi-Frequency (DTMF) tones during a call. This API requires an application permission of either 'Calls.Initiate.All' or 'Calls.AccessMedia.All'. The request must include an authorization header with a bearer token, and the call ID must be specified in the path parameters. The request body should contain the tones to be sent, the delay between tones in milliseconds, and a unique client context string. Upon success, the API returns a 200 OK response with a sendDtmfTonesOperation object, indicating the status of the operation.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Send Virtual Appointment Reminder SMS

  • ID: post_send_virtual_appointment_reminder_sms
  • Operation: write
  • Entities: attendee, online meeting, appointment
  • Summary: The 'Send Virtual Appointment Reminder SMS' API allows sending an SMS reminder to external attendees for a Teams virtual appointment. This feature requires Teams premium and is available only for attendees with a valid United States phone number. The API requires a bearer token for authorization and accepts a JSON body with details of the attendees and the reminder time interval. Upon successful execution, it returns a 202 Accepted response code with an empty body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Send Virtual Appointment SMS Notification

  • ID: post_send_virtual_appointment_sms_notification
  • Operation: write
  • Entities: attendee, sms notification, online meeting
  • Summary: The 'Send Virtual Appointment SMS Notification' API allows sending SMS notifications to external attendees of a Teams virtual appointment when it is confirmed, rescheduled, or canceled. This API requires Teams premium and is available in the global service. The request must include an authorization token in the headers and a JSON body specifying the attendees' phone numbers and time zones, along with the type of message to send. The API returns a 202 Accepted response code if successful.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Set User Preferred Presence

  • ID: post_set_user_preferred_presence
  • Operation: write
  • Entities: user, presence, session
  • Summary: The 'Set User Preferred Presence' API allows setting the preferred availability and activity status for a user. This API requires a POST request to the endpoint '/users/{userId}/presence/setUserPreferredPresence' with the user's ID as a path parameter. The request must include an Authorization header with a Bearer token and a Content-Type header set to 'application/json'. The request body should contain 'availability', 'activity', and optionally 'expirationDuration' in ISO 8601 format. Supported combinations of availability and activity include 'Available', 'Busy', 'DoNotDisturb', 'BeRightBack', 'Away', and 'Offline'. If successful, the API returns a 200 OK response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Set User Presence Session

  • ID: post_set_user_presence_session
  • Operation: write
  • Entities: presence session, user, application
  • Summary: The Set User Presence Session API allows an application to set the presence state of a user's session in Microsoft Teams. This API is used to update the presence session state for a user, which can be aggregated from multiple sessions across different Teams clients. The API requires an Authorization header with a Bearer token and a Content-Type of application/json. The request body must include a sessionId, availability, and activity, with an optional expirationDuration in ISO 8601 format. The response is a 200 OK status with an empty body, indicating the presence session was successfully set.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Set User Presence Status Message

  • ID: post_set_user_presence_status_message
  • Operation: write
  • Entities: status message, user, presence
  • Summary: The 'Set User Presence Status Message' API allows setting a presence status message for a user in Microsoft Graph. The API requires a POST request to the endpoint '/users/{userId}/presence/setStatusMessage' with the user's ID as a path parameter. The request must include an Authorization header with a Bearer token and a Content-Type header set to 'application/json'. The request body should contain a 'statusMessage' object with a 'message' object specifying the content and type of the status message. Optionally, an 'expiryDateTime' object can be included to specify when the status message should expire. The API returns a 200 OK response if successful, with an empty response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Stop Hold Music for a Participant in a Call

  • ID: post_stop_hold_music_for_participant
  • Operation: write
  • Entities: stop hold music operation, call, participant
  • Summary: The 'Stop Hold Music for a Participant in a Call' API allows you to reincorporate a participant previously put on hold back into the call. This API is part of the Microsoft Graph API and is available in various national cloud deployments except for China operated by 21Vianet. It requires application permissions such as Calls.JoinGroupCallasGuest.All or Calls.JoinGroupCall.All. The API endpoint is POST /communications/calls/{id}/participants/{id}/stopHoldMusic, where {id} represents the call and participant IDs. The request must include an Authorization header with a bearer token and a Content-type header set to application/json. The request body can optionally include a clientContext string. A successful response returns a 202 Accepted status code and a stopHoldMusicOperation object, indicating the operation's completion status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Subscribe to DTMF Tone Notifications for a Call

  • ID: post_subscribe_to_dtmf_tone_notifications
  • Operation: write
  • Entities: client context, call, tone
  • Summary: The 'Subscribe to DTMF Tone Notifications for a Call' API allows applications to subscribe to dual-tone multi-frequency (DTMF) signaling notifications for a specific call. This is useful for being notified when a user presses keys on a dialpad during a call. The API requires an Authorization header with a Bearer token for authentication. The call ID must be provided as a path parameter, and a unique client context string must be included in the request body. Upon success, the API returns a 200 OK response with details of the subscription operation, including the operation ID and status. This API is only supported for calls initiated with serviceHostedMediaConfig and is available in various national cloud deployments except for China operated by 21Vianet.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Transfer an Active Call

  • ID: post_transfer_active_call
  • Operation: write
  • Entities: call, transfer, participant
  • Summary: This API allows the transfer of an active peer-to-peer or group call to another participant or PSTN number. The transfer can be direct or consultative, where the transferor informs the transferee before the transfer. The API requires the 'Calls.Initiate.All' permission for application instances. The request includes headers for authorization and content type, a path parameter for the call ID, and a body specifying the transfer target and optionally the transferee for group calls. The response returns a 202 Accepted status with notifications about the call state changes, such as transferring, transferAccepted, or terminated.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Unmute a Call Participant

  • ID: post_unmute_call_participant
  • Operation: write
  • Entities: call, media stream, participant
  • Summary: This API allows an application to unmute itself in a group call. It is a server-side unmute operation, meaning the server will start sending audio packets for this participant to other participants again. The API is only supported for group calls and is available in various national cloud deployments except for China operated by 21Vianet. The request requires an Authorization header with a Bearer token and a Content-type header set to application/json. The request body must include a 'clientContext' parameter, which is a unique string. Upon success, the API returns a 200 OK response with a 'unmuteParticipantOperation' object, indicating the operation's status and details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Call Recording Status

  • ID: post_update_call_recording_status
  • Operation: write
  • Entities: recording, call, application
  • Summary: The Update Call Recording Status API allows applications to update the recording status of a call in Microsoft Teams. This API is part of the Teams policy-based recording solution and is required to be called before and after recording any meeting. The API requires an application permission of Calls.AccessMedia.All or higher. The request must include the call ID as a path parameter, and the request body must contain a clientContext and a status indicating the recording state. A successful response returns a 200 OK status with a Location header pointing to the operation object.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated about 1 month ago