Skip to content

Latest commit

 

History

History
150 lines (114 loc) · 3.1 KB

Send-CWCSessionMessage.md

File metadata and controls

150 lines (114 loc) · 3.1 KB
external help file ConnectWiseControlAPI-help.xml
Module Name ConnectWiseControlAPI
online version https://github.com/christaylorcodes/ConnectWiseControlAPI
schema 2.0.0

Send-CWCSessionMessage

SYNOPSIS

Sends a chat message to a session's guest.

SYNTAX

Send-CWCSessionMessage [-GUID] <Guid> [-Message] <String> [[-From] <String>] [[-Group] <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Queues a QueuedMessage session event.

Credentials connections: PageService.AddSessionEvents. The guest sees the connected user's display name as the sender (-From is not supported) and the user needs the matching permission in -Group.

API secret connections: the RESTful API Manager extension's SendMessageToSession. The guest sees -From as the sender; -Group is ignored.

EXAMPLES

EXAMPLE 1

Send-CWCSessionMessage -GUID $SessionID -Message 'Your computer will restart in 5 minutes.'

PARAMETERS

-GUID

Session ID.

Type: Guid
Parameter Sets: (All)
Aliases: SessionID

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-Message

Message text.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-From

Sender name shown to the guest (API secret connections only). Defaults to 'RESTful API', the extension's default RESTfulUserName. The extension uses this value, not its RESTfulUserName setting, so pass -From to match a renamed setting (or any name you want the guest to see).

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: RESTful API
Accept pipeline input: False
Accept wildcard characters: False

-Group

Session group containing the session (credentials connections only). Defaults to 'All Machines'.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: All Machines
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

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

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

CommonParameters

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

INPUTS

OUTPUTS

NOTES

Author: Chris Taylor

RELATED LINKS

https://github.com/christaylorcodes/ConnectWiseControlAPI