Other App Operations

Operations detached from Functionalities

WinGuard provides a number of Operations which can be sent to Objects or the Module itself. They are not bound to any Functionality, yet.

All the following Operations are sent to the Module and not to an Object.

SendSMS

Send an SMS to a phone defined by the PhoneNumber property.

Properties

Name Type Description
Message Message Message to be send
Language string Language code (e.g., “en” or “de”)
PhoneNumber string Target phone number
Prio int Priority (e.g., from the Event)

SendFax

Send a fax to a fax number.

Properties

Name Type Description
Message Message Message to be send
Language string Language code (e.g., “en” or “de”)
FaxNumber string Target phone number
Attachments Attachment[]

SendPager

Send a message to a pager number.

Properties

Name Type Description
Message Message Message to be send
Language string Language code (e.g., “en” or “de”)
PagerNumber string Target pager number
Options string Comma separated pager options in the following order: , , ,
optional hier angegeben werden.
Custom string with options

SendEmail

Send a message to an address.

Properties

Name Type Description
Message Message Message to be send
Language string Language code (e.g., “en” or “de”)
EmailAddress string Target mail address
Subject Message
Attachments Attachment[]

VoiceMessage

Send a text or an audio message to a phone defined by the PhoneNumber property.

Properties

Name Type Description
Message Message Message to be send
PhoneNumber string[] Target phone numbers. When Confirm is set to false, only the first number is the target. For more details see the Confirm property.
Text string Text message. When this is set, Audio is not set.
Audio data Audio message send in WAV format. When this is set, Text is not set.
Confirm bool This option determines whether a confirmation is required after receiving a message. If no confirmation is entered, the next number in PhoneNumber should be called.
Delay int Number of seconds that the sending of the message should be delayed by the extension.

Objects

Message

Name Type Description
FileName string (optional) Name of the file the message was read from.
Text string The message content.
Error string (optional) Error description.

Attachment

Name Type Description
FileName string Name of the attachment file
Data data Data stored as a byte array
Error string (optional) Error description

Aperture

Adjust the camera iris.

Name Type Description
aperture_speed double Defines the adjustment of the camera iris. The value is between -100 and 100.

Focus

Adjust the camera focus.

Name Type Description
focus_speed double Defines the adjustment of the camera focus. The value is between -100 and 100.

ExportVideo

Exports a video recording.

This Operation is available as an Object or an Activity Operation. This section describes the Object Operation.

To enable this Operation, the app settings App.CanExportVideosDirect and App.ExportVideoExtensions have to be set in the Module XML.

For Properties and result values, refer to ShowVideo ExportVideo.

ExportAudio

Exports an audio clip.

As a prerequisite in WinGuard, the command “Create Bookmark (Audio)” must be configured. The command must be triggered from the context of an App Event which has a Property called AudioClipId or which was created from a mapping of a Call Activity which has set the Property AudioClipId. Depending on configuration, the ExportAudio Operation is sent immediately upon triggering the “Create Bookmark (Audio)” command, or for an audio bookmark in the Media Archive. The ExportAudio Operation is sent to the “recorder” Object configured in the “Create Bookmark (Audio)” command.

Properties

Name Type Description
AudioClipId string The unique identifier of the audio clip.
Format string (optional) The requested format of the audio clip.

Result

The AudioData can be returned directly or via out-of-band transmission.

Name Type Description
AudioData data/object The audio data as a byte array; or a resource definition for an Operation-bound ‘put’ resource.
Format string (optional) The format of the audio data (e.g., “wav”, “mp3”), if known.
Duration int (optional) The duration of the audio clip in milliseconds, if known.
Last modified September 25, 2026