Send-MgUserOnlineMeetingVirtualAppointmentSm

Module:

Microsoft.Graph.Users.Actions

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.

Note

To view the beta release of this cmdlet, view Send-MgBetaUserOnlineMeetingVirtualAppointmentSm

Syntax

Send-MgUserOnlineMeetingVirtualAppointmentSm
    -OnlineMeetingId <String>
    -UserId <String>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-Attendees <IMicrosoftGraphAttendeeNotificationInfo[]>]
    [-MessageType <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Send-MgUserOnlineMeetingVirtualAppointmentSm
    -OnlineMeetingId <String>
    -UserId <String>
    -BodyParameter <IPaths16Og72WUsersUserIdOnlinemeetingsOnlinemeetingIdMicrosoftGraphSendvirtualappointmentsmsPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Send-MgUserOnlineMeetingVirtualAppointmentSm
    -InputObject <IUsersActionsIdentity>
    [-ResponseHeadersVariable <String>]
    [-AdditionalProperties <Hashtable>]
    [-Attendees <IMicrosoftGraphAttendeeNotificationInfo[]>]
    [-MessageType <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Send-MgUserOnlineMeetingVirtualAppointmentSm
    -InputObject <IUsersActionsIdentity>
    -BodyParameter <IPaths16Og72WUsersUserIdOnlinemeetingsOnlinemeetingIdMicrosoftGraphSendvirtualappointmentsmsPostRequestbodyContentApplicationJsonSchema>
    [-ResponseHeadersVariable <String>]
    [-Headers <IDictionary>]
    [-PassThru]
    [-ProgressAction <ActionPreference>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

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.

Permissions

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	VirtualAppointmentNotification.Send	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

Examples

Example 1: Code snippet

Import-Module Microsoft.Graph.Users.Actions

$params = @{
	attendees = @(
		@{
			phoneNumber = "+13129224122"
			timeZone = "Pacific Standard Time"
		}
		@{
			phoneNumber = "+1242421412"
			timeZone = "Eastern Standard Time"
		}
	)
	messageType = "confirmation"
}

# A UPN can also be used as -UserId.
Send-MgUserOnlineMeetingVirtualAppointmentSm -UserId $userId -OnlineMeetingId $onlineMeetingId -BodyParameter $params

This example shows how to use the Send-MgUserOnlineMeetingVirtualAppointmentSm Cmdlet.

Parameters

-AdditionalProperties

Additional Parameters

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

-Attendees

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

Type:	IMicrosoftGraphAttendeeNotificationInfo[]
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:	IPaths16Og72WUsersUserIdOnlinemeetingsOnlinemeetingIdMicrosoftGraphSendvirtualappointmentsmsPostRequestbodyContentApplicationJsonSchema
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
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:	IUsersActionsIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-MessageType

virtualAppointmentMessageType

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

-OnlineMeetingId

The unique identifier of onlineMeeting

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

-UserId

The unique identifier of user

Type:	String
Position:	Named
Default value:	None
Required:	True
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.IPaths16Og72WUsersUserIdOnlinemeetingsOnlinemeetingIdMicrosoftGraphSendvirtualappointmentsmsPostRequestbodyContentApplicationJsonSchema

Microsoft.Graph.PowerShell.Models.IUsersActionsIdentity

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.

ATTENDEES <IMicrosoftGraphAttendeeNotificationInfo- []>: .

• [PhoneNumber <String>]: The phone number of the external attendee. Required.
• [TimeZone <String>]: The time zone of the external attendee. The timeZone property can be set to any of the time zones currently supported by Windows. Required.

BODYPARAMETER <IPaths16Og72WUsersUserIdOnlinemeetingsOnlinemeetingIdMicrosoftGraphSendvirtualappointmentsmsPostRequestbodyContentApplicationJsonSchema>: .

• [(Any) <Object>]: This indicates any property can be added to this object.
• [Attendees <IMicrosoftGraphAttendeeNotificationInfo- []>]:
  • [PhoneNumber <String>]: The phone number of the external attendee. Required.
  • [TimeZone <String>]: The time zone of the external attendee. The timeZone property can be set to any of the time zones currently supported by Windows. Required.
• [MessageType <String>]: virtualAppointmentMessageType

INPUTOBJECT <IUsersActionsIdentity>: Identity Parameter

• [AuthenticationMethodId <String>]: The unique identifier of authenticationMethod
• [CalendarId <String>]: The unique identifier of calendar
• [ChatId <String>]: The unique identifier of chat
• [ChatMessageId <String>]: The unique identifier of chatMessage
• [ChatMessageId1 <String>]: The unique identifier of chatMessage
• [ContentTypeId <String>]: The unique identifier of contentType
• [DeviceLogCollectionResponseId <String>]: The unique identifier of deviceLogCollectionResponse
• [DocumentSetVersionId <String>]: The unique identifier of documentSetVersion
• [DriveId <String>]: The unique identifier of drive
• [DriveItemId <String>]: The unique identifier of driveItem
• [DriveItemVersionId <String>]: The unique identifier of driveItemVersion
• [EventId <String>]: The unique identifier of event
• [EventId1 <String>]: The unique identifier of event
• [ListItemId <String>]: The unique identifier of listItem
• [ListItemVersionId <String>]: The unique identifier of listItemVersion
• [MailFolderId <String>]: The unique identifier of mailFolder
• [MailFolderId1 <String>]: The unique identifier of mailFolder
• [ManagedDeviceId <String>]: The unique identifier of managedDevice
• [MessageId <String>]: The unique identifier of message
• [NotebookId <String>]: The unique identifier of notebook
• [OnenotePageId <String>]: The unique identifier of onenotePage
• [OnenoteSectionId <String>]: The unique identifier of onenoteSection
• [OnlineMeetingId <String>]: The unique identifier of onlineMeeting
• [PermissionId <String>]: The unique identifier of permission
• [PhoneAuthenticationMethodId <String>]: The unique identifier of phoneAuthenticationMethod
• [SubscriptionId <String>]: The unique identifier of subscription
• [TeamsAppInstallationId <String>]: The unique identifier of teamsAppInstallation
• [TodoTaskId <String>]: The unique identifier of todoTask
• [TodoTaskListId <String>]: The unique identifier of todoTaskList
• [UserId <String>]: The unique identifier of user

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.users.actions/send-mguseronlinemeetingvirtualappointmentsm
• https://learn.microsoft.com/graph/api/virtualappointment-sendvirtualappointmentsms?view=graph-rest-1.0