Invoke-MgBetaRecordCommunicationCallResponse

Module:

Microsoft.Graph.Beta.CloudCommunications

Record a short audio response from the caller. A bot can use this API to capture a voice response from a caller after they're prompted for a response. For more information about how to handle operations, see commsOperation. This action isn't intended to record the entire call. The maximum length of recording is 2 minutes.The Cloud Communications Platform doesn't save the recording permanently and discards it shortly after the call ends. The bot must download the recording promptly after the recording operation finishes by using the recordingLocation value provided in the completed notification.

Note

To view the v1.0 release of this cmdlet, view Invoke-MgRecordCommunicationCallResponse

Syntax

Invoke-MgBetaRecordCommunicationCallResponse
      -CallId <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-BargeInAllowed]
      [-ClientContext <String>]
      [-InitialSilenceTimeoutInSeconds <Int32>]
      [-MaxRecordDurationInSeconds <Int32>]
      [-MaxSilenceTimeoutInSeconds <Int32>]
      [-PlayBeep]
      [-Prompts <IMicrosoftGraphPrompt[]>]
      [-StopTones <String[]>]
      [-StreamWhileRecording]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgBetaRecordCommunicationCallResponse
      -CallId <String>
      -BodyParameter <IPaths14Wb7KqCommunicationsCallsCallIdMicrosoftGraphRecordresponsePostRequestbodyContentApplicationJsonSchema>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgBetaRecordCommunicationCallResponse
      -InputObject <ICloudCommunicationsIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-BargeInAllowed]
      [-ClientContext <String>]
      [-InitialSilenceTimeoutInSeconds <Int32>]
      [-MaxRecordDurationInSeconds <Int32>]
      [-MaxSilenceTimeoutInSeconds <Int32>]
      [-PlayBeep]
      [-Prompts <IMicrosoftGraphPrompt[]>]
      [-StopTones <String[]>]
      [-StreamWhileRecording]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgBetaRecordCommunicationCallResponse
      -InputObject <ICloudCommunicationsIdentity>
      -BodyParameter <IPaths14Wb7KqCommunicationsCallsCallIdMicrosoftGraphRecordresponsePostRequestbodyContentApplicationJsonSchema>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Record a short audio response from the caller. A bot can use this API to capture a voice response from a caller after they're prompted for a response. For more information about how to handle operations, see commsOperation. This action isn't intended to record the entire call. The maximum length of recording is 2 minutes.The Cloud Communications Platform doesn't save the recording permanently and discards it shortly after the call ends. The bot must download the recording promptly after the recording operation finishes by using the recordingLocation value provided in the completed notification.

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Beta.CloudCommunications

$params = @{
	bargeInAllowed = $true
	clientContext = "d45324c1-fcb5-430a-902c-f20af696537c"
	prompts = @(
		@{
			"@odata.type" = "#microsoft.graph.mediaPrompt"
		}
	)
	maxRecordDurationInSeconds = 10
	initialSilenceTimeoutInSeconds = 5
	maxSilenceTimeoutInSeconds = 2
	playBeep = $true
	stopTones = @(
		"#"
		"1"
		"*"
	)
}

Invoke-MgBetaRecordCommunicationCallResponse -CallId $callId -BodyParameter $params

This example shows how to use the Invoke-MgBetaRecordCommunicationCallResponse Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

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

-BargeInAllowed

.

Type:	SwitchParameter
Position:	Named
Default value:	False
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:	IPaths14Wb7KqCommunicationsCallsCallIdMicrosoftGraphRecordresponsePostRequestbodyContentApplicationJsonSchema
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

-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

-InitialSilenceTimeoutInSeconds

.

Type:	Int32
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
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

-MaxRecordDurationInSeconds

.

Type:	Int32
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MaxSilenceTimeoutInSeconds

.

Type:	Int32
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PlayBeep

.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
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

-Prompts

.

Type:	IMicrosoftGraphPrompt[]
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

-StopTones

.

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

-StreamWhileRecording

.

Type:	SwitchParameter
Position:	Named
Default value:	False
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.Beta.PowerShell.Models.ICloudCommunicationsIdentity

Microsoft.Graph.Beta.PowerShell.Models.IPaths14Wb7KqCommunicationsCallsCallIdMicrosoftGraphRecordresponsePostRequestbodyContentApplicationJsonSchema

System.Collections.IDictionary

Outputs

Microsoft.Graph.Beta.PowerShell.Models.IMicrosoftGraphRecordOperation

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 <IPaths14Wb7KqCommunicationsCallsCallIdMicrosoftGraphRecordresponsePostRequestbodyContentApplicationJsonSchema>: .

• [(Any) <Object>]: This indicates any property can be added to this object.
• [BargeInAllowed <Boolean?>]:
• [ClientContext <String>]:
• [InitialSilenceTimeoutInSeconds <Int32?>]:
• [MaxRecordDurationInSeconds <Int32?>]:
• [MaxSilenceTimeoutInSeconds <Int32?>]:
• [PlayBeep <Boolean?>]:
• [Prompts <IMicrosoftGraphPrompt- []>]:
• [StopTones <String- []>]:
• [StreamWhileRecording <Boolean?>]:

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
• [FromDateTime <DateTime?>]: Usage: fromDateTime={fromDateTime}
• [JoinWebUrl <String>]: Alternate key of onlineMeeting
• [MeetingAttendanceReportId <String>]: The unique identifier of meetingAttendanceReport
• [MeetingRegistrantBaseId <String>]: The unique identifier of meetingRegistrantBase
• [MeetingRegistrationQuestionId <String>]: The unique identifier of meetingRegistrationQuestion
• [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
• [ToDateTime <DateTime?>]: Usage: toDateTime={toDateTime}
• [UserId <String>]: The unique identifier of user

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.beta.cloudcommunications/invoke-mgbetarecordcommunicationcallresponse
• https://learn.microsoft.com/graph/api/call-record?view=graph-rest-1.0