Start-MgCommunicationCallParticipantHoldMusic

Module:

Microsoft.Graph.CloudCommunications

Put a participant on hold and play music in the background.

Note

To view the beta release of this cmdlet, view Start-MgBetaCommunicationCallParticipantHoldMusic

Syntax

Start-MgCommunicationCallParticipantHoldMusic
     -CallId <String>
     -ParticipantId <String>
     [-ResponseHeadersVariable <String>]
     [-AdditionalProperties <Hashtable>]
     [-ClientContext <String>]
     [-CustomPrompt <Hashtable>]
     [-Headers <IDictionary>]
     [-ProgressAction <ActionPreference>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-MgCommunicationCallParticipantHoldMusic
     -CallId <String>
     -ParticipantId <String>
     -BodyParameter <IPathsKtcw9WCommunicationsCallsCallIdParticipantsParticipantIdMicrosoftGraphStartholdmusicPostRequestbodyContentApplicationJsonSchema>
     [-ResponseHeadersVariable <String>]
     [-Headers <IDictionary>]
     [-ProgressAction <ActionPreference>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-MgCommunicationCallParticipantHoldMusic
     -InputObject <ICloudCommunicationsIdentity>
     [-ResponseHeadersVariable <String>]
     [-AdditionalProperties <Hashtable>]
     [-ClientContext <String>]
     [-CustomPrompt <Hashtable>]
     [-Headers <IDictionary>]
     [-ProgressAction <ActionPreference>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Start-MgCommunicationCallParticipantHoldMusic
     -InputObject <ICloudCommunicationsIdentity>
     -BodyParameter <IPathsKtcw9WCommunicationsCallsCallIdParticipantsParticipantIdMicrosoftGraphStartholdmusicPostRequestbodyContentApplicationJsonSchema>
     [-ResponseHeadersVariable <String>]
     [-Headers <IDictionary>]
     [-ProgressAction <ActionPreference>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

Put a participant on hold and play music in the background.

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.CloudCommunications

$params = @{
	customPrompt = @{
		"@odata.type" = "#microsoft.graph.mediaPrompt"
		mediaInfo = @{
			"@odata.type" = "#microsoft.graph.mediaInfo"
			uri = "https://bot.contoso.com/onHold.wav"
		}
	}
	clientContext = "d45324c1-fcb5-430a-902c-f20af696537c"
}

Start-MgCommunicationCallParticipantHoldMusic -CallId $callId -ParticipantId $participantId -BodyParameter $params

This example shows how to use the Start-MgCommunicationCallParticipantHoldMusic Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BodyParameter

. To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Type:	IPathsKtcw9WCommunicationsCallsCallIdParticipantsParticipantIdMicrosoftGraphStartholdmusicPostRequestbodyContentApplicationJsonSchema
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-CallId

The unique identifier of call

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ClientContext

.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CustomPrompt

prompt

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Headers

Optional headers that will be added to the request.

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	ICloudCommunicationsIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ParticipantId

The unique identifier of participant

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:	String
Aliases:	RHV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Graph.PowerShell.Models.ICloudCommunicationsIdentity

Microsoft.Graph.PowerShell.Models.IPathsKtcw9WCommunicationsCallsCallIdParticipantsParticipantIdMicrosoftGraphStartholdmusicPostRequestbodyContentApplicationJsonSchema

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphStartHoldMusicOperation

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BODYPARAMETER <IPathsKtcw9WCommunicationsCallsCallIdParticipantsParticipantIdMicrosoftGraphStartholdmusicPostRequestbodyContentApplicationJsonSchema>: .

• [(Any) <Object>]: This indicates any property can be added to this object.
• [ClientContext <String>]:
• [CustomPrompt <IMicrosoftGraphPrompt>]: prompt
  • [(Any) <Object>]: This indicates any property can be added to this object.

INPUTOBJECT <ICloudCommunicationsIdentity>: Identity Parameter

• [AttendanceRecordId <String>]: The unique identifier of attendanceRecord
• [AudioRoutingGroupId <String>]: The unique identifier of audioRoutingGroup
• [CallId <String>]: The unique identifier of call
• [CallRecordId <String>]: The unique identifier of callRecord
• [CallRecordingId <String>]: The unique identifier of callRecording
• [CallTranscriptId <String>]: The unique identifier of callTranscript
• [CommsOperationId <String>]: The unique identifier of commsOperation
• [ContentSharingSessionId <String>]: The unique identifier of contentSharingSession
• [MeetingAttendanceReportId <String>]: The unique identifier of meetingAttendanceReport
• [OnlineMeetingId <String>]: The unique identifier of onlineMeeting
• [ParticipantId <String>]: The unique identifier of participant
• [PresenceId <String>]: The unique identifier of presence
• [SessionId <String>]: The unique identifier of session
• [UserId <String>]: The unique identifier of user

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.cloudcommunications/start-mgcommunicationcallparticipantholdmusic
• https://learn.microsoft.com/graph/api/participant-startholdmusic?view=graph-rest-1.0