Компонент Голосовая почта

Описание

Предоставляет функции по работе с ящиком голосовых сообщений.

Table 1. Системные характеристики

Индекс

110

Краткое название

voicemail

Типы сценариев

Все

Стартовый модуль

r_script_component_voicemail

Режим

Синхронный

Иконка

110

Характер разветвления

Разветвляющий, замыкающий

Свойства

Table 2. Свойства
Спецификация Описание

Название: Операция
Код: vmOperation
Усл. видимости: нет
По умолчанию: Положить сообщение

Операция с голосовым ящиком.
Возможные варианты:

  • Положить сообщение (put_msg, 1) – Размещает звуковой файл в ящик голосовой почты в папку Новые.

  • Получить количество сообщений (get_msg_count, 2) – Возвращает количество голосовых сообщений в указанной папке.

  • Достать сообщение по индексу (get_msg_at, 3) – Возвращает конкретное голосовое сообщение по индексу в указанной папке.

  • Достать новое сообщение (get_newest_msg, 4) – Возвращает первое (самое новое) голосовое сообщение из папки Новые.

  • Достать старое сообщение (get_oldest_msg, 5) – Возвращает первое (самое старое) голосовое сообщение из папи Прослушанные.

  • Достать следующее сообщение (get_next_msg, 6) – Возвращает следующее сообщение из той же папки, что и сообщение с указанным идентификатором. Использует указанное направление перехода.

  • Переместить в прослушанные (set_msg_listened, 7) – Перемещает указанное сообщение из папки Новые в папку Прослушанные.

  • Удалить сообщение (delete_msg, 8) – Удаляет указанное сообщение из голосового ящика.

  • Очистить ящик (clean_box, 9) – Очищает указанную папку голосового ящика.

Название: Номер ящика
Код: vmBoxNumber
Усл. видимости: нет
По умолчанию: — 

Уникальный номер ящика.
То же значение, что и постфикс телефонного номера, следующий за featurecode с типом voicemail

Название: ID текущего сообщения
Код: vmCurrentId
Усл. видимости: да
По умолчанию: — 

Идентификатор сообщения.
Используется как маркер текущего положения, относительно которого происходит перемещение по сообщениям в ящике.

Название: Папка ящика
Код: vmBoxFolder
Усл. видимости: да
По умолчанию: Новые

Возможные варианты:

  • Новые (new, 1) – Папка с новыми сообщениями.

  • Прослушанные (listened, 2) – Папка с прослушанными сообщениями.

Название: Путь к файлу
Код: vmLocalFilePath
Усл. видимости: да
По умолчанию: — 

Путь к аудио-файлу, подлежащему размещению в ящик голосовой почты.
Должен включать одну из файловых категорий.

Название: Отправитель
Код: vmMessageSender
Усл. видимости: да
По умолчанию: — 

Имя отправителя.

Название: Индекс
Код: vmMessageIndex
Усл. видимости: да
По умолчанию: — 

Порядковый индекс сообщения для операции взятия с конкретной позиции.

Название: Метод
Код: vmMethod
Усл. видимости: да
По умолчанию: Новее

Направление перемещения при последовательном прослушивании.

Название: Новых сообщений
Код: vmNewMessageCount
Усл. видимости: да
По умолчанию: — 

Переменная для сохранения количества голосовых сообщений в папке Новые.

Название: Старых сообщений
Код: vmOldMessageCount
Усл. видимости: да
По умолчанию: — 

Переменная для сохранения количества голосовых сообщений в папке Прослушанные.

Название: ID сообщения
Код: vmMessageId
Усл. видимости: да
По умолчанию: — 

Переменная для сохранения идентификатора возвращаемого голосового сообщения.

Название: Отправитель
Код: vmMessageFrom
Усл. видимости: да
По умолчанию: — 

Переменная для сохранения отправителя возвращаемого голосового сообщения.

Название: Дата отправки
Код: vmMessageDate
Усл. видимости: да
По умолчанию: — 

Переменная для сохранения даты отправки возвращаемого голосового сообщения.

Название: Путь к файлу
Код: vmVoiceFilePath
Усл. видимости: да
По умолчанию: — 

Переменная для сохранения локального пути к файлу записи возвращаемого голосового сообщения.
Включает одну из файловых категорий.

Название: Причина ошибки
Код: vmErrorReason
Усл. видимости: нет
По умолчанию: — 

Переменная для сохранения кода ошибки.

Название: Переход
Код: transfer
Усл. видимости: нет
По умолчанию: — 

Компонент, которому передается управление в случае успешного выполнения операции.

Название: Переход, не найдено
Код: transferNotFound
Усл. видимости: нет
По умолчанию: — 

Компонент, которому передается управление в случае, если операция не обнаружила сообщение.

Название: Переход, ошибка
Код: transferError
Усл. видимости: нет
По умолчанию: — 

Компонент, которому передается управление в случае возникновения ошибки при выполнении операции.

См. также

  • Функциональная роль scr

  • Функциональная роль vmail