~~NOTOC~~
==== Список запросов ====
^ Запрос ^ Описание ^
| [[#holdmusic_elementlist|holdmusic/element.list]] | Получает список элементов "Музыка на удержании" |
| [[#holdmusic_elementget|holdmusic/element.get]] | Получает параметры элемента "Музыка на удержании" |
| [[#holdmusic_elementadd|holdmusic/element.add]] | Добавляет новый элемент "Музыка на удержании" |
| [[#holdmusic_elementedit|holdmusic/element.edit]] | Изменяет параметры элемента "Музыка на удержании" |
| [[#holdmusic_elementdel|holdmusic/element.del]] | Удаляет элемент "Музыка на удержании" |
| [[#holdmusic_elementfilelist|holdmusic/element.file.list]] | Получает список аудиофайлов из элемента "Музыка на удержании" |
| [[#holdmusic_elementfileget|holdmusic/element.file.get]] | Получает параметры аудиофайла из элемента "Музыка на удержании" |
| [[#holdmusic_elementfileadd|holdmusic/element.file.add]] | Добавляет новый аудиофайл в элемент "Музыка на удержании" |
| [[#holdmusic_elementfiledel|holdmusic/element.file.del]] | Удаляет аудиофайл из элемента "Музыка на удержании" |

----

==== holdmusic/element.list ====
Получает список элементов "Музыка на удержании"\\
\\
**Параметры запроса:**\\
Нет \\
\\
**Возврат**: Массив объектов в формате json
  * **elementId** - Идентификатор элемента "Музыка на удержании"
  * **elementName** - Название элемента "Музыка на удержании"
  * **elementExten** - Не используется

----

==== holdmusic/element.get ====
Получает параметры элемента "Музыка на удержании"\\
\\
**Параметры запроса:**
  * **elementId** - Идентификатор элемента "Музыка на удержании"
**Возврат**: Объект в формате json
  * **elementId** - Идентификатор элемента "Музыка на удержании"
  * **elementName** - Название элемента "Музыка на удержании"
  * **elementExten** - Не используется
  * **dirName** - внутреннее название папки с аудиофайлами
  * **random** - Случайный выбор аудиофайла для воспроизведения. 0-по очереди, 1-случайно

----

==== holdmusic/element.add ====
Добавляет новый элемент "Музыка на удержании"\\
\\
**Параметры запроса:**
  * **elementName** - Название элемента "Музыка на удержании"
  * **random** - Случайный выбор аудиофайла для воспроизведения. 0-по очереди, 1-случайно
**Возврат:**\\ Идентификатор нового элемента "Музыка на удержании"

----

==== holdmusic/element.edit ====
Изменяет параметры элемента "Музыка на удержании" \\
\\
**Параметры запроса:** 
  * **elementId** - Идентификатор элемента "Музыка на удержании"
  * **elementName** - Название элемента "Музыка на удержании"
  * **random** - Случайный выбор аудиофайла для воспроизведения. 0-по очереди, 1-случайно
**Возврат:** - Булево 

----

==== holdmusic/element.del ====
Удаляет элемент "Музыка на удержании" \\
\\
**Параметры запроса:**
  * **elementId** - Идентификатор элемента "Музыка на удержании"
**Возврат:** - Булево 

----

==== holdmusic/element.file.list ====
Получает список аудиофайлов из элемента "Музыка на удержании"\\
\\
**Параметры запроса:**\\
  * **elementId** - Идентификатор элемента "Музыка на удержании"
**Возврат**: Массив объектов в формате json
  * **fileId** - Идентификатор аудиофайла
  * **fileName** - Оригинальное имя аудиофайла
  * **fileInternalName** - Внутреннее имя аудиофайла

----

==== holdmusic/element.file.get ====
Получает параметры аудиофайла из элемента "Музыка на удержании"\\
\\
**Параметры запроса:**
  * **elementId** - Идентификатор элемента "Музыка на удержании"
  * **fileId** - Идентификатор аудиофайла
**Возврат**: Объект в формате json
  * **fileId** - Идентификатор аудиофайла
  * **fileName** - Оригинальное имя аудиофайла
  * **fileInternalName** - Внутреннее имя аудиофайла

----

==== holdmusic/element.file.add ====
Добавляет новый аудиофайл в элемент "Музыка на удержании" \\
\\
**Параметры запроса:**
  * **elementId** - Идентификатор элемента "Музыка на удержании"
  * **soundFile** - Аудиофайл для добавления в элемент "Музыка на удержании"
**Возврат**: Объект в формате json. Совпадает с возвратом [[#holdmusic_elementfileget|holdmusic/element.file.get]]

----

==== holdmusic/element.file.del ====
Удаляет аудиофайл из элемента "Музыка на удержании" \\
\\
**Параметры запроса:**
  * **elementId** - Идентификатор элемента "Музыка на удержании"
  * **fileId** - Идентификатор аудиофайла
**Возврат**- Булево