Share via

New-MgCommunicationCall

Module:
Microsoft.Graph.CloudCommunications Module

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:

Syntax

CreateExpanded (Default) 

New-MgCommunicationCall
    [-ResponseHeadersVariable <string>]
    [-AdditionalProperties <hashtable>]
    [-AudioRoutingGroups <IMicrosoftGraphAudioRoutingGroup[]>]
    [-CallChainId <string>]
    [-CallOptions <IMicrosoftGraphCallOptions>]
    [-CallRoutes <IMicrosoftGraphCallRoute[]>]
    [-CallbackUri <string>]
    [-ChatInfo <IMicrosoftGraphChatInfo>]
    [-ContentSharingSessions <IMicrosoftGraphContentSharingSession[]>]
    [-Direction <string>]
    [-Id <string>]
    [-IncomingContext <IMicrosoftGraphIncomingContext>]
    [-MediaConfig <hashtable>]
    [-MediaState <IMicrosoftGraphCallMediaState>]
    [-MeetingInfo <hashtable>]
    [-MyParticipantId <string>]
    [-Operations <IMicrosoftGraphCommsOperation[]>]
    [-Participants <IMicrosoftGraphParticipant[]>]
    [-RequestedModalities <string[]>]
    [-ResultInfo <IMicrosoftGraphResultInfo>]
    [-Source <IMicrosoftGraphParticipantInfo>]
    [-State <string>]
    [-Subject <string>]
    [-Targets <IMicrosoftGraphInvitationParticipantInfo[]>]
    [-TenantId <string>]
    [-ToneInfo <IMicrosoftGraphToneInfo>]
    [-Transcription <IMicrosoftGraphCallTranscriptionInfo>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Create 

New-MgCommunicationCall
    -BodyParameter <IMicrosoftGraphCall>
    [-ResponseHeadersVariable <string>]
    [-Break]
    [-Headers <IDictionary>]
    [-HttpPipelineAppend <SendAsyncStep[]>]
    [-HttpPipelinePrepend <SendAsyncStep[]>]
    [-Proxy <uri>]
    [-ProxyCredential <pscredential>]
    [-ProxyUseDefaultCredentials]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

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:

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Not supported
Delegated (personal Microsoft account) Not supported
Application Calls.JoinGroupCalls.Chat, Calls.JoinGroupCallAsGuest.All, Calls.JoinGroupCall.All, Calls.InitiateGroupCall.All, Calls.Initiate.All,

Examples

Example 1: Create peer-to-peer VoIP call with service hosted media


Import-Module Microsoft.Graph.CloudCommunications

$params = @{
	"@odata.type" = "#microsoft.graph.call"
	callbackUri = "https://bot.contoso.com/callback"
	targets = @(
		@{
			"@odata.type" = "#microsoft.graph.invitationParticipantInfo"
			identity = @{
				"@odata.type" = "#microsoft.graph.identitySet"
				user = @{
					"@odata.type" = "#microsoft.graph.identity"
					displayName = "John"
					id = "112f7296-5fa4-42ca-bae8-6a692b15d4b8"
				}
			}
		}
	)
	requestedModalities = @(
		"audio"
	)
	callOptions = @{
		"@odata.type" = "#microsoft.graph.outgoingCallOptions"
		isContentSharingNotificationEnabled = $true
	}
	mediaConfig = @{
		"@odata.type" = "#microsoft.graph.serviceHostedMediaConfig"
	}
}

New-MgCommunicationCall -BodyParameter $params

This example will create peer-to-peer voip call with service hosted media

Example 2: Create peer-to-peer VoIP call with application hosted media


Import-Module Microsoft.Graph.CloudCommunications

$params = @{
	"@odata.type" = "#microsoft.graph.call"
	callbackUri = "https://bot.contoso.com/callback"
	source = @{
		"@odata.type" = "#microsoft.graph.participantInfo"
		identity = @{
			"@odata.type" = "#microsoft.graph.identitySet"
			application = @{
				"@odata.type" = "#microsoft.graph.identity"
				displayName = "Calling Bot"
				id = "2891555a-92ff-42e6-80fa-6e1300c6b5c6"
			}
		}
		region = $null
		languageId = $null
	}
	targets = @(
		@{
			"@odata.type" = "#microsoft.graph.invitationParticipantInfo"
			identity = @{
				"@odata.type" = "#microsoft.graph.identitySet"
				user = @{
					"@odata.type" = "#microsoft.graph.identity"
					displayName = "John"
					id = "112f7296-5fa4-42ca-bae8-6a692b15d4b8"
				}
			}
		}
	)
	requestedModalities = @(
		"audio"
	)
	mediaConfig = @{
		"@odata.type" = "#microsoft.graph.appHostedMediaConfig"
		blob = "<Media Session Configuration>"
	}
}

New-MgCommunicationCall -BodyParameter $params

This example will create peer-to-peer voip call with application hosted media

Example 3: Create a group call with service hosted media


Import-Module Microsoft.Graph.CloudCommunications

$params = @{
	"@odata.type" = "#microsoft.graph.call"
	direction = "outgoing"
	subject = "Create a group call with service hosted media"
	callbackUri = "https://bot.contoso.com/callback"
	source = @{
		"@odata.type" = "#microsoft.graph.participantInfo"
		identity = @{
			"@odata.type" = "#microsoft.graph.identitySet"
			application = @{
				"@odata.type" = "#microsoft.graph.identity"
				displayName = "TestBot"
				id = "dd3885da-f9ab-486b-bfae-85de3d445555"
			}
		}
	}
	targets = @(
		@{
			"@odata.type" = "#microsoft.graph.invitationParticipantInfo"
			identity = @{
				"@odata.type" = "#microsoft.graph.identitySet"
				user = @{
					"@odata.type" = "#microsoft.graph.identity"
					displayName = "user1"
					id = "98da8a1a-1b87-452c-a713-65d3f10b5555"
				}
			}
		}
		@{
			"@odata.type" = "#microsoft.graph.invitationParticipantInfo"
			identity = @{
				"@odata.type" = "#microsoft.graph.identitySet"
				user = @{
					"@odata.type" = "#microsoft.graph.identity"
					displayName = "user2"
					id = "bf5aae9a-d11d-47a8-93b1-782504c95555"
				}
			}
		}
	)
	requestedModalities = @(
		"audio"
	)
	mediaConfig = @{
		"@odata.type" = "#microsoft.graph.serviceHostedMediaConfig"
		removeFromDefaultAudioGroup = $false
	}
}

New-MgCommunicationCall -BodyParameter $params

This example will create a group call with service hosted media

Example 4: Create a group call with application hosted media


Import-Module Microsoft.Graph.CloudCommunications

$params = @{
	"@odata.type" = "#microsoft.graph.call"
	direction = "outgoing"
	subject = "Create a group call with application hosted media"
	callbackUri = "https://bot.contoso.com/callback"
	source = @{
		"@odata.type" = "#microsoft.graph.participantInfo"
		identity = @{
			"@odata.type" = "#microsoft.graph.identitySet"
			application = @{
				"@odata.type" = "#microsoft.graph.identity"
				displayName = "TestBot"
				id = "dd3885da-f9ab-486b-bfae-85de3d445555"
			}
		}
	}
	targets = @(
		@{
			"@odata.type" = "#microsoft.graph.invitationParticipantInfo"
			identity = @{
				"@odata.type" = "#microsoft.graph.identitySet"
				user = @{
					"@odata.type" = "#microsoft.graph.identity"
					displayName = "user1"
					id = "98da8a1a-1b87-452c-a713-65d3f10b5555"
				}
			}
		}
		@{
			"@odata.type" = "#microsoft.graph.invitationParticipantInfo"
			identity = @{
				"@odata.type" = "#microsoft.graph.identitySet"
				user = @{
					"@odata.type" = "#microsoft.graph.identity"
					displayName = "user2"
					id = "bf5aae9a-d11d-47a8-93b1-782504c95555"
				}
			}
		}
	)
	requestedModalities = @(
		"audio"
	)
	mediaConfig = @{
		"@odata.type" = "#microsoft.graph.appHostedMediaConfig"
		removeFromDefaultAudioGroup = $false
	}
}

New-MgCommunicationCall -BodyParameter $params

This example will create a group call with application hosted media

Example 5: Join scheduled meeting with service hosted media


Import-Module Microsoft.Graph.CloudCommunications

$params = @{
	"@odata.type" = "#microsoft.graph.call"
	callbackUri = "https://bot.contoso.com/callback"
	requestedModalities = @(
		"audio"
	)
	mediaConfig = @{
		"@odata.type" = "#microsoft.graph.serviceHostedMediaConfig"
		preFetchMedia = @(
		)
	}
	chatInfo = @{
		"@odata.type" = "#microsoft.graph.chatInfo"
		threadId = "19:meeting_Win6Ydo4wsMijFjZS00ZGVjLTk5MGUtOTRjNWY2NmNkYTFm@thread.v2"
		messageId = "0"
	}
	meetingInfo = @{
		"@odata.type" = "#microsoft.graph.organizerMeetingInfo"
		organizer = @{
			"@odata.type" = "#microsoft.graph.identitySet"
			user = @{
				"@odata.type" = "#microsoft.graph.identity"
				id = "5810cede-f3cc-42eb-b2c1-e9bd5d53ec96"
				displayName = "Bob"
				tenantId = "86dc81db-c112-4228-9222-63f3esaa1edb"
			}
		}
		allowConversationWithoutHost = $true
	}
	tenantId = "86dc81db-c112-4228-9222-63f3esaa1edb"
}

New-MgCommunicationCall -BodyParameter $params

This example will join scheduled meeting with service hosted media

Example 6: Join scheduled meeting with application hosted media


Import-Module Microsoft.Graph.CloudCommunications

$params = @{
	"@odata.type" = "#microsoft.graph.call"
	direction = "outgoing"
	callbackUri = "https://bot.contoso.com/callback"
	requestedModalities = @(
		"audio"
	)
	mediaConfig = @{
		"@odata.type" = "#microsoft.graph.appHostedMediaConfig"
	}
	chatInfo = @{
		"@odata.type" = "#microsoft.graph.chatInfo"
		threadId = "19:meeting_Win6Ydo4wsMijFjZS00ZGVjLTk5MGUtOTRjNWY2NmNkYTFm@thread.v2"
		messageId = "0"
	}
	meetingInfo = @{
		"@odata.type" = "#microsoft.graph.organizerMeetingInfo"
		organizer = @{
			"@odata.type" = "#microsoft.graph.identitySet"
			user = @{
				"@odata.type" = "#microsoft.graph.identity"
				id = "5810cede-f3cc-42eb-b2c1-e9bd5d53ec96"
				tenantId = "aa67bd4c-8475-432d-bd41-39f255720e0a"
				displayName = "Bob"
			}
		}
		allowConversationWithoutHost = $true
	}
	tenantId = "aa67bd4c-8475-432d-bd41-39f255720e0a"
}

New-MgCommunicationCall -BodyParameter $params

This example will join scheduled meeting with application hosted media

Example 7: Join a scheduled meeting with joinMeetingId and passcode


Import-Module Microsoft.Graph.CloudCommunications

$params = @{
	"@odata.type" = "#microsoft.graph.call"
	callbackUri = "https://bot.contoso.com/callback"
	requestedModalities = @(
		"audio"
	)
	mediaConfig = @{
		"@odata.type" = "#microsoft.graph.serviceHostedMediaConfig"
		preFetchMedia = @(
		)
	}
	meetingInfo = @{
		"@odata.type" = "#microsoft.graph.joinMeetingIdMeetingInfo"
		joinMeetingId = "1234567"
		passcode = "psw123"
	}
	tenantId = "86dc81db-c112-4228-9222-63f3esaa1edb"
}

New-MgCommunicationCall -BodyParameter $params

This example will join a scheduled meeting with joinmeetingid and passcode

Example 8: Join a scheduled meeting with joinMeetingId


Import-Module Microsoft.Graph.CloudCommunications

$params = @{
	"@odata.type" = "#microsoft.graph.call"
	callbackUri = "https://bot.contoso.com/callback"
	requestedModalities = @(
		"audio"
	)
	mediaConfig = @{
		"@odata.type" = "#microsoft.graph.serviceHostedMediaConfig"
		preFetchMedia = @(
		)
	}
	meetingInfo = @{
		"@odata.type" = "#microsoft.graph.joinMeetingIdMeetingInfo"
		joinMeetingId = "1234567"
		passcode = $null
	}
	tenantId = "86dc81db-c112-4228-9222-63f3esaa1edb"
}

New-MgCommunicationCall -BodyParameter $params

This example will join a scheduled meeting with joinmeetingid

Example 9: Create peer-to-peer PSTN call with service hosted media


Import-Module Microsoft.Graph.CloudCommunications

$params = @{
	"@odata.type" = "#microsoft.graph.call"
	callbackUri = "https://bot.contoso.com/callback"
	source = @{
		"@odata.type" = "#microsoft.graph.participantInfo"
		identity = @{
			"@odata.type" = "#microsoft.graph.identitySet"
			applicationInstance = @{
				"@odata.type" = "#microsoft.graph.identity"
				displayName = "Calling Bot"
				id = "3d913abb-aec0-4964-8fa6-3c6850c4f278"
			}
		}
		countryCode = $null
		endpointType = $null
		region = $null
		languageId = $null
	}
	targets = @(
		@{
			"@odata.type" = "#microsoft.graph.invitationParticipantInfo"
			identity = @{
				"@odata.type" = "#microsoft.graph.identitySet"
				phone = @{
					"@odata.type" = "#microsoft.graph.identity"
					id = "+12345678901"
				}
			}
		}
	)
	requestedModalities = @(
		"audio"
	)
	mediaConfig = @{
		"@odata.type" = "#microsoft.graph.serviceHostedMediaConfig"
	}
	tenantId = "aa67bd4c-8475-432d-bd41-39f255720e0a"
}

New-MgCommunicationCall -BodyParameter $params

This example will create peer-to-peer pstn call with service hosted media

Example 100: Create peer-to-peer PSTN call with application hosted media


Import-Module Microsoft.Graph.CloudCommunications

$params = @{
	"@odata.type" = "#microsoft.graph.call"
	callbackUri = "https://bot.contoso.com/callback"
	source = @{
		"@odata.type" = "#microsoft.graph.participantInfo"
		identity = @{
			"@odata.type" = "#microsoft.graph.identitySet"
			applicationInstance = @{
				"@odata.type" = "#microsoft.graph.identity"
				displayName = "Calling Bot"
				id = "3d913abb-aec0-4964-8fa6-3c6850c4f278"
			}
		}
		countryCode = $null
		endpointType = $null
		region = $null
		languageId = $null
	}
	targets = @(
		@{
			"@odata.type" = "#microsoft.graph.invitationParticipantInfo"
			identity = @{
				"@odata.type" = "#microsoft.graph.identitySet"
				phone = @{
					"@odata.type" = "#microsoft.graph.identity"
					id = "+12345678901"
				}
			}
		}
	)
	requestedModalities = @(
		"audio"
	)
	mediaConfig = @{
		"@odata.type" = "#microsoft.graph.appHostedMediaConfig"
		blob = "<Media Session Configuration>"
	}
	tenantId = "aa67bd4c-8475-432d-bd41-39f255720e0a"
}

New-MgCommunicationCall -BodyParameter $params

This example will create peer-to-peer pstn call with application hosted media

Parameters

-AdditionalProperties

Additional Parameters

Parameter properties

Type:System.Collections.Hashtable
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AudioRoutingGroups

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

Parameter properties

Type:

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphAudioRoutingGroup[]

Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-BodyParameter

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

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphCall
Supports wildcards:False
DontShow:False

Parameter sets

Create
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Break

Wait for .NET debugger to attach

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CallbackUri

The callback URL on which callbacks are delivered. Must be an HTTPS URL.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CallChainId

A unique identifier for all the participant calls in a conference or a unique identifier for two participant calls in a P2P call. This identifier must be copied over from Microsoft.Graph.Call.CallChainId.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CallOptions

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

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphCallOptions
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CallRoutes

The routing information on how the call was retargeted. Read-only. To construct, see NOTES section for CALLROUTES properties and create a hash table.

Parameter properties

Type:

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphCallRoute[]

Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ChatInfo

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

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphChatInfo
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ContentSharingSessions

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

Parameter properties

Type:

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphContentSharingSession[]

Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Direction

callDirection

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Headers

Optional headers that will be added to the request.

Parameter properties

Type:System.Collections.IDictionary
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelineAppend

SendAsync Pipeline Steps to be appended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HttpPipelinePrepend

SendAsync Pipeline Steps to be prepended to the front of the pipeline

Parameter properties

Type:

Microsoft.Graph.PowerShell.Runtime.SendAsyncStep[]

Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Id

The unique identifier for an entity. Read-only.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IncomingContext

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

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphIncomingContext
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MediaConfig

mediaConfig

Parameter properties

Type:System.Collections.Hashtable
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MediaState

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

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphCallMediaState
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MeetingInfo

meetingInfo

Parameter properties

Type:System.Collections.Hashtable
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MyParticipantId

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:

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Not supported
Delegated (personal Microsoft account) Not supported
Application Calls.JoinGroupCalls.Chat, Calls.JoinGroupCallAsGuest.All, Calls.JoinGroupCall.All, Calls.InitiateGroupCall.All, Calls.Initiate.All,

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Operations

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

Parameter properties

Type:

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphCommsOperation[]

Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Participants

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

Parameter properties

Type:

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphParticipant[]

Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Proxy

The URI for the proxy server to use

Parameter properties

Type:System.Uri
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyCredential

Credentials for a proxy server to use for the remote call

Parameter properties

Type:System.Management.Automation.PSCredential
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProxyUseDefaultCredentials

Use the default credentials for the proxy

Parameter properties

Type:System.Management.Automation.SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RequestedModalities

The list of requested modalities. Possible values are: unknown, audio, video, videoBasedScreenSharing, data.

Parameter properties

Type:

System.String[]

Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResponseHeadersVariable

Optional Response Headers Variable.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False
Aliases:RHV

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResultInfo

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

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphResultInfo
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Source

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

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphParticipantInfo
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-State

callState

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Subject

The subject of the conversation.

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Targets

The targets of the call. Required information for creating peer to peer call. To construct, see NOTES section for TARGETS properties and create a hash table.

Parameter properties

Type:

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphInvitationParticipantInfo[]

Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TenantId

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:

Permissions

Permission type Permissions (from least to most privileged)
Delegated (work or school account) Not supported
Delegated (personal Microsoft account) Not supported
Application Calls.JoinGroupCalls.Chat, Calls.JoinGroupCallAsGuest.All, Calls.JoinGroupCall.All, Calls.InitiateGroupCall.All, Calls.Initiate.All,

Parameter properties

Type:System.String
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ToneInfo

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

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphToneInfo
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Transcription

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

Parameter properties

Type:Microsoft.Graph.PowerShell.Models.IMicrosoftGraphCallTranscriptionInfo
Supports wildcards:False
DontShow:False

Parameter sets

CreateExpanded
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Runs the command in a mode that only reports what would happen without performing the actions.

Parameter properties

Type:System.Management.Automation.SwitchParameter
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphCall

{{ Fill in the Description }}

System.Collections.IDictionary

{{ Fill in the Description }}

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphCall

{{ Fill in the Description }}

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.

AUDIOROUTINGGROUPS <IMicrosoftGraphAudioRoutingGroup[]>: . [Id <String>]: The unique identifier for an entity. Read-only. [Receivers <String[]>]: List of receiving participant ids. [RoutingMode <String>]: routingMode [Sources <String[]>]: List of source participant ids.

BODYPARAMETER <IMicrosoftGraphCall>: call [(Any) <Object>]: This indicates any property can be added to this object. [Id <String>]: The unique identifier for an entity. Read-only. [AudioRoutingGroups <IMicrosoftGraphAudioRoutingGroup[]>]: [Id <String>]: The unique identifier for an entity. Read-only. [Receivers <String[]>]: List of receiving participant ids. [RoutingMode <String>]: routingMode [Sources <String[]>]: List of source participant ids. [CallChainId <String>]: A unique identifier for all the participant calls in a conference or a unique identifier for two participant calls in a P2P call. This identifier must be copied over from Microsoft.Graph.Call.CallChainId. [CallOptions <IMicrosoftGraphCallOptions>]: callOptions [(Any) <Object>]: This indicates any property can be added to this object. [HideBotAfterEscalation <Boolean?>]: Indicates whether to hide the app after the call is escalated. [IsContentSharingNotificationEnabled <Boolean?>]: Indicates whether content sharing notifications should be enabled for the call. [IsDeltaRosterEnabled <Boolean?>]: Indicates whether delta roster is enabled for the call. [IsInteractiveRosterEnabled <Boolean?>]: Indicates whether delta roster filtering by participant interactivity is enabled. [CallRoutes <IMicrosoftGraphCallRoute[]>]: The routing information on how the call was retargeted. Read-only. [Final <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.For drive items, 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 don't show up as changed when using delta. [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review. [Device <IMicrosoftGraphIdentity>]: identity [User <IMicrosoftGraphIdentity>]: identity [Original <IMicrosoftGraphIdentitySet>]: identitySet [RoutingType <String>]: routingType [CallbackUri <String>]: The callback URL on which callbacks are delivered. Must be an HTTPS URL. [ChatInfo <IMicrosoftGraphChatInfo>]: chatInfo [(Any) <Object>]: This indicates any property can be added to this object. [MessageId <String>]: The unique identifier of a message in a Microsoft Teams channel. [ReplyChainMessageId <String>]: The ID of the reply message. [ThreadId <String>]: The unique identifier for a thread in Microsoft Teams. [ContentSharingSessions <IMicrosoftGraphContentSharingSession[]>]: [Id <String>]: The unique identifier for an entity. Read-only. [Direction <String>]: callDirection [IncomingContext <IMicrosoftGraphIncomingContext>]: incomingContext [(Any) <Object>]: This indicates any property can be added to this object. [ObservedParticipantId <String>]: The ID of the participant that is under observation. Read-only. [OnBehalfOf <IMicrosoftGraphIdentitySet>]: identitySet [SourceParticipantId <String>]: The ID of the participant that triggered the incoming call. Read-only. [Transferor <IMicrosoftGraphIdentitySet>]: identitySet [MediaConfig <IMicrosoftGraphMediaConfig>]: mediaConfig [(Any) <Object>]: This indicates any property can be added to this object. [MediaState <IMicrosoftGraphCallMediaState>]: callMediaState [(Any) <Object>]: This indicates any property can be added to this object. [Audio <String>]: mediaState [MeetingInfo <IMicrosoftGraphMeetingInfo>]: meetingInfo [(Any) <Object>]: This indicates any property can be added to this object. [MyParticipantId <String>]: [Operations <IMicrosoftGraphCommsOperation[]>]: [Id <String>]: The unique identifier for an entity. Read-only. [ClientContext <String>]: Unique Client Context string. Max limit is 256 chars. [ResultInfo <IMicrosoftGraphResultInfo>]: resultInfo [(Any) <Object>]: This indicates any property can be added to this object. [Code <Int32?>]: The result code. [Message <String>]: The message. [Subcode <Int32?>]: The result subcode. [Status <String>]: operationStatus [Participants <IMicrosoftGraphParticipant[]>]: [Id <String>]: The unique identifier for an entity. Read-only. [Info <IMicrosoftGraphParticipantInfo>]: participantInfo [(Any) <Object>]: This indicates any property can be added to this object. [CountryCode <String>]: The ISO 3166-1 Alpha-2 country code of the participant's best estimated physical location at the start of the call. Read-only. [EndpointType <String>]: endpointType [Identity <IMicrosoftGraphIdentitySet>]: identitySet [LanguageId <String>]: The language culture string. Read-only. [ParticipantId <String>]: The participant ID of the participant. Read-only. [Region <String>]: The home region of the participant. This can be a country, a continent, or a larger geographic region. This doesn't change based on the participant's current physical location. Read-only. [IsInLobby <Boolean?>]: true if the participant is in lobby. [IsMuted <Boolean?>]: true if the participant is muted (client or server muted). [MediaStreams <IMicrosoftGraphMediaStream[]>]: The list of media streams. [Direction <String>]: mediaDirection [Label <String>]: The media stream label. [MediaType <String>]: modality [ServerMuted <Boolean?>]: If the media is muted by the server. [SourceId <String>]: The source ID. [Metadata <String>]: A blob of data provided by the participant in the roster. [RecordingInfo <IMicrosoftGraphRecordingInfo>]: recordingInfo [(Any) <Object>]: This indicates any property can be added to this object. [Initiator <IMicrosoftGraphIdentitySet>]: identitySet [RecordingStatus <String>]: recordingStatus [RemovedState <IMicrosoftGraphRemovedState>]: removedState [(Any) <Object>]: This indicates any property can be added to this object. [Reason <String>]: The removal reason for the participant resource. [RestrictedExperience <IMicrosoftGraphOnlineMeetingRestricted>]: onlineMeetingRestricted [(Any) <Object>]: This indicates any property can be added to this object. [ContentSharingDisabled <String>]: onlineMeetingContentSharingDisabledReason [VideoDisabled <String>]: onlineMeetingVideoDisabledReason [RosterSequenceNumber <Int64?>]: Indicates the roster sequence number in which the participant was last updated. [RequestedModalities <String[]>]: The list of requested modalities. Possible values are: unknown, audio, video, videoBasedScreenSharing, data. [ResultInfo <IMicrosoftGraphResultInfo>]: resultInfo [Source <IMicrosoftGraphParticipantInfo>]: participantInfo [State <String>]: callState [Subject <String>]: The subject of the conversation. [Targets <IMicrosoftGraphInvitationParticipantInfo[]>]: The targets of the call. Required information for creating peer to peer call. [Hidden <Boolean?>]: Optional. Whether to hide the participant from the roster. [Identity <IMicrosoftGraphIdentitySet>]: identitySet [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. [TenantId <String>]: [ToneInfo <IMicrosoftGraphToneInfo>]: toneInfo [(Any) <Object>]: This indicates any property can be added to this object. [SequenceId <Int64?>]: An incremental identifier used for ordering DTMF events. [Tone <String>]: tone [Transcription <IMicrosoftGraphCallTranscriptionInfo>]: callTranscriptionInfo [(Any) <Object>]: This indicates any property can be added to this object. [LastModifiedDateTime <DateTime?>]: The state modified time in UTC. [State <String>]: callTranscriptionState

CALLOPTIONS <IMicrosoftGraphCallOptions>: callOptions [(Any) <Object>]: This indicates any property can be added to this object. [HideBotAfterEscalation <Boolean?>]: Indicates whether to hide the app after the call is escalated. [IsContentSharingNotificationEnabled <Boolean?>]: Indicates whether content sharing notifications should be enabled for the call. [IsDeltaRosterEnabled <Boolean?>]: Indicates whether delta roster is enabled for the call. [IsInteractiveRosterEnabled <Boolean?>]: Indicates whether delta roster filtering by participant interactivity is enabled.

CALLROUTES <IMicrosoftGraphCallRoute[]>: The routing information on how the call was retargeted. Read-only. [Final <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.For drive items, 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 don't show up as changed when using delta. [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review. [Device <IMicrosoftGraphIdentity>]: identity [User <IMicrosoftGraphIdentity>]: identity [Original <IMicrosoftGraphIdentitySet>]: identitySet [RoutingType <String>]: routingType

CHATINFO <IMicrosoftGraphChatInfo>: chatInfo [(Any) <Object>]: This indicates any property can be added to this object. [MessageId <String>]: The unique identifier of a message in a Microsoft Teams channel. [ReplyChainMessageId <String>]: The ID of the reply message. [ThreadId <String>]: The unique identifier for a thread in Microsoft Teams.

CONTENTSHARINGSESSIONS <IMicrosoftGraphContentSharingSession[]>: . [Id <String>]: The unique identifier for an entity. Read-only.

INCOMINGCONTEXT <IMicrosoftGraphIncomingContext>: incomingContext [(Any) <Object>]: This indicates any property can be added to this object. [ObservedParticipantId <String>]: The ID of the participant that is under observation. Read-only. [OnBehalfOf <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.For drive items, 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 don't show up as changed when using delta. [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review. [Device <IMicrosoftGraphIdentity>]: identity [User <IMicrosoftGraphIdentity>]: identity [SourceParticipantId <String>]: The ID of the participant that triggered the incoming call. Read-only. [Transferor <IMicrosoftGraphIdentitySet>]: identitySet

MEDIASTATE <IMicrosoftGraphCallMediaState>: callMediaState [(Any) <Object>]: This indicates any property can be added to this object. [Audio <String>]: mediaState

OPERATIONS <IMicrosoftGraphCommsOperation[]>: . [Id <String>]: The unique identifier for an entity. Read-only. [ClientContext <String>]: Unique Client Context string. Max limit is 256 chars. [ResultInfo <IMicrosoftGraphResultInfo>]: resultInfo [(Any) <Object>]: This indicates any property can be added to this object. [Code <Int32?>]: The result code. [Message <String>]: The message. [Subcode <Int32?>]: The result subcode. [Status <String>]: operationStatus

PARTICIPANTS <IMicrosoftGraphParticipant[]>: . [Id <String>]: The unique identifier for an entity. Read-only. [Info <IMicrosoftGraphParticipantInfo>]: participantInfo [(Any) <Object>]: This indicates any property can be added to this object. [CountryCode <String>]: The ISO 3166-1 Alpha-2 country code of the participant's best estimated physical location at the start of the call. Read-only. [EndpointType <String>]: endpointType [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.For drive items, 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 don't show up as changed when using delta. [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review. [Device <IMicrosoftGraphIdentity>]: identity [User <IMicrosoftGraphIdentity>]: identity [LanguageId <String>]: The language culture string. Read-only. [ParticipantId <String>]: The participant ID of the participant. Read-only. [Region <String>]: The home region of the participant. This can be a country, a continent, or a larger geographic region. This doesn't change based on the participant's current physical location. Read-only. [IsInLobby <Boolean?>]: true if the participant is in lobby. [IsMuted <Boolean?>]: true if the participant is muted (client or server muted). [MediaStreams <IMicrosoftGraphMediaStream[]>]: The list of media streams. [Direction <String>]: mediaDirection [Label <String>]: The media stream label. [MediaType <String>]: modality [ServerMuted <Boolean?>]: If the media is muted by the server. [SourceId <String>]: The source ID. [Metadata <String>]: A blob of data provided by the participant in the roster. [RecordingInfo <IMicrosoftGraphRecordingInfo>]: recordingInfo [(Any) <Object>]: This indicates any property can be added to this object. [Initiator <IMicrosoftGraphIdentitySet>]: identitySet [RecordingStatus <String>]: recordingStatus [RemovedState <IMicrosoftGraphRemovedState>]: removedState [(Any) <Object>]: This indicates any property can be added to this object. [Reason <String>]: The removal reason for the participant resource. [RestrictedExperience <IMicrosoftGraphOnlineMeetingRestricted>]: onlineMeetingRestricted [(Any) <Object>]: This indicates any property can be added to this object. [ContentSharingDisabled <String>]: onlineMeetingContentSharingDisabledReason [VideoDisabled <String>]: onlineMeetingVideoDisabledReason [RosterSequenceNumber <Int64?>]: Indicates the roster sequence number in which the participant was last updated.

RESULTINFO <IMicrosoftGraphResultInfo>: resultInfo [(Any) <Object>]: This indicates any property can be added to this object. [Code <Int32?>]: The result code. [Message <String>]: The message. [Subcode <Int32?>]: The result subcode.

SOURCE <IMicrosoftGraphParticipantInfo>: participantInfo [(Any) <Object>]: This indicates any property can be added to this object. [CountryCode <String>]: The ISO 3166-1 Alpha-2 country code of the participant's best estimated physical location at the start of the call. Read-only. [EndpointType <String>]: endpointType [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.For drive items, 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 don't show up as changed when using delta. [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review. [Device <IMicrosoftGraphIdentity>]: identity [User <IMicrosoftGraphIdentity>]: identity [LanguageId <String>]: The language culture string. Read-only. [ParticipantId <String>]: The participant ID of the participant. Read-only. [Region <String>]: The home region of the participant. This can be a country, a continent, or a larger geographic region. This doesn't change based on the participant's current physical location. Read-only.

TARGETS <IMicrosoftGraphInvitationParticipantInfo[]>: The targets of the call. Required information for creating peer to peer call. [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.For drive items, 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 don't show up as changed when using delta. [Id <String>]: Unique identifier for the identity or actor. For example, in the access reviews decisions API, this property might record the id of the principal, that is, the group, user, or application that's subject to review. [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.

TONEINFO <IMicrosoftGraphToneInfo>: toneInfo [(Any) <Object>]: This indicates any property can be added to this object. [SequenceId <Int64?>]: An incremental identifier used for ordering DTMF events. [Tone <String>]: tone

TRANSCRIPTION <IMicrosoftGraphCallTranscriptionInfo>: callTranscriptionInfo [(Any) <Object>]: This indicates any property can be added to this object. [LastModifiedDateTime <DateTime?>]: The state modified time in UTC. [State <String>]: callTranscriptionState