~~NOTOC~~
==== Список запросов ====
^ Запрос ^ Описание ^
| [[#devices_elementlist|devices/element.list]] | Получает список телефонов |
| [[#devices_elementget|devices/element.get]] | Получает параметры телефона |
| [[#devices_elementadd|devices/element.add]] | Добавляет новый телефон |
| [[#devices_elementedit|devices/element.edit]] | Изменяет параметры телефона |
| [[#devices_elementdel|devices/element.del]] | Удаляет телефон |

----

==== devices/element.list ====
Получает список телефонов\\
\\
**Параметры запроса:**\\
Нет \\
\\
**Возврат**: Массив объектов в формате json
  * **elementId** - Идентификатор телефона
  * **elementName** - Название/описание телефона
  * **deviceUniqueId** - уникальный буквенноцифровой идентификатор. Подходит для использования в качестве логина
  * **userId** - Идентификатор сотрудника которому назначен данный телефон
  * **deviceType** - Тип телефона. На текущий момент поддерживается только 'SIP' - для телефонов работающий по протоколу sip и 'ALTEGROSIM' - сим карты от компании altegrosim
  * **deviceTypeId** - Уникальный идентификатор типа телефона 'deviceType'

----

==== devices/element.get ====
Получает параметры телефона\\
\\
**Параметры запроса:**
  * **elementId** - Идентификатор телефона
**Возврат**: Объект в формате json
  * **elementId** - Идентификатор телефона
  * **elementName** - Название/описание телефона
  * **deviceUniqueId** - уникальный буквенноцифровой идентификатор. Подходит для использования в качестве логина
  * **userId** - Идентификатор сотрудника которому назначен данный телефон
  * **deviceType** - Тип телефона. На текущий момент поддерживается только 'SIP' - для телефонов работающий по протоколу sip и 'ALTEGROSIM' - сим карты от компании altegrosim
  * **deviceTypeObject** - Объект типа телефона в формате json. 
**deviceTypeObjectдля SIP:**
    * **sipLogin** - Логин для подключения телефона и Внутреннее обозначение телефона в платформе asterisk
    * **sipPassword** - Пароль для подключения телефона
    * **sipPickupGroups** - группы перехвата в формате платформы asterisk, например: '1,2' - можно перехватывать группу 1 и 2
    * **sipCallGroups** - принадлежность группам перехвата, например '1,3' - входящий звонок на этот номер будет входить в группу 1 и 3
**deviceTypeObject для ALTEGROSIM:**
    * **altegrosimLogin** - Логин для подключения сим карты и Внутреннее обозначение сим карты в платформе asterisk
    * **altegrosimPassword** - Пароль для подключения сим карты
    * **altegrosimMobilePhone** - Мобильный номер сим карты

----

==== devices/element.add ====
Добавляет новый телефон\\
\\
**Параметры запроса:**
  * **elementName** - Название/описание телефона
  * **userId** - Идентификатор сотрудника которому будет назначен телефон
  * **deviceType** - Тип телефона
**дополнительные параметры для deviceType SIP:**
<note tip>Логин для sip создаётся АТС автоматически</note>
    * **sipPassword** - пароль для нового телефона
    * **sipPickupGroups** - Группы перехвата в формате платформы asterisk, например: '1,2' - можно перехватывать группу 1 и 2
    * **sipCallGroups** - принадлежность группам перехвата, например '1,3' - входящий звонок на этот номер будет входить в группу 1 и 3
**дополнительные параметры для deviceType ALTEGROSIM:**
<note tip>Логин для для сим карты создаётся АТС автоматически</note>
    * **altegrosimPassword** - пароль для регистрации сим карты
    * **altegrosimMobilePhone** - Мобильный номер сим карты
**Возврат**: Объект в формате json. Совпадает с возвратом [[#devices_elementget|devices/element.get]]

----

==== devices/element.edit ====
Изменяет параметры телефона\\
\\
**Параметры запроса:**
  * **elementId** - Идентификатор телефона для изменения
  * **elementName** - Название/описание телефона
  * **userId** - Идентификатор сотрудника которому будет назначен телефон
  * **deviceType** - Тип телефона
**дополнительные параметры для deviceType SIP:**
<note tip>Логин для sip создаётся АТС автоматически</note>
    * **sipPassword** - пароль для нового телефона
    * **sipPickupGroups** - Группы перехвата в формате платформы asterisk, например: '1,2' - можно перехватывать группу 1 и 2
    * **sipCallGroups** - принадлежность группам перехвата, например '1,3' - входящий звонок на этот номер будет входить в группу 1 и 3
**дополнительные параметры для deviceType ALTEGROSIM:**
<note tip>Логин для для сим карты создаётся АТС автоматически</note>
    * **altegrosimPassword** - пароль для регистрации сим карты
    * **altegrosimMobilePhone** - Мобильный номер сим карты
**Возврат**: Объект в формате json. Совпадает с возвратом [[#users_deviceget|users/device.get]]

----

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