Voice mail component

Table of Contents

Description
Properties
See also

Description

Provides voice message box functionality.

Table 1. System Characteristics

Index	`110`
Short title	`voicemail`
Types of scenarios	`All of them`
Starter module	`r_script_component_voicemail`
Mode	Synchronous
Icon
Branching pattern	Branching, closing

Properties

Table 2. Properties
Specification	Description
Title: `Operation` Code: `vmOperation` Visibility: `no` Default: `Place Message'	Voice mailbox operation. Possible options: `Put Message` (`put_msg`, `1`) - Places a sound file in the voice mailbox in the `New' folder`. `Get message count` (`get_msg_count`, `2`) - Returns the number of voice messages in the specified folder. `Get message by index` (`get_msg_at`, `3`) - Returns a specific voice message by index in the specified folder. `Get Newest Message` (`get_newest_msg`, `4`) - Returns the first (newest) voice message from the `Newest` folder`. `Get Oldest Message` (`get_oldest_msg`, `5`) - Returns the first (oldest) voice message from the `Listened to` papi`. `Get next message` (`get_next_msg`, `6`) - Returns the next message from the same folder as the message with the specified identifier. Uses the specified transition direction. `Move to Listened` (`set_msg_listened`, `7`) - Moves the specified message from the `New` folder to the `Listened` folder`. `Delete Message` (`delete_msg`, `8`) - Deletes the specified message from the voice mailbox. `Clear Box` (`clean_box`, `9`) - Clears the specified voice box folder.
Title: `Box number` Code: `vmBoxNumber` Visibility: `no` Default: —	Unique box number. Same value as the phone number postfix following featurecode with type `voicemail`
Title: `ID of current message` Code: `vmCurrentId` Visibility: `yes` Default: —	Message ID. Used as a marker of the current position relative to which messages in the box are moved.
Title: `Box file` Code: `vmBoxFolder` Visibility: `yes` Default: `New'	Possible options: `New` (`new`, `1`) - Folder with new messages. `Listened` (`listened`, `2`) - Folder with listened messages.
Title: `File path` Code: `vmLocalFilePath` Visibility: `yes` Default: —	The path to the audio file to be placed in the voice mailbox. Must include one of filecategories.
Title: `Sender` Code: `vmMessageSender` Visibility: `yes` Default: —	Sender Name.
Title: `Index` Code: `vmMessageIndex` Visibility: `yes` Default: —	Order index of the message for a take operation from a specific position.
Title: `Method` Code: `vmMethod` Visibility: `yes` Default: `Newer`	Direction of movement in sequential listening.
Title: `New Messages` Code: `vmNewMessageCount` Visibility: `yes` Default: —	Variable to store the number of voice messages in the `New' folder`.
Title: `Old Messages` Code: `vmOldMessageCount` Visibility: `yes` Default: —	Variable to store the number of voicemails in the `Listened to folder`.
Title: `Message ID` Code: `vmMessageId` Visibility: `yes` Default: —	Variable to store the identifier of the returned voice message.
Title: `Sender` Code: `vmMessageFrom` Visibility: `yes` Default: —	Variable to store the sender of the returned voice message.
Title: `Date of shipment` Code: `vmMessageDate` Visibility: `yes` Default: —	Variable to store the date the returned voice message was sent.
Title: `File path` Code: `vmVoiceFilePath` Visibility: `yes` Default: —	Variable to store the local path to the recording file of the returned voice message. Includes one of filecategories.
Title: `Reason for error` Code: `vmErrorReason` Visibility: `no` Default: —	Variable to store the error code.
Title: `Transition` Code: `transfer` Visibility: `no` Default: —	The component to which control is passed if the operation is successful.
Title: `Transition, not found` Code: `transferNotFound` Visibility: `no` Default: —	Component to which control is passed in case the operation did not detect the message.
Title: `Transition, Error` Code: `transferError` Visibility: `no` Default: —	The component to which control is passed if an error occurs during an operation.

See also

role svc
role vmail