Invoke-MgRedirectCommunicationCall

Module:

Microsoft.Graph.CloudCommunications

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.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaRedirectCommunicationCall

Syntax

Invoke-MgRedirectCommunicationCall
      -CallId <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-CallbackUri <String>]
      [-Targets <IMicrosoftGraphInvitationParticipantInfo[]>]
      [-Timeout <Int32>]
      [-Headers <IDictionary>]
      [-PassThru]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgRedirectCommunicationCall
      -CallId <String>
      -BodyParameter <IPaths183Gi8UCommunicationsCallsCallIdMicrosoftGraphRedirectPostRequestbodyContentApplicationJsonSchema>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-PassThru]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgRedirectCommunicationCall
      -InputObject <ICloudCommunicationsIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-CallbackUri <String>]
      [-Targets <IMicrosoftGraphInvitationParticipantInfo[]>]
      [-Timeout <Int32>]
      [-Headers <IDictionary>]
      [-PassThru]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgRedirectCommunicationCall
      -InputObject <ICloudCommunicationsIdentity>
      -BodyParameter <IPaths183Gi8UCommunicationsCallsCallIdMicrosoftGraphRedirectPostRequestbodyContentApplicationJsonSchema>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-PassThru]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

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.

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.CloudCommunications

$params = @{
	targets = @(
		@{
			"@odata.type" = "#microsoft.graph.invitationParticipantInfo"
			identity = @{
				"@odata.type" = "#microsoft.graph.identitySet"
				phone = @{
					"@odata.type" = "#microsoft.graph.identity"
					id = "+12345678901"
				}
			}
		}
	)
	callbackUri = "https://bot.contoso.com/api/calls/24701998-1a73-4d42-8085-bf46ed0ae039"
}

Invoke-MgRedirectCommunicationCall -CallId $callId -BodyParameter $params

This example shows how to use the Invoke-MgRedirectCommunicationCall 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:	IPaths183Gi8UCommunicationsCallsCallIdMicrosoftGraphRedirectPostRequestbodyContentApplicationJsonSchema
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-CallbackUri

.

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

-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

-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

-PassThru

Returns true when the command succeeds

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

-ResponseHeadersVariable

Optional Response Headers Variable.

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

-Targets

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

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

-Timeout

.

Type:	Int32
Position:	Named
Default value:	0
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.IPaths183Gi8UCommunicationsCallsCallIdMicrosoftGraphRedirectPostRequestbodyContentApplicationJsonSchema

System.Collections.IDictionary

Outputs

System.Boolean

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

• [(Any) <Object>]: This indicates any property can be added to this object.
• [CallbackUri <String>]:
• [Targets <IMicrosoftGraphInvitationParticipantInfo- []>]:
  • [Hidden <Boolean?>]: Optional. Whether to hide the participant from the roster.
  • [Identity <IMicrosoftGraphIdentitySet>]: identitySet
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [Application <IMicrosoftGraphIdentity>]: identity
      • [(Any) <Object>]: This indicates any property can be added to this object.
      • [DisplayName <String>]: The display name of the identity. The display name might not always be available or up to date. For example, if a user changes their display name, the API might show the new value in a future response, but the items associated with the user won't show up as having changed when using delta.
      • [Id <String>]: Unique identifier for the identity.
    • [Device <IMicrosoftGraphIdentity>]: identity
    • [User <IMicrosoftGraphIdentity>]: identity
  • [ParticipantId <String>]: Optional. The ID of the target participant.
  • [RemoveFromDefaultAudioRoutingGroup <Boolean?>]: Optional. Whether to remove them from the main mixer.
  • [ReplacesCallId <String>]: Optional. The call which the target identity is currently a part of. For peer-to-peer case, the call will be dropped once the participant is added successfully.
• [Timeout <Int32?>]:

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

TARGETS <IMicrosoftGraphInvitationParticipantInfo- []>: .

• [Hidden <Boolean?>]: Optional. Whether to hide the participant from the roster.
• [Identity <IMicrosoftGraphIdentitySet>]: identitySet
  • [(Any) <Object>]: This indicates any property can be added to this object.
  • [Application <IMicrosoftGraphIdentity>]: identity
    • [(Any) <Object>]: This indicates any property can be added to this object.
    • [DisplayName <String>]: The display name of the identity. The display name might not always be available or up to date. For example, if a user changes their display name, the API might show the new value in a future response, but the items associated with the user won't show up as having changed when using delta.
    • [Id <String>]: Unique identifier for the identity.
  • [Device <IMicrosoftGraphIdentity>]: identity
  • [User <IMicrosoftGraphIdentity>]: identity
• [ParticipantId <String>]: Optional. The ID of the target participant.
• [RemoveFromDefaultAudioRoutingGroup <Boolean?>]: Optional. Whether to remove them from the main mixer.
• [ReplacesCallId <String>]: Optional. The call which the target identity is currently a part of. For peer-to-peer case, the call will be dropped once the participant is added successfully.

Related Links

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