Microsoft.Graph.CloudCommunications Module
Microsoft Graph PowerShell Cmdlets
Microsoft.Graph.CloudCommunications Cmdlets
| Cmdlet | Description |
|---|---|
| Add-MgCommunicationCallLargeGalleryView |
Add the large gallery view to a call. For details about how to identify a large gallery view participant in a roster so that you can retrieve the relevant data to subscribe to the video feed, see Identify large gallery view participants in a roster. |
| Clear-MgCommunicationPresence |
Clear the application's presence session for a user. If it is the user's only presence session, the user's presence will change to Offline/Offline. For details about presences sessions, see presence: setPresence. |
| Clear-MgCommunicationPresenceUserPreferredPresence |
Clear the preferred availability and activity status for a user. |
| Clear-MgUserPresence |
Clear the application's presence session for a user. If it is the user's only presence session, the user's presence will change to Offline/Offline. For details about presences sessions, see presence: setPresence. |
| Clear-MgUserPresenceUserPreferredPresence |
Clear the preferred availability and activity status for a user. |
| Get-MgCommunicationCall |
Retrieve the properties and relationships of a call object. |
| Get-MgCommunicationCallAudioRoutingGroup |
Retrieve the properties and relationships of an audioRoutingGroup object. |
| Get-MgCommunicationCallAudioRoutingGroupCount |
Get the number of the resource |
| Get-MgCommunicationCallContentSharingSession |
Retrieve the properties of a contentSharingSession object in a call. |
| Get-MgCommunicationCallContentSharingSessionCount |
Get the number of the resource |
| Get-MgCommunicationCallCount |
Get the number of the resource |
| Get-MgCommunicationCallOperation |
Get the status of an operation that adds the large gallery view to a call. |
| Get-MgCommunicationCallOperationCount |
Get the number of the resource |
| Get-MgCommunicationCallParticipant |
Retrieve the properties and relationships of a participant object. |
| Get-MgCommunicationCallParticipantCount |
Get the number of the resource |
| Get-MgCommunicationCallRecord |
Retrieve the properties and relationships of a callRecord object. You can get the id of a callRecord in two ways:* Subscribe to change notifications to the /communications/callRecords endpoint.* Use the callChainId property of a call. The call record is available only after the associated call is completed. |
| Get-MgCommunicationCallRecordCount |
Get the number of the resource |
| Get-MgCommunicationCallRecordOrganizerV2 |
Identity of the organizer of the call. This relationship is expanded by default in callRecord methods. |
| Get-MgCommunicationCallRecordParticipant |
Get the number of the resource |
| Get-MgCommunicationCallRecordParticipantV2 |
List of distinct participants in the call. |
| Get-MgCommunicationCallRecordSession |
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. |
| Get-MgCommunicationCallRecordSessionCount |
Get the number of the resource |
| Get-MgCommunicationCallRecordSessionSegmentCount |
Get the number of the resource |
| Get-MgCommunicationOnlineMeeting |
Get onlineMeetings from communications |
| Get-MgCommunicationOnlineMeetingAttendanceReport |
The attendance reports of an online meeting. Read-only. |
| Get-MgCommunicationOnlineMeetingAttendanceReportAttendanceRecord |
List of attendance records of an attendance report. Read-only. |
| Get-MgCommunicationOnlineMeetingAttendanceReportAttendanceRecordCount |
Get the number of the resource |
| Get-MgCommunicationOnlineMeetingAttendanceReportCount |
Get the number of the resource |
| Get-MgCommunicationOnlineMeetingAttendeeReport |
The content stream of the attendee report of a Microsoft Teams live event. Read-only. |
| Get-MgCommunicationOnlineMeetingCount |
Get the number of the resource |
| Get-MgCommunicationOnlineMeetingRecording |
The recordings of an online meeting. Read-only. |
| Get-MgCommunicationOnlineMeetingRecordingContent |
The content of the recording. Read-only. |
| Get-MgCommunicationOnlineMeetingRecordingCount |
Get the number of the resource |
| Get-MgCommunicationOnlineMeetingRecordingDelta |
Invoke function delta |
| Get-MgCommunicationOnlineMeetingTranscript |
The transcripts of an online meeting. Read-only. |
| Get-MgCommunicationOnlineMeetingTranscriptContent |
The content of the transcript. Read-only. |
| Get-MgCommunicationOnlineMeetingTranscriptCount |
Get the number of the resource |
| Get-MgCommunicationOnlineMeetingTranscriptDelta |
Invoke function delta |
| Get-MgCommunicationOnlineMeetingTranscriptMetadataContent |
The time-aligned metadata of the utterances in the transcript. Read-only. |
| Get-MgCommunicationOnlineMeetingVirtualAppointmentJoinWebUrl |
Get a join web URL for a Microsoft Virtual Appointment. This web URL includes enhanced business-to-customer experiences such as mobile browser join and virtual lobby rooms. With Teams Premium, you can configure a custom lobby room experience for attendees by adding your company logo and access the Virtual Appointments usage report for organizational analytics. |
| Get-MgCommunicationPresence |
Get a user's presence information. |
| Get-MgCommunicationPresenceByUserId |
Get the presence information for multiple users. |
| Get-MgCommunicationPresenceCount |
Get the number of the resource |
| Get-MgUserOnlineMeeting |
Information about a meeting, including the URL used to join a meeting, the attendees list, and the description. |
| Get-MgUserOnlineMeetingAttendanceReport |
The attendance reports of an online meeting. Read-only. |
| Get-MgUserOnlineMeetingAttendanceReportAttendanceRecord |
List of attendance records of an attendance report. Read-only. |
| Get-MgUserOnlineMeetingAttendanceReportAttendanceRecordCount |
Get the number of the resource |
| Get-MgUserOnlineMeetingAttendanceReportCount |
Get the number of the resource |
| Get-MgUserOnlineMeetingAttendeeReport |
The content stream of the attendee report of a Microsoft Teams live event. Read-only. |
| Get-MgUserOnlineMeetingCount |
Get the number of the resource |
| Get-MgUserOnlineMeetingRecording |
Get a callRecording object associated with a scheduled onlineMeeting. This API supports the retrieval of call recordings from private chat meetings and channel meetings. However, private channel meetings are not supported at this time. For a recording, this API returns the metadata of the single recording associated with the online meeting. For the content of a recording, this API returns the stream of bytes associated with the recording. |
| Get-MgUserOnlineMeetingRecordingContent |
The content of the recording. Read-only. |
| Get-MgUserOnlineMeetingRecordingCount |
Get the number of the resource |
| Get-MgUserOnlineMeetingRecordingDelta |
Invoke function delta |
| Get-MgUserOnlineMeetingTranscript |
Retrieve a callTranscript object associated with a scheduled onlineMeeting. This API supports the retrieval of call transcripts from private chat meetings and channel meetings. However, private channel meetings are not supported at this time. Retrieving the transcript returns the metadata of the single transcript associated with the online meeting. Retrieving the content of the transcript returns the stream of text associated with the transcript. |
| Get-MgUserOnlineMeetingTranscriptContent |
Retrieve a callTranscript object associated with a scheduled onlineMeeting. This API supports the retrieval of call transcripts from private chat meetings and channel meetings. However, private channel meetings are not supported at this time. Retrieving the transcript returns the metadata of the single transcript associated with the online meeting. Retrieving the content of the transcript returns the stream of text associated with the transcript. |
| Get-MgUserOnlineMeetingTranscriptCount |
Get the number of the resource |
| Get-MgUserOnlineMeetingTranscriptDelta |
Invoke function delta |
| Get-MgUserOnlineMeetingTranscriptMetadataContent |
Retrieve a callTranscript object associated with a scheduled onlineMeeting. This API supports the retrieval of call transcripts from private chat meetings and channel meetings. However, private channel meetings are not supported at this time. Retrieving the transcript returns the metadata of the single transcript associated with the online meeting. Retrieving the content of the transcript returns the stream of text associated with the transcript. |
| Get-MgUserOnlineMeetingVirtualAppointmentJoinWebUrl |
Get a join web URL for a Microsoft Virtual Appointment. This web URL includes enhanced business-to-customer experiences such as mobile browser join and virtual lobby rooms. With Teams Premium, you can configure a custom lobby room experience for attendees by adding your company logo and access the Virtual Appointments usage report for organizational analytics. |
| Get-MgUserPresence |
Get a user's presence information. |
| Invoke-MgAnswerCommunicationCall |
Enable a bot to answer an incoming call. The incoming call request can be an invitation from a participant in a group call or a peer-to-peer call. If an invitation to a group call is received, the notification contains the chatInfo and meetingInfo parameters. The bot is expected to answer, reject, or redirect the call before the call times out. The current timeout value is 15 seconds for regular scenarios and 5 seconds for policy-based recording scenarios. This API supports the following PSTN scenarios: |
| Invoke-MgCreateOrGetCommunicationOnlineMeeting |
Create an onlineMeeting object with a custom specified external ID. If the external ID already exists, this API will return the onlineMeeting object with that external ID. |
| Invoke-MgInviteCommunicationCallParticipant |
Delete a specific participant in a call. In some situations, it is appropriate for an application to remove a participant from an active call. This action can be done before or after the participant answers the call. When an active caller is removed, they are immediately dropped from the call with no pre- or post-removal notification. When an invited participant is removed, any outstanding add participant request is canceled. |
| Invoke-MgKeepCommunicationCallAlive |
Make a request to this API every 15 to 45 minutes to ensure that an ongoing call remains active. A call that does not receive this request within 45 minutes is considered inactive and will subsequently end. At least one successful request must be made within 45 minutes of the previous request, or the start of the call. We recommend that you send a request in shorter time intervals (every 15 minutes). Make sure that these requests are successful to prevent the call from timing out and ending. Attempting to send a request to a call that has already ended will result in a 404 Not-Found error. The resources related to the call should be cleaned up on the application side. |
| Invoke-MgLogCommunicationCallTeleconferenceDeviceQuality |
Log video teleconferencing device quality data. The Cloud Video Interop (CVI) bot represents video teleconferencing (VTC) devices and acts as a back-to-back agent for a VTC device in a conference call. Because a CVI bot is in the middle of the VTC and Microsoft Teams infrastructure as a VTC proxy, it has two media legs. One media leg is between the CVI bot and Teams infrastructure, such as Teams conference server or a Teams client. The other media leg is between the CVI bot and the VTC device. The third-party partners own the VTC media leg and the Teams infrastructure cannot access the quality data of the third-party call leg. This method is only for the CVI partners to provide their media quality data. |
| Invoke-MgMuteCommunicationCall |
Allows the application to mute itself. This is a server mute, meaning that the server will drop all audio packets for this participant, even if the participant continues to stream audio. For more details about how to handle mute operations, see muteParticipantOperation |
| Invoke-MgMuteCommunicationCallParticipant |
Mute a specific participant in the call. This is a server mute, meaning that the server will drop all audio packets for this participant, even if the participant continues to stream audio. For more information about how to handle mute operations, see muteParticipantOperation. |
| Invoke-MgPlayCommunicationCallPrompt |
Play a prompt in the call. For more information about how to handle operations, see commsOperation |
| Invoke-MgRecordCommunicationCallResponse |
Records a short audio response from the caller.A bot can utilize this to capture a voice response from a caller after they are prompted for a response. For further information on how to handle operations, please review commsOperation This action is not intended to record the entire call. The maximum length of recording is 2 minutes. The recording is not saved permanently by the Cloud Communications Platform and is discarded shortly after the call ends. The bot must download the recording promptly after the recording operation finishes by using the recordingLocation value that's given in the completed notification. |
| Invoke-MgRedirectCommunicationCall |
Redirect an incoming call that hasn't been answered or rejected yet. The terms 'redirecting' and 'forwarding' a call are used interchangeably. The bot is expected to redirect the call before the call times out. The current timeout value is 15 seconds. |
| Invoke-MgRejectCommunicationCall |
Enable a bot to reject an incoming call. The incoming call request can be an invite from a participant in a group call or a peer-to-peer call. If an invite to a group call is received, the notification will contain the chatInfo and meetingInfo parameters. The bot is expected to answer or reject the call before the call times out. The current timeout value is 15 seconds. This API does not end existing calls that have already been answered. Use delete call to end a call. |
| Invoke-MgSubscribeCommunicationCallToTone |
Subscribe to DTMF (dual-tone multi-frequency signaling) which allows you to be notified when the user presses keys on a 'dialpad'. |
| Invoke-MgUnmuteCommunicationCall |
Allow the application to unmute itself. This is a server unmute, meaning that the server will start sending audio packets for this participant to other participants again. For more information about how to handle unmute operations, see unmuteParticipantOperation. |
| Move-MgCommunicationCall |
Transfer an active peer-to-peer call or group call. A consultative transfer means that the transferor can inform the person they want to transfer the call to (the transferee), before the transfer is made. This is opposed to transfering the call directly. |
| New-MgCommunicationCall |
Create call enables your bot to create a new outgoing peer-to-peer or group call, or join an existing meeting. You need to register the calling bot and go through the list of permissions needed. This API supports the following PSTN scenarios: |
| New-MgCommunicationCallAudioRoutingGroup |
Create a new audioRoutingGroup. |
| New-MgCommunicationCallContentSharingSession |
Create new navigation property to contentSharingSessions for communications |
| New-MgCommunicationCallOperation |
Create new navigation property to operations for communications |
| New-MgCommunicationCallParticipant |
Create new navigation property to participants for communications |
| New-MgCommunicationCallRecordParticipantV2 |
Create new navigation property to participants_v2 for communications |
| New-MgCommunicationCallRecordSession |
Create new navigation property to sessions for communications |
| New-MgCommunicationOnlineMeeting |
Create new navigation property to onlineMeetings for communications |
| New-MgCommunicationOnlineMeetingAttendanceReport |
Create new navigation property to attendanceReports for communications |
| New-MgCommunicationOnlineMeetingAttendanceReportAttendanceRecord |
Create new navigation property to attendanceRecords for communications |
| New-MgCommunicationOnlineMeetingRecording |
Create new navigation property to recordings for communications |
| New-MgCommunicationOnlineMeetingTranscript |
Create new navigation property to transcripts for communications |
| New-MgCommunicationPresence |
Create new navigation property to presences for communications |
| New-MgUserOnlineMeeting |
Create new navigation property to onlineMeetings for users |
| New-MgUserOnlineMeetingAttendanceReport |
Create new navigation property to attendanceReports for users |
| New-MgUserOnlineMeetingAttendanceReportAttendanceRecord |
Create new navigation property to attendanceRecords for users |
| New-MgUserOnlineMeetingRecording |
Create new navigation property to recordings for users |
| New-MgUserOnlineMeetingTranscript |
Create new navigation property to transcripts for users |
| Remove-MgCommunicationCall |
Delete or hang up an active call. For group calls, this will only delete your call leg and the underlying group call will still continue. |
| Remove-MgCommunicationCallAudioRoutingGroup |
Delete the specified audioRoutingGroup. |
| Remove-MgCommunicationCallContentSharingSession |
Delete navigation property contentSharingSessions for communications |
| Remove-MgCommunicationCallOperation |
Delete navigation property operations for communications |
| Remove-MgCommunicationCallParticipant |
Delete a specific participant in a call. In some situations, it is appropriate for an application to remove a participant from an active call. This action can be done before or after the participant answers the call. When an active caller is removed, they are immediately dropped from the call with no pre- or post-removal notification. When an invited participant is removed, any outstanding add participant request is canceled. |
| Remove-MgCommunicationCallRecordOrganizerV2 |
Delete navigation property organizer_v2 for communications |
| Remove-MgCommunicationCallRecordParticipantV2 |
Delete navigation property participants_v2 for communications |
| Remove-MgCommunicationCallRecordSession |
Delete navigation property sessions for communications |
| Remove-MgCommunicationOnlineMeeting |
Delete navigation property onlineMeetings for communications |
| Remove-MgCommunicationOnlineMeetingAttendanceReport |
Delete navigation property attendanceReports for communications |
| Remove-MgCommunicationOnlineMeetingAttendanceReportAttendanceRecord |
Delete navigation property attendanceRecords for communications |
| Remove-MgCommunicationOnlineMeetingAttendeeReport |
The content stream of the attendee report of a Microsoft Teams live event. Read-only. |
| Remove-MgCommunicationOnlineMeetingRecording |
Delete navigation property recordings for communications |
| Remove-MgCommunicationOnlineMeetingRecordingContent |
The content of the recording. Read-only. |
| Remove-MgCommunicationOnlineMeetingTranscript |
Delete navigation property transcripts for communications |
| Remove-MgCommunicationOnlineMeetingTranscriptContent |
The content of the transcript. Read-only. |
| Remove-MgCommunicationOnlineMeetingTranscriptMetadataContent |
The time-aligned metadata of the utterances in the transcript. Read-only. |
| Remove-MgCommunicationPresence |
Delete navigation property presences for communications |
| Remove-MgUserOnlineMeeting |
Delete navigation property onlineMeetings for users |
| Remove-MgUserOnlineMeetingAttendanceReport |
Delete navigation property attendanceReports for users |
| Remove-MgUserOnlineMeetingAttendanceReportAttendanceRecord |
Delete navigation property attendanceRecords for users |
| Remove-MgUserOnlineMeetingAttendeeReport |
The content stream of the attendee report of a Microsoft Teams live event. Read-only. |
| Remove-MgUserOnlineMeetingRecording |
Delete navigation property recordings for users |
| Remove-MgUserOnlineMeetingRecordingContent |
The content of the recording. Read-only. |
| Remove-MgUserOnlineMeetingTranscript |
Delete navigation property transcripts for users |
| Remove-MgUserOnlineMeetingTranscriptContent |
The content of the transcript. Read-only. |
| Remove-MgUserOnlineMeetingTranscriptMetadataContent |
The time-aligned metadata of the utterances in the transcript. Read-only. |
| Remove-MgUserPresence |
Delete navigation property presence for users |
| Rename-MgCommunicationCallScreenSharingRole |
Allow applications to share screen content with the participants of a group call. |
| Send-MgCommunicationCallDtmfTone |
Invoke action sendDtmfTones |
| Send-MgCommunicationOnlineMeetingVirtualAppointmentReminderSm |
Send an SMS reminder to external attendees for a Teams virtual appointment. This feature requires Teams premium and attendees must have a valid United States phone number to receive SMS notifications. |
| Send-MgCommunicationOnlineMeetingVirtualAppointmentSm |
Send an SMS notification to external attendees when a Teams virtual appointment is confirmed, rescheduled, or canceled. This feature requires Teams premium. Attendees must have a valid United States phone number to receive these SMS notifications. |
| Send-MgUserOnlineMeetingVirtualAppointmentReminderSm |
Send an SMS reminder to external attendees for a Teams virtual appointment. This feature requires Teams premium and attendees must have a valid United States phone number to receive SMS notifications. |
| Send-MgUserOnlineMeetingVirtualAppointmentSm |
Send an SMS notification to external attendees when a Teams virtual appointment is confirmed, rescheduled, or canceled. This feature requires Teams premium. Attendees must have a valid United States phone number to receive these SMS notifications. |
| Set-MgCommunicationOnlineMeetingAttendeeReport |
The content stream of the attendee report of a Microsoft Teams live event. Read-only. |
| Set-MgCommunicationOnlineMeetingRecordingContent |
The content of the recording. Read-only. |
| Set-MgCommunicationOnlineMeetingTranscriptContent |
The content of the transcript. Read-only. |
| Set-MgCommunicationOnlineMeetingTranscriptMetadataContent |
The time-aligned metadata of the utterances in the transcript. Read-only. |
| Set-MgCommunicationPresence |
Set the state of a user's presence session as an application. For more information about presence sessions, states permutations, and timeouts, see Manage presence state using the Microsoft Graph API. |
| Set-MgCommunicationPresenceStatusMessage |
Set a presence status message for a user. An optional expiration date and time can be supplied. |
| Set-MgCommunicationPresenceUserPreferredPresence |
Set the preferred availability and activity status for a user. If the preferred presence of a user is set, the user's presence shows as the preferred status. Preferred presence takes effect only when at least one presence session exists for the user. Otherwise, the user's presence shows as Offline. A presence session is created as a result of a successful setPresence operation, or if the user is signed in on a Microsoft Teams client. For more details, see presence sessions and time-out and expiration. |
| Set-MgUserOnlineMeetingAttendeeReport |
The content stream of the attendee report of a Microsoft Teams live event. Read-only. |
| Set-MgUserOnlineMeetingRecordingContent |
The content of the recording. Read-only. |
| Set-MgUserOnlineMeetingTranscriptContent |
The content of the transcript. Read-only. |
| Set-MgUserOnlineMeetingTranscriptMetadataContent |
The time-aligned metadata of the utterances in the transcript. Read-only. |
| Set-MgUserPresence |
Set the state of a user's presence session as an application. For more information about presence sessions, states permutations, and timeouts, see Manage presence state using the Microsoft Graph API. |
| Set-MgUserPresenceStatusMessage |
Set a presence status message for a user. An optional expiration date and time can be supplied. |
| Set-MgUserPresenceUserPreferredPresence |
Set the preferred availability and activity status for a user. If the preferred presence of a user is set, the user's presence shows as the preferred status. Preferred presence takes effect only when at least one presence session exists for the user. Otherwise, the user's presence shows as Offline. A presence session is created as a result of a successful setPresence operation, or if the user is signed in on a Microsoft Teams client. For more details, see presence sessions and time-out and expiration. |
| Start-MgCommunicationCallParticipantHoldMusic |
Put a participant on hold and play music in the background. |
| Stop-MgCommunicationCallMediaProcessing |
Cancels processing for any in-progress media operations. Media operations refer to the IVR operations playPrompt and recordResponse, which are by default queued to process in order. The cancelMediaProcessing method cancels any operation that is in-process as well as operations that are queued. For example, this method can be used to clean up the IVR operation queue for a new media operation. However, it will not cancel a subscribeToTone operation because it operates independent of any operation queue. |
| Stop-MgCommunicationCallParticipantHoldMusic |
Reincorporate a participant previously put on hold to the call. |
| Update-MgCommunicationCallAudioRoutingGroup |
Modify sources and receivers of an audioRoutingGroup. |
| Update-MgCommunicationCallContentSharingSession |
Update the navigation property contentSharingSessions in communications |
| Update-MgCommunicationCallOperation |
Update the navigation property operations in communications |
| Update-MgCommunicationCallParticipant |
Update the navigation property participants in communications |
| Update-MgCommunicationCallRecordingStatus |
Update the application's recording status associated with a call. This requires the use of the Teams policy-based recording solution. |
| Update-MgCommunicationCallRecordOrganizerV2 |
Update the navigation property organizer_v2 in communications |
| Update-MgCommunicationCallRecordParticipantV2 |
Update the navigation property participants_v2 in communications |
| Update-MgCommunicationCallRecordSession |
Update the navigation property sessions in communications |
| Update-MgCommunicationOnlineMeeting |
Update the navigation property onlineMeetings in communications |
| Update-MgCommunicationOnlineMeetingAttendanceReport |
Update the navigation property attendanceReports in communications |
| Update-MgCommunicationOnlineMeetingAttendanceReportAttendanceRecord |
Update the navigation property attendanceRecords in communications |
| Update-MgCommunicationOnlineMeetingRecording |
Update the navigation property recordings in communications |
| Update-MgCommunicationOnlineMeetingTranscript |
Update the navigation property transcripts in communications |
| Update-MgCommunicationPresence |
Update the navigation property presences in communications |
| Update-MgUserOnlineMeeting |
Update the navigation property onlineMeetings in users |
| Update-MgUserOnlineMeetingAttendanceReport |
Update the navigation property attendanceReports in users |
| Update-MgUserOnlineMeetingAttendanceReportAttendanceRecord |
Update the navigation property attendanceRecords in users |
| Update-MgUserOnlineMeetingRecording |
Update the navigation property recordings in users |
| Update-MgUserOnlineMeetingTranscript |
Update the navigation property transcripts in users |
| Update-MgUserPresence |
Update the navigation property presence in users |