Voicemail Component

:icons:font :hardbreaks: :imagesdir: ../../../assets/images :toc-title: Contents :toc:

Description

Provides functions for working with the voice mailbox.

Table 1. System characteristics

Index

110

Short name

voicemail

Script types

All

Start module

r_script_component_voicemail

Mode

Synchronous

Icon

110

Branching type

Branching, closing

Properties

Table 2. Properties
Specification Description

Name: Operation

Code: vmOperation

Visibility condition: no

Default: Post message

Operation with voice box.

Possible options:

  • Put message (put_msg, 1) – Places an audio file in the voicemail box in the New folder.

  • Get number of messages (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 new message (get_newest_msg, 4) – Returns the first (newest) voice message from the New folder.

  • Get old message (get_oldest_msg, 5) – Returns the first (oldest) voice message from the Listened folder.

  • Get Next Message (get_next_msg, 6) – Returns the next message from the same folder as the message with the specified ID. 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 box.

  • Clear mailbox (clean_box, 9) – Clears the specified voice mailbox folder.

Name: Box number

Code: vmBoxNumber

Visibility condition: no Default: — 

Unique box number.

Same meaning as the telephone number postfix following featurecode with type voicemail

Name: Current message ID

Code: vmCurrentId

Visibility condition: yes

Default: — 

Message ID. Used as a marker of the current position relative to which the messages in the mailbox are navigated.

Name: Box folder

Code: vmBoxFolder

Visibility condition: yes

Default: New

Possible options:

  • New (new, 1) – Folder with new messages.

  • Listened (listened, 2) – Folder with listened messages.

Name: Path to file

Code: vmLocalFilePath

Visibility condition: yes

Default: — 

Path to the audio file to be placed in the voicemail box.

Must include one of file categories.

Name: Sender

Code: vmMessageSender

Visibility condition: yes

Default: — 

Sender’s name.

Name: Index

Code: vmMessageIndex

Visibility condition: yes Default: — 

Message ordinal index for the take operation from a specific position.

Name: Method

Code: vmMethod

Visibility condition: yes

Default: Newer

Direction of movement during sequential listening.

Name: New messages Code: vmNewMessageCount Visibility condition: yes

Default: — 

Variable for saving the number of voice messages in the New folder.

Name: Old messages

Code: vmOldMessageCount

Visibility condition: yes

Default: — 

Variable for storing the number of voice messages in the Listened folder.

Name: Message ID

Code: vmMessageId

Visibility condition: yes

Default: — 

Variable to store the identifier of the returned voice message.

Name: Sender

Code: vmMessageFrom

Visibility condition: yes Default: — 

Variable to store the sender of the returned voice message.

Name: Sent date

Code: vmMessageDate

Visibility condition: yes

Default: — 

Variable to store the date the returned voice message was sent.

Name: Path to file Code: vmVoiceFilePath Visibility condition: yes

Default: — 

Variable for storing the local path to the recording file of the returned voice message.

Includes one of file categories.

Name: Reason for error

Code: vmErrorReason

Visibility condition: no Default: — 

Variable for storing the error code.

Name: Transition

Code: transfer

Visibility condition: no

Default: — 

The component to which control is transferred if the operation is successful.

Name: Transition, not found Code: transferNotFound Visibility condition: no

Default: — 

The component to which control is transferred if the operation does not detect a message.

Name: Transition, error

Code: transferError

Visibility condition: no

Default: — 

The component to which control is transferred if an error occurs during the operation.

See also