# API Документация ### **Описание** В данном документе описаны API-методы для взаимодействия с домофонной панелью Сокол (rev.2) через http-запросы.
На устройстве по умолчанию 2 виртуальных сетевых интерфейса: - Динамический; - Статический ([**192.168.0.100**](http://192.168.0.100:80/)). Метод для настройки сетевых интерфейсов: **[/v1/network](#bkmrk-%2Fv1%2Fnetwork)**
Данные для авторизации по умолчанию: - логин: **root** - пароль: **123456** Метод для смены пароля по умолчанию: **[/user/change\_password](#bkmrk-%2Fuser%2Fchange_passwor)**
--- ### **Обязательные заголовки**Некоторые методы могут иметь другое значение для указанных заголовков или новые заголовки.
#### **Запрос****Наименование** | **Значение** | **Описание** |
**GET, PUT, POST, DELETE** | ||
Authorization | Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
**PUT, POST, DELETE** | ||
Content-Type | application/json | Тип передаваемых данных |
Content-Length | 0 | Размер передаваемых данных |
**Наименование** | **Значение** | **Описание** |
Authorization | Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Content-Type | application/json | Тип возвращаемых данных |
Content-Length | 0 | Размер возвращаемых данных |
X-Device-Mac | 08:13:00:00:00:00 | Мак адрес устройства |
**Наименование** | **Значение** |
Успешные | - 200 OK;
- 201 OK;
- 204 OK.
|
Пользовательские | - 400 Bad Request;
- 404 Not Found;
- 405 Method Not Allowed;
- 422 Unprocessable Entity.
|
Серверные | - 500 Internal Server Error;
- 501 Not Implemented.
|
Авторизация пройдена
**Заголовки:****Наименование** | **Значение** | **Описание** |
Content-Type | text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
- Не корректно передан заголовок **Authorization** - Используются не корректные данные **логин** или **пароль**
**Заголовки:****Наименование** | **Значение** | **Описание** |
WWW-Authenticate | Basic realm="Access to camofon", charset="UTF-8" | Заголовок обязательной авторизации |
Content-Type | text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
**Название** | **Тип** | **Описание** |
newPassword | String | Новый пароль для указанного пользователя в заголовке авторизации. \- По умолчанию: 123456 |
Успешная смена пароля
**Заголовки:****Название** | **Значение** | **Описание** |
Content-Type | text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
Ошибка проверки переданных параметров
**Тело:****Название** | **Тип** | **Описание** |
errors | Array | Массив возвращаемых ошибок. |
field | String | Название переменной к которой относиться ошибка. |
message | String | Сообщение об ошибки для переменной из поля "field". |
**Название** | **Тип** | **Описание** |
port | Integer | Порт для работы HTTP-сервера. \- По умолчанию: 80 |
Успешное получение данных
**Тело:** ```json { "port": 80 } ```Успешное изменение параметров
**Тело:** ```json { "port": 80 } ```Ошибка проверки переданных параметров
**Тело:****Название** | **Тип** | **Описание** |
errors | Array | Массив возвращаемых ошибок. |
message | String | Сообщение с ошибкой. |
**Название** | **Тип** | **Описание** |
enabled | Boolean | Флаг включения / отключения DDNS клиента. \- По умолчанию: false |
interval | Integer | Интервал отправки http запросов на сервер. \- По умолчанию: 300 |
server | Object | Параметры подключения к сервере |
port | Integer | Порт сервера для отправки запросов. \- По умолчанию: 8081 |
address | String | Адрес сервера для отправки запросов. \- По умолчанию: 10.199.63.7 |
username | String | Логин для авторизации. \- По молчанию: default |
password | String | Пароль для авторизации. \- По молчанию: default |
data | Object | Отправляемые данные. |
hostname | String | Передаваемый тип устройства. \- По умолчанию: ddns.ISCom |
Успешное получение параметров
**Тело:** ```json { "enabled": true, "interval": 300, "server": { "port": 8081, "address": "10.199.63.7", "username": "default", "password": "default" }, "data": { "hostname": "ddns.ISCom" } } ```Успешное изменение параметров
**Тело:** ```json { "enabled": true, "interval": 300, "server": { "port": 8081, "address": "10.199.63.7", "username": "default", "password": "default" }, "data": { "hostname": "ddns.ISCom" } } ```Успешный сброс параметров к стандартным
**Тело:** ```json { "enabled": true, "interval": 300, "server": { "port": 8081, "address": "10.199.63.7", "username": "default", "password": "default" }, "data": { "hostname": "ddns.ISCom" } } ```**Название** | **Тип** | **Описание** |
md\_enable | Boolean | Флаг включения / отключения детектора движения. \- По умолчанию: false |
md\_area\_thr | Integer | Минимальный размер детектируемой области. Для людей на близком расстоянии примерно 100000 пикселей. \- По умолчанию: 30000 пикселей |
md\_send\_snapshot\_enable | Boolean | Флаг включения / отключения отправки картинок на сервер указанный в параметре "snap\_send\_url". \- По умолчанию: false |
md\_send\_snapshot\_interval | Integer | Интервал в секундах между отправкой картинок на сервер. \- Ограничение: 1 - 20 секунд \- По умолчанию: 1 секунда **ВАЖНО!** Будет отправлена одна картинка, даже если за этот период было задетектировано больше движений. |
md\_rects\_enable | Boolean | Флаг включения / отключения отображения рамок детектора. \- По умолчанию: false |
md\_logs\_enable | Boolean | Флаг включения / отключения отправки событий детектора в логи. \- По умолчанию: false |
md\_rect\_color | String | Цвет отображающихся рамок детектора. \- По умолчанию: 0xFF0000 |
md\_frame\_int | Integer | Интервал между кадрами, отправляемыми на поиск движения. \- По умолчанию: 30 кадров |
md\_frame\_shift | Integer | Смещение второго кадра, участвующего в определении детекции. \- По умолчанию: 1 кадр |
md\_max\_rect\_ratio | Double | Максимальное соотношение длина / ширина прямоугольника для отображения. \- По умолчанию: 8.0 |
snap\_send\_url | String | HTTP адрес на который будут отправляться картинки детектора. \- По умолчанию: "" |
При использовании удаленного HTTP-сервера детекции (**snap\_send\_url**).
Данные формата **application/json** отправляются на **HTTP-сервер** с помощью **POST** метода.**Название** | **Тип** | **Описание** |
time | String | Дата и время в формате "%y-%m-%d %H:%M:%S". |
df\_id | String | Мак адрес устройства без символов двоеточия. |
img\_bytes | String | Представление картинки в base64 строке. |
Успешное получение параметров
**Тело:** ```json { "md_enable": false, "md_area_thr": 30000, "md_send_snapshot_enable": false, "md_send_snapshot_interval": 1, "md_rects_enable": false, "md_logs_enable": false, "md_rect_color": "0xFF0000", "md_frame_int": 30, "md_frame_shift": 1, "md_max_rect_ratio": 8.0, "snap_send_url": "" } ```Успешное получение параметров
**Тело:** ```json { "md_enable": false, "md_area_thr": 30000, "md_send_snapshot_enable": false, "md_send_snapshot_interval": 1, "md_rects_enable": false, "md_logs_enable": false, "md_rect_color": "0xFF0000", "md_frame_int": 30, "md_frame_shift": 1, "md_max_rect_ratio": 8.0, "snap_send_url": "" } ```**Название** | **Тип** | **Описание** |
aac\_enable | Boolean | Флаг включения / отключения кодирования звука в AAC. \- По умолчанию: false (звук в PCMU) |
format | String | Формат кодирования звука. \- По умолчанию: AAC \- Поддерживаемые варианты: \- AAC; \- PCM; \- PCMA (G.711A); \- PCMU (G.711U); |
Успешное получение параметров
**Тело:** ```json { "aac_enable": true, "format": "AAC" } ```Успешное изменение параметров
**Тело:** ```json { "aac_enable": true, "format": "AAC" } ```**Название** | **Тип** | **Описание** |
Channels | Array | Массив видео потоков. |
Channel | Integer | Номер видео потока. |
Type | String | Тип кодека видео. |
Profile | Integer | Профиль кодека. \- По умолчанию: 1 (Main) \- Поддерживаемые варианты: \- 1 - Main; \- 2 - Baseline; \- 3 - High; |
ByFrame | Boolean | |
Width / Height | Integer | Разрешение видео потока. \- Поддерживаемые варианты: \- 1920х1080 (**основной поток**); \- 1280х720; \- 720х576; \- 704х576; \- 640х480; \- 640х360. |
GopMode | String | |
IPQpDelta | Integer | |
RcMode | String | Режим управления кодированием. \- По умолчанию: AVBR |
IFrameInterval | Integer | Интервал опорного кадра (кадр/сек). \- По умолчанию: 30 |
MaxBitrate | Integer | Максимальный битрейт видеопотока (Кбит/сек). |
Успешное получение параметров
**Тело:** ```json { "Channels": [ { "Channel": 0, "Type": "H264", "Profile": 1, "ByFrame": true, "Width": 1280, "Height": 720, "GopMode": "NormalP", "IPQpDelta": 2, "RcMode": "AVBR", "IFrameInterval": 30, "MaxBitrate": 3072 }, { "Channel": 1, "Type": "H264", "Profile": 1, "ByFrame": true, "Width": 640, "Height": 480, "GopMode": "NormalP", "IPQpDelta": 2, "RcMode": "AVBR", "IFrameInterval": 30, "MaxBitrate": 1536 } ] } ```Успешное получение параметров
**Тело:** ```json { "Channels": [ { "Channel": 0, "Type": "H264", "Profile": 1, "ByFrame": true, "Width": 1280, "Height": 720, "GopMode": "NormalP", "IPQpDelta": 2, "RcMode": "AVBR", "IFrameInterval": 30, "MaxBitrate": 3072 }, { "Channel": 1, "Type": "H264", "Profile": 1, "ByFrame": true, "Width": 640, "Height": 480, "GopMode": "NormalP", "IPQpDelta": 2, "RcMode": "AVBR", "IFrameInterval": 30, "MaxBitrate": 1536 } ] } ```**Название** | **Тип** | **Описание** |
Image | Object | Параметры отражения картинки по вертикали и по горизонтали. |
Flip | Boolean | Отражение картинки по вертикали. \- По умолчанию: false |
Mirror | Boolean | Отражение картинки по горизонтали. \- По умолчанию: false |
Успешное получение параметров
**Тело:** ```json { "Image": { "Flip": false, "Mirror": false } } ```Успешное изменение параметров
**Тело:** ```json { "Image": { "Flip": false, "Mirror": false } } ```Размер картинки зависит от размера основного видеопотока Для смены размера картинки видеопотока используйте: [**/camera/codec**](#bkmrk-%2Fcamera%2Fcodec)
**Название** | **Значение** | **Описание** |
Content-Type | image/jpeg | Тип возвращаемых данных |
- **Для перехода потока в цветной режим:** необходимо значение "exposureCurrent" менее "exposureLight" - **Для перехода потока в черно-белый режим:** необходимо значение "exposureCurrent" более "exposureNight"
**Название** | **Тип** | **Описание** |
state | Boolean | Текущее состояние черно-белого режима. |
threshold | Object | Пороги переключения черно-белого режима. |
exposureCurrent | Integer | Текущее значение экспозиции сенсора. |
exposureLight | Integer | Порог включение цветного режима. \- Ограничения: 0 - 4294967295 \- По умолчанию: 22000 |
exposureNight | Integer | Порог включения черно-белого режима. \- Ограничения: 0 - 4294967295 \- По умолчанию: 250000 |
Успешное получение данных
**Тело:** ```json { "state": false, "threshold": { "exposureCurrent": 100000, "exposureLight": 22000, "exposureNight": 250000 } } ```Успешное изменение параметров
**Тело:** ```json { "state": false, "threshold": { "exposureCurrent": 100000, "exposureLight": 22000, "exposureNight": 250000 } } ```Ошибка проверки переданных параметров
**Тело:****Название** | **Тип** | **Описание** |
errors | Array | Массив возвращаемых ошибок. |
message | String | Сообщение об ошибке. |
Видео поток поддерживает отображение до 3-х строк.
**Название** | **Тип** | **Описание** |
size | Integer | Размер отображаемой информации. |
text | String | Отображаемый текст. \- Длина строки: 0 - 100 символов |
color | String | Цвет osd в hex. |
date | Object | Параметры отображения даты. |
enable | Boolean | Флаг включения / отключения отображения даты. |
format | String | Формат отображаемой даты ([форматы](https://www.tutorialspoint.com/c_standard_library/c_function_strftime.htm)). |
time | Object | Параметры отображения времени. |
enable | Boolean | Флаг включения / отключения отображения времени. |
format | String | Формат отображаемового времени ([форматы](https://www.tutorialspoint.com/c_standard_library/c_function_strftime.htm)). |
position | Object | Параметры смещения текста. |
x | Integer | Смещение по оси "X" (пиксели). |
y | Integer | Смещение по оси "Y" (пиксели). |
background | Object | Параметры отображения фона. |
enable | Boolean | Флаг включения / отключения фона. |
color | String | Цвет фона в hex. |
Успешное получение параметров
**Тело:** ```json [ { "size": 2, "text": "", "color": "0xFFFFFF", "date": { "enable": true, "format": "%d-%m-%Y" }, "time": { "enable": true, "format": "%H:%M:%S" }, "position": { "x": 2, "y": 10 }, "background": { "enable": false, "color": "0x0053DE" } }, ..., { "size": 1, "text": "", "color": "0xFFFFFF", "date": { "enable": false, "format": "" }, "time": { "enable": false, "format": "" }, "position": { "x": 140, "y": 0 }, "background": { "enable": false, "color": "0xFFFFFF" } } ] ```Успешное изменение параметров
**Тело:** ```json [ { "size": 1, "text": "Строка 1", "color": "0xFFFFFF", "date": { "enable": false, "format": "%d-%m-%Y" }, "time": { "enable": false, "format": "%H:%M:%S" }, "position": { "x": 10, "y": 10 }, "background": { "enable": false, "color": "0x0053DE" } }, { "size": 2, "text": "Строка 2", "color": "0xFFFFFF", "date": { "enable": false, "format": "" }, "time": { "enable": false, "format": "" }, "position": { "x": 10, "y": 30 }, "background": { "enable": false, "color": "0x000000" } }, { "size": 3, "text": "Строка 3", "color": "0xFFFFFF", "date": { "enable": false, "format": "" }, "time": { "enable": false, "format": "" }, "position": { "x": 10, "y": 60 }, "background": { "enable": false, "color": "0xFFFFFF" } } ] ```Ошибка проверки переданных параметров
**Тело:****Название** | **Тип** | **Описание** |
errors | Array | Массив возвращаемых ошибок. |
message | String | Сообщение с ошибкой. |
**Название** | **Тип** | **Описание** |
u8Contr | Integer | Контрастность изображения. \- По умолчанию: 50 **ВАЖНО!** \- При значении больше 50-ти - контрастность увеличена. \- При значении меньше 50-ти - контрастность уменьшена. |
u8Luma | Integer | Яркость изображения. \- По умолчанию: 50 **ВАЖНО!** \- При значении больше 50-ти - яркость увеличена. \- При значении меньше 50-ти - яркость уменьшена. |
u8Satu | Integer | Насыщенность изображения. \- По умолчанию: 50 **ВАЖНО!** \- При значении больше 50-ти - насыщенность увеличена. \- При значении меньше 50-ти - насыщенность уменьшена. |
u8Hue | Integer | Регулировка оттенка изображения. \- По умолчанию: 50 **ВАЖНО!** \- При значении больше 50-ти - регулировка изменяется по часовой стрелке: красный имеет синий оттенок, синий имеет зеленый оттенок. \- При значении меньше 50-ти - регулировакаи изменяется против часовой стрелки: синий имеет красный оттенок, красный имеет зеленый оттенок. |
wb | Object | Параметры баланса белого |
u8RGStrength | Integer | |
u8BGStrength | Integer | |
dehaze | Object | Параметры устранения дымки. |
u8strength | Integer | Интенсивность устранения дымки. **ВАЖНО!** Чем больше значение, тем больше устранение дымки (влияет на контрастность изображения). |
drc | Object | Параметры регулирования динамического диапазона. Соотношение яркости между самым ярким и самым темным объектом. |
u16Strength | Integer | Интенсивность. \- По умолчанию: **ВАЖНО!** Чем больше значение, тем ярче общее изображение. |
u16StrengthMax | Integer | Граница светлого. \- По умолчанию: **ВАЖНО!** Чем больше значение, тем больше ярких областей распознается. |
u16StrengthMin | Integer | Граница темного. \- По умолчанию: **ВАЖНО!** Чем больше значение, тем меньше темных областей распознается. |
iso | Object | |
index | Integer | |
params | Object | |
0-15 | Object | |
sharpness | Object | |
au16TextureFreq | Integer | |
au16EdgeFreq | Integer | |
au8OverShoot | Integer | |
au8UnderShoot | Integer | |
au8DetailCtrl | Integer | |
au8RGain | Integer | |
au8GGain | Integer | |
au8BGain | Integer | |
au8SkinGain | Integer | |
au16MaxSharpGain | Integer |
Успешное получение параметров
**Тело:** ```json { "u8Contr": 42, "u8Luma": 52, "u8Satu": 52, "u8Hue": 50, "wb": { "u8RGStrength": 128, "u8BGStrength": 128 }, "dehaze": { "u8strength": 125 }, "drc": { "u16Strength": 100, "u16StrengthMax": 127, "u16StrengthMin": 0 }, "iso": { "index": 2, "params": { "0": { "sharpness": { "au16TextureFreq": 183, "au16EdgeFreq": 0, "au8OverShoot": 13, "au8UnderShoot": 58, "au8DetailCtrl": 139, "au8RGain": 28, "au8GGain": 31, "au8BGain": 28, "au8SkinGain": 25, "au16MaxSharpGain": 63 } }, ..., "15": { "sharpness": { "au16TextureFreq": 170, "au16EdgeFreq": 96, "au8OverShoot": 10, "au8UnderShoot": 15, "au8DetailCtrl": 120, "au8RGain": 31, "au8GGain": 31, "au8BGain": 31, "au8SkinGain": 31, "au16MaxSharpGain": 80 } } } } } ```Успешное изменение параметров
**Тело:** ```json { "u8Contr": 42, "u8Luma": 52, "u8Satu": 52, "u8Hue": 50, "wb": { "u8RGStrength": 128, "u8BGStrength": 128 }, "dehaze": { "u8strength": 125 }, "drc": { "u16Strength": 100, "u16StrengthMax": 127, "u16StrengthMin": 0 }, "iso": { "index": 2, "params": { "0": { "sharpness": { "au16TextureFreq": 183, "au16EdgeFreq": 0, "au8OverShoot": 13, "au8UnderShoot": 58, "au8DetailCtrl": 139, "au8RGain": 28, "au8GGain": 31, "au8BGain": 28, "au8SkinGain": 25, "au16MaxSharpGain": 63 } }, ..., "15": { "sharpness": { "au16TextureFreq": 170, "au16EdgeFreq": 96, "au8OverShoot": 10, "au8UnderShoot": 15, "au8DetailCtrl": 120, "au8RGain": 31, "au8GGain": 31, "au8BGain": 31, "au8SkinGain": 31, "au16MaxSharpGain": 80 } } } } } ```Видео поток поддерживает отображение до 3-х строк.
**Название** | **Тип** | **Описание** |
size | Integer | Размер отображаемой информации. |
text | String | Отображаемый текст. \- Длина строки: 0 - 100 символов |
color | String | Цвет osd в hex. |
date | Object | Параметры отображения даты. |
enable | Boolean | Флаг включения / отключения отображения даты. |
format | String | Формат отображаемой даты ([форматы](https://www.tutorialspoint.com/c_standard_library/c_function_strftime.htm)). |
time | Object | Параметры отображения времени. |
enable | Boolean | Флаг включения / отключения отображения времени. |
format | String | Формат отображаемового времени ([форматы](https://www.tutorialspoint.com/c_standard_library/c_function_strftime.htm)). |
position | Object | Параметры смещения текста. |
x | Integer | Смещение по оси "X" в процентном соотношении. |
y | Integer | Смещение по оси "Y" в процентном соотношении. |
background | Object | Параметры отображения фона. |
enable | Boolean | Флаг включения / отключения фона. |
color | String | Цвет фона в hex. |
Успешное получение параметров
**Тело:** ```json [ { "size": 2, "text": "", "color": "0xFFFFFF", "date": { "enable": true, "format": "%d-%m-%Y" }, "time": { "enable": true, "format": "%H:%M:%S" }, "position": { "x": 2, "y": 10 }, "background": { "enable": false, "color": "0x0053DE" } }, ..., { "size": 1, "text": "", "color": "0xFFFFFF", "date": { "enable": false, "format": "" }, "time": { "enable": false, "format": "" }, "position": { "x": 140, "y": 0 }, "background": { "enable": false, "color": "0xFFFFFF" } } ] ```Успешное изменение параметров
**Тело:** ```json [ { "size": 1, "text": "Строка 1", "color": "0xFFFFFF", "date": { "enable": false, "format": "%d-%m-%Y" }, "time": { "enable": false, "format": "%H:%M:%S" }, "position": { "x": 10, "y": 10 }, "background": { "enable": false, "color": "0x0053DE" } }, ..., { "size": 3, "text": "Строка 3", "color": "0xFFFFFF", "date": { "enable": false, "format": "" }, "time": { "enable": false, "format": "" }, "position": { "x": 10, "y": 60 }, "background": { "enable": false, "color": "0xFFFFFF" } } ] ```Ошибка проверки переданных параметров
**Тело:****Название** | **Тип** | **Описание** |
errors | Array | Массив возвращаемых ошибок. |
message | String | Сообщение с ошибкой. |
**Название** | **Тип** | **Описание** |
code | Integer | Идентификатор "Кода доступа". |
panelCode | Integer | Номер квартиры к которой привязан "Код доступа". |
Успешное добавление кода
**Тело:** ```json [ { "code": 12345, "panelCode": 0 } ] ```**Название** | **Тип** | **Описание** |
errors | Array | Массив возвращаемых ошибок. |
field | String | Название переменной к которой относиться ошибка. |
message | String | Сообщение об ошибки для поля "field". |
Успешное удаление кодов
Ошибка при отсутствии кодов на панели
**Тело:****Название** | **Тип** | **Описание** |
errors | Array | Массив возвращаемых ошибок. |
messgae | String | Сообщение об ошибке. |
**Название** | **Тип** | **Описание** |
code | Integer | Идентификатор "Кода доступа". |
panelCode | Integer | Номер квартиры к которой привязан "Код доступа". |
Успешное получение кодов
**Тело:** ```json [ { "code": 12345, "panelCode": 0 } ] ```Ошибка при указании не верного номера квартиры
**Тело:****Название** | **Тип** | **Описание** |
errors | Integer | Массив возвращаемых ошибок. |
message | String | Сообщение об ошибке. |
Успешное удаление кодов для указанной квартиры
Ошибка при удалении не существующих кодов для указанной квартиры
**Тело:****Название** | **Тип** | **Описание** |
errors | Array | Массив возвращаемых ошибок. |
message | String | Сообщение об ошибке. |
Успешное удаление кода
Ошибка при удалении не существующего кода для указанной квартиры
**Тело:****Название** | **Тип** | **Описание** |
errors | Object | Массив возвращаемых ошибок. |
message | String | Сообщение об ошибке. |
**Название** | **Тип** | **Описание** |
mode | Integer | Режим работы базы данных с ключами 4 или 7 байт. 1 - режим 4 байта; 2 - режим 7 байт; \- Ограничения: 1 - 2 \- По умолчанию: 1 **ВАЖНО:** При переключении режимов из базы данных будут удалены все ключи и вся информация о прошитых секторах. |
autocollect | Object | Параметры режима автосбора ключей. |
enabled | Boolean | Флаг включения / выключения режима. \- По умолчанию: false |
room | Integer | Номер квартиры к которой будут привязаны приложенные ключи. \- По умолчанию: 0 |
encryption | Object | Параметры проверки шифрованных ключей. |
enabled | Boolean | Флаг включения / выключения режима. \- По умолчанию: false |
key\_type | String | Тип ключа для авторизации в сектор ключа. \- Ограничения: A, B \- По умолчанию: A |
key\_auth | String | Значение ключа для авторизации в сектор ключа. \- Длина строки: 12 символов (16-ой системе) \- По умолчанию: FFFFFFFFFFFF |
sector | Integer | Сектор, который будет проверяться на шифрование. \- Ограничения: 0 - 15 \- По умолчанию: 0 |
increment | Object | Параметры инкрементирования значения в указанном блоке сектора. |
enabled | Boolean | Флаг включения / выключения режима. \- По умолчанию: false |
block | Integer | Блок в котором будет увеличиваться значение инкремента. \- Ограничения: 0 - 2 \- По умолчанию: 0 |
openByError | Boolean | Флаг открытия двери при ошибке инкремента. \- По умолчанию: false |
kb\_codes | Boolean | Флаг включения / выключения сервисных кодов. \- По умолчанию: true **ВАЖНО!** При использовании панели в продуктивной среде на постоянной основе **НЕОБХОДИМО** выключать сервисные коды. |
Успешное получение параметров
**Тело:** ```json { "mode": 1, "autocollect": { "enabled": false, "room": 0 }, "encryption": { "enabled": false, "key_type": "A", "key_auth": "FFFFFFFFFFFF", "sector": 0, "increment": { "enabled": true, "block": 0, "openByError": true } }, "kb_codes": false } ```Успешное получение параметров
**Тело:** ```json { "mode": 1, "autocollect": { "enabled": false, "room": 0 }, "encryption": { "enabled": false, "key_type": "A", "key_auth": "FFFFFFFFFFFF", "sector": 0, "increment": { "enabled": true, "block": 0, "openByError": true } }, "kb_codes": false } ```Ошибка проверки передаваемых данных
**Тело:****Название** | **Тип** | **Описание** |
errors | Array | Массив возвращаемых ошибок. |
message | String | Сообщение об ошибке. |
**Название** | **Тип** | **Описание** |
uuid | String | Идентификатор ключа. |
panelCode | Integer | Номер квартиры к которой привязан ключ. |
encryption | Boolean | Флаг включения / выключения персональной проверки шифрования. **ВАЖНО!** Работает при включенном общем параметре "Проверка шифрования". |
Успешное получение списка ключей
**Тело:** ```json [ { "uuid": "000000AABBCCDD", "panelCode": 0, "encryption": true }, { "uuid": "000000BBCCDDEE", "panelCode": 1, "encryption": true }, { "uuid": "000000CCDDEEFF", "panelCode": 2, "encryption": true } ] ```Успешное добавление ключа
**Тело:** ```json { "uuid": "000000AABBCCDD", "panelCode": 0, "encryption": true } ```Успешное удаление ключей
**Название** | **Тип** | **Описание** |
uuid | String | Идентификатор ключа. |
panelCode | Integer | Номер квартиры к которой привязан ключ. |
encryption | Boolean | Флаг включения / выключения персональной проверки шифрования. **ВАЖНО!** Работает при включенном общем параметре "Проверка шифрования". |
Успешное изменение ключей
**Тело:** ```json [ { "uuid": "000000AABBCCDD", "panelCode": 0, "encryption": true }, { "uuid": "000000BBCCDDEE", "panelCode": 0, "encryption": true } ] ```**Название** | **Тип** | **Описание** |
uuid | String | Идентификатор ключа. |
panelCode | Integer | Номер квартиры к которой привязан ключ. |
encryption | Boolean | Флаг включения / выключения персональной проверки шифрования. **ВАЖНО!** Работает при включенном общем параметре "Проверка шифрования". |
Успешное получение параметров
**Тело:** ```json { "uuid": "000000AABBCCDD", "panelCode": 0, "encryption": true } ```Успешное изменение параметров
**Тело:** ```json { "uuid": "000000AABBCCDD", "panelCode": 0, "encryption": true } ```Успешное удаление ключа
**Название** | **Тип** | **Описание** |
enabled | Boolean | Флаг включения / выключения прошивки ключей. \- По умолчанию: false |
numSectors | Integer | Количество прошиваемых секторов за раз в момент удержания ключа. \- Ограничения: 1 - 16 \- По умолчанию: 16 |
markup | Object | Разметка для прошивки Mifare ключей по протоколу SL1. |
0 - 15 | String | Поддерживаемые сектора для прошивки в ключах. |
skip | Object | Параметры пропуска указанного сектора. |
err | Boolean | Пропуск сектора при ошибке во время прошивки. \- По умолчанию: false |
always | Boolean | Пропуск сектора при любых действиях. \- По умолчанию: false |
key | Object | Параметры авторизации в сектор ключа. |
type | String | Тип ключа для авторизации в сектор ключа. \- Ограничения: A, B \- По умолчанию: A |
value | String | Значение ключа для авторизации в сектор ключа. \- Длина строки: 12 символов (16-ой системе) \- По умолчанию: FFFFFFFFFFFF |
0 - 3 | String | Блоки для указания различной информации. **ВАЖНО!** Блок под номером 3 является управляющим блоком. Настоятельно рекомендуем ознакомиться с возможными данными для указания в данный блок. |
Успешное получение параметров
**Тело:** ```json { "enable": false, "numSectors": 16, "markup": { "0": { "skip": { "err": true, "always": true }, "key": { "type": "A", "value": "FFFFFFFFFFFF" }, "3": null, "2": null, "1": null, "0": null }, ..., "15": { "skip": { "err": true, "always": true }, "key": { "type": "A", "value": "FFFFFFFFFFFF" }, "3": null, "2": null, "1": null, "0": null } } } ```Успешное изменение параметров
**Тело:** ```json { "enable": false, "numSectors": 16, "markup": { "0": { "skip": { "err": true, "always": true }, "key": { "type": "A", "value": "FFFFFFFFFFFF" }, "3": null, "2": null, "1": null, "0": null }, ..., "15": { "skip": { "err": true, "always": true }, "key": { "type": "A", "value": "FFFFFFFFFFFF" }, "3": null, "2": null, "1": null, "0": null } } } ```Успешный сброс параметров
**Название** | **Тип** | **Описание** |
panelCode | Integer | Номер квартиры. |
callsEnabled | Object | Параметры разрешения вызовов в АТ и SIP. |
sip | Boolean | Флаг включения / выключения вызовов в SIP. \- По умолчанию: true |
handset | Boolean | Флаг включения / выключения вызовов в АТ. \- По умолчанию: true |
soundOpenTh | Boolean | Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире. |
typeSound | Integer | Режимы эхоподавления при вызове в АТ. \- Ограничения: 0, 1, 2, 3 - 0, 1, 2 - варианты эхоподавления; \- 3 - общие настройки. \- По умолчанию: 3 |
volumes | Object | Персональные громкости при вызове в квартиру. **Важно!** Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
thCall | Integer | Громкость мелодии трубки во время вызова в АТ. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
thTalk | Integer | Громкость в трубке во время разговора по АТ. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
uartFrom | Integer | Громкость на панели во время разговора по SIP. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
uartTo | Integer | Усиление микрофона панели во время разговора по SIP. \- Ограничения: 0 - 254, 255 или null - По умолчанию: null |
panelCall | Integer | Системные звуки панели. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
panelTalk | Integer | Громкость на панели во время разговора по АТ. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
resistances | Object | Параметры сопротивления трубки для смены состояний. **Важно!** Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
quiescent | Integer | Уровень поднятия трубки. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
answer | Integer | Уровень открытия двери. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
Успешное получение квартир
**Тело:** ```json [ { "panelCode": 1, "callsEnabled": { "sip": true, "handset": true }, "soundOpenTh": null, "typeSound": 3, "volumes": { "thCall": null, "thTalk": null, "uartFrom": null, "uartTo": null, "panelCall": null, "panelTalk": null }, "resistances": { "quiescent": null, "answer": null } }, ..., { "panelCode": 100, "callsEnabled": { "sip": true, "handset": true }, "soundOpenTh": null, "typeSound": 3, "volumes": { "thCall": null, "thTalk": null, "uartFrom": null, "uartTo": null, "panelCall": null, "panelTalk": null }, "resistances": { "quiescent": null, "answer": null }, "sipAccounts": [ "1" [ } ] ```Успешное добавление квартиры
**Тело:** ```json { "panelCode": 1, "callsEnabled": { "sip": false, "handset": true }, "soundOpenTh": null, "typeSound": 3, "volumes": { "thCall": null, "thTalk": null, "uartFrom": null, "uartTo": null, "panelCall": null, "panelTalk": null }, "resistances": { "quiescent": null, "answer": null } } ```Ошибка при добавлении существующей квартиры
**Тело:****Название** | **Тип** | **Описание** |
errors | Array | Массив возвращаемых ошибок. |
field | String | Название переменной к которой относиться ошибка. |
message | String | Сообщение об ошибки для переменной из поля "field". |
Успешное удаление квартир
**Название** | **Тип** | **Описание** |
consiergeRoom | String | "Номер квартиры" или "SIP аккаунт" на который будет вызов при нажатии на кнопку "Консьерж". \- По умолчанию: 999 |
sosRoom | String | "Номер квартиры" или "SIP аккаунт" на который будет вызов при нажатии на кнопку "SOS". \- По умолчанию: "" |
sosDelay | Boolean | Флаг включения / выключения задержки при нажатии кнопки "SOS". \- По умолчанию: true |
sosDelayTime | Integer | Время которое необходимо удерживать кнопку "SOS" для совершения вызова. \- Ограничения: 1 - 10 секунд \- По умолчанию: 3 секунды - Для установления значения по умолчанию также можно записать 0 или 255 |
sosType | Boolean | Тип отображаемой строки при удержании кнопки "SOS". \- true - "112"; \- false - "SOS". \- По умолчанию: true |
soundOpenPanel | Boolean | Флаг включения / выключения звуков открытия и ошибок при прикладывании ключа. \- По умолчанию: true |
soundOpenTh | Boolean | Флаг включения / выключения звуков открытия при прикладывании ключа привязанного к квартире. \- По умолчанию: false |
typeSound | Integer | Общий тип эхоподавления используемый для персональных настроек квартир со значением "255" или "null". \- Ограничение: 0, 1, 3 \- По умолчанию: 3 |
Успешное получение параметров
**Тело:** ```json { "consiergeRoom": "999", "sosRoom": "", "sosDelay": true, "soundOpenPanel": true, "soundOpenTh": false, "typeSound": 3, "sosType": true, "sosDelayTime": 255 } ```Успешное изменение параметров
**Тело:** ```json { "consiergeRoom": "999", "sosRoom": "", "sosDelay": true, "soundOpenPanel": true, "soundOpenTh": false, "typeSound": 3, "sosType": true, "sosDelayTime": 255 } ```**Название** | **Тип** | **Описание** |
1 - 5 | Object | Номер квартиры к которой относятся данные. |
resist | Integer | Значение сопротивления измеренное панелью. \- Ограничения: 0 - 255 |
status | String | Положение трубки полученное из ограничений общих параметров "quiesence" и "answer" \- Ограничения: \- down - положенная трубка (зеленый); \- up - поднятая трубка (желтый); \- error - ошибка при замере (красный). |
error | String | Сообщение ошибки при значении "error" в параметре "status". |
Успешное получение замеров
**Тело:** ```json { "1": { "resist": 75, "status": "down" }, "2": { "resist": 190, "status": "up" }, "3": { "resist": 0, "status": "error", "error": "Обрыв трубки, кв. 3" }, "4": { "resist": 0, "status": "error", "error": "Обрыв трубки, кв. 4" }, "5": { "resist": 0, "status": "error", "error": "Обрыв трубки, кв. 5" } } ```**Название** | **Тип** | **Описание** |
panelCode | Integer | Номер квартиры. |
callsEnabled | Object | Параметры разрешения вызовов в АТ и SIP. |
sip | Boolean | Флаг включения / выключения вызовов в SIP. \- По умолчанию: true |
handset | Boolean | Флаг включения / выключения вызовов в АТ. \- По умолчанию: true |
soundOpenTh | Boolean | Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире. |
typeSound | Integer | Режимы эхоподавления при вызове в АТ. \- Ограничения: 0, 1, 3 \- По умолчанию: 3 |
volumes | Object | Персональные громкости при вызове в квартиру. **Важно!** Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
thCall | Integer | Громкость мелодии трубки во время вызова в АТ. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
thTalk | Integer | Громкость в трубке во время разговора по АТ. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
uartFrom | Integer | Громкость на панели во время разговора по SIP. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
uartTo | Integer | Усиление микрофона панели во время разговора по SIP. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
panelCall | Integer | Системные звуки панели. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
panelTalk | Integer | Громкость на панели во время разговора по АТ. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
resistances | Object | Параметры сопротивления трубки для смены состояний. **Важно!** Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
quiescent | Integer | Уровень поднятия трубки. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
answer | Integer | Уровень открытия двери. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
Успешное получение параметров
**Тело:** ```json { "panelCode": 1, "callsEnabled": { "sip": true, "handset": true }, "soundOpenTh": null, "typeSound": 3, "volumes": { "thCall": null, "thTalk": null, "uartFrom": null, "uartTo": null, "panelCall": null, "panelTalk": null }, "resistances": { "quiescent": null, "answer": null } } ```Успешное изменение параметров
**Тело:** ```json { "panelCode": 1, "callsEnabled": { "sip": true, "handset": true }, "soundOpenTh": null, "typeSound": 3, "volumes": { "thCall": null, "thTalk": null, "uartFrom": null, "uartTo": null, "panelCall": null, "panelTalk": null }, "resistances": { "quiescent": null, "answer": null } } ```Успешное удаление квартиры
**Название** | **Тип** | **Описание** |
volumes | Object | Персональные громкости при вызове в квартиру. **Важно!** Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
thCall | Integer | Громкость мелодии трубки во время вызова в АТ. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
thTalk | Integer | Громкость в трубке во время разговора по АТ. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
uartFrom | Integer | Громкость на панели во время разговора по SIP. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
uartTo | Integer | Усиление микрофона панели во время разговора по SIP. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
panelCall | Integer | Системные звуки панели. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
panelTalk | Integer | Громкость на панели во время разговора по АТ. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
resistances | Object | Параметры сопротивления трубки для смены состояний. **Важно!** Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
quiescent | Integer | Уровень поднятия трубки. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
answer | Integer | Уровень открытия двери. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
Успешное получение параметров
**Тело:** ```json { "volumes": { "thCall": null, "thTalk": null, "uartFrom": null, "uartTo": null, "panelCall": null, "panelTalk": null }, "resistances": { "quiescent": null, "answer": null } } ```Успешное изменение параметров
**Тело:** ```json { "volumes": { "thCall": null, "thTalk": null, "uartFrom": null, "uartTo": null, "panelCall": null, "panelTalk": null }, "resistances": { "quiescent": null, "answer": null } } ```**Название** | **Тип** | **Описание** |
resist | Integer | Значение сопротивления измеренное панелью. \- Ограничения: 0 - 255 |
status | String | Положение трубки полученное из ограничений общих параметров "quiesence" и "answer" \- Ограничения: \- down - положенная трубка (зеленый); \- up - поднятая трубка (желтый). |
Успешное получение параметров
**Тело:** ```json { "resist": 75, "status": "down" } ``` или ```json { "resist": 190, "status": "up" } ```Внутренняя ошибка при обработке метода
**Тело:****Название** | **Тип** | **Описание** |
errors | Array | Массив возвращаемых ошибок. |
message | String | Сообщение с ошибкой. |
**Название** | **Тип** | **Описание** |
panelCode | Integer | Номер квартиры. |
callsEnabled | Object | Параметры разрешения вызовов в АТ и SIP. |
sip | Boolean | Флаг включения / выключения вызовов в SIP. \- По умолчанию: true |
handset | Boolean | Флаг включения / выключения вызовов в АТ. \- По умолчанию: true |
soundOpenTh | Boolean | Флаг включения / выключения звука открытия двери при открытии привязанным ключом к квартире. |
typeSound | Integer | Режимы эхоподавления при вызове в АТ. \- Ограничения: 0, 1, 2, 3 - 0, 1, 2 - варианты эхоподавления; \- 3 - общие настройки. \- По умолчанию: 3 |
volumes | Object | Персональные громкости при вызове в квартиру. **Важно!** Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
thCall | Integer | Громкость мелодии трубки во время вызова в АТ. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
thTalk | Integer | Громкость в трубке во время разговора по АТ. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
uartFrom | Integer | Громкость на панели во время разговора по SIP. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
uartTo | Integer | Усиление микрофона панели во время разговора по SIP. \- Ограничения: 0 - 254, 255 или null - По умолчанию: null |
panelCall | Integer | Системные звуки панели. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
panelTalk | Integer | Громкость на панели во время разговора по АТ. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
resistances | Object | Параметры сопротивления трубки для смены состояний. **Важно!** Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
quiescent | Integer | Уровень поднятия трубки. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
answer | Integer | Уровень открытия двери. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
**Название** | **Значение** | **Описание** |
Content-Type | text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
Ошибка при добавлении существующей квартиры
**Тело:****Название** | **Тип** | **Описание** |
errors | Array | Массив возвращаемых ошибок. |
message | String | Сообщение об ошибке. |
**Название** | **Тип** | **Описание** |
gateMode | Boolean | Флаг включения / выключения режима калитки. \- По умолчанию: false |
prefixHouse | Boolean | Флаг включения / выключения вызовы с префиксом. \- По умолчанию: false |
direct | Object | Параметры прямых вызовов с устройства на устройство. |
mode | Boolean | Флаг включения / выключения прямых вызовов. \- По умолчанию: false |
rules | Object | Правила для прямых вызовов. |
0 | String | Префикс дома при вызове. \- Ограничения: цифры \- По умолчанию: 0 **ВАЖНО!** Если требуются прямые вызовы, но не включен префикс, то всегда указываем 0. В остальных случаях указываем необходимый префикс дома. |
1 - 10 | String | Диапазон квартир при наборе которого будет уходить вызов на указанное устройство. |
Успешное получение параметров
**Тело:** ```json { "gateMode": false, "prefixHouse": false, "direct": { "mode": false, "rules": { "0": { "1-10": "192.168.0.101" } } } } ```Успешное изменение параметров
**Тело:** ```json { "gateMode": false, "prefixHouse": false, "direct": { "mode": false, "rules": { "0": { "1-10": "192.168.0.101" } } } } ```**Название** | **Тип** | **Описание** |
resistances | Object | Параметры сопротивления трубки для смены состояний. **Важно!** Значения "255" или "null" означают, что используются не персональные настройки квартир, а общие настройки для квартир. |
break | Integer | Уровень при неисправности трубки. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
error | Integer | Уровень при обрыве. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
quiescent | Integer | Уровень поднятия трубки. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
answer | Integer | Уровень открытия двери. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
thTalk | Integer | Громкость в трубке во время разговора по АТ. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
uartFrom | Integer | Громкость на панели во время разговора по SIP. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
uartTo | Integer | Усиление микрофона панели во время разговора по SIP. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
panelCall | Integer | Системные звуки панели. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
panelTalk | Integer | Громкость на панели во время разговора по АТ. \- Ограничения: 0 - 254, 255 или null \- По умолчанию: null |
Успешное получение параметров
**Тело:** ```json { "resistances": { "break": 240, "error": 105, "quiescent": 255, "answer": 255 }, "volumes": { "panelCall": 110, "panelTalk": 125, "thTalk": 250, "thCall": 130, "uartFrom": 135, "uartTo": 255 } } ```Успешное изменение параметров
**Тело:** ```json { "resistances": { "break": 240, "error": 105, "quiescent": 255, "answer": 255 }, "volumes": { "panelCall": 110, "panelTalk": 125, "thTalk": 250, "thCall": 130, "uartFrom": 135, "uartTo": 255 } } ```**Название** | **Тип** | **Описание** |
thCall | Integer | Громкость мелодии трубки во время вызова в АТ. \- Ограничения: 0 - 255 \- По умолчанию: 0 |
thTalk | Integer | Громкость в трубке во время разговора по АТ. \- Ограничения: 0 - 255 \- По умолчанию: 0 |
uartFrom | Integer | Громкость на панели во время разговора по SIP. \- Ограничения: 0 - 255 \- По умолчанию: 0 |
uartTo | Integer | Усиление микрофона панели во время разговора по SIP. \- Ограничения: 0 - 255 - По умолчанию: 0 |
panelCall | Integer | Системные звуки панели. \- Ограничения: 0 - 255 \- По умолчанию: 0 |
panelTalk | Integer | Громкость на панели во время разговора по АТ. \- Ограничения: 0 - 255 \- По умолчанию: 0 |
Успешное получение параметров
**Тело:** ```json { "thCall": 0, "panelCall": 0, "thTalk": 0, "panelTalk": 0, "uartFrom": 0, "uartTo": 0 } ```Успешное изменение параметров
**Тело:** ```json { "thCall": 0, "panelCall": 0, "thTalk": 0, "panelTalk": 0, "uartFrom": 0, "uartTo": 0 } ```Успешное получение логов
**Заголовки:****Название** | **Значение** | **Описание** |
Content-Type | text/plain | Тип возвращаемых данных |
Список поддерживаемых параметров "{сервис}": - **all** - все логи устройства; - **api** - логи API сервера; - **uart** - логи UART клиента; - **ddns** - логи DDNS клиента; - **camofon** - логи SIP клиента; - **streamer** - логи RTSP сервера; - **ircut** - логи переключения ИК шторки; - **upgrade** - логи обновления устройства.
Успешное получение логов
**Заголовки:****Название** | **Значение** | **Описание** |
Content-Type | text/plain | Тип возвращаемых данных |
Устройство поддерживает до 3-х виртуальных сетевых интерфейсов.
**Название** | **Тип** | **Описание** |
inet | String | Тип виртуального сетевого интерфейса. Ограничения: dhcp, static |
inetStatic | Object | Параметры для настройки статического виртуального сетевого интерфейса. |
netmask | String | Сетевая маска при подключении к сети. \- Ограничения: IPv4 адрес \- По умолчанию: 255.255.255.0 |
gateway | String | Сетевой шлюз при подключении к сети. \- Ограничения: IPv4 адрес \- По умолчанию: "" |
ipAddress | String | IP адрес устройства при подключении к сети. \- Ограничения: IPv4 адрес \- По умолчанию: 192.168.0.100 |
dnsServer | String | IP адрес DNS сервера. \- Ограничения: IPv4 адрес \- По умолчанию: "" |
Успешное получение параметров
**Тело:** ```json [ { "inet": "dhcp" }, { "inet": "static", "inetStatic": { "netmask": "255.255.255.0", "gateway": "", "ipAddress": "192.168.0.100", "dnsServer": "" } } ] ```Успешное изменение параметров
**Тело:** ```json [ { "inet": "dhcp" }, { "inet": "static", "inetStatic": { "netmask": "255.255.255.0", "gateway": "192.168.0.1", "ipAddress": "192.168.0.100", "dnsServer": "192.168.0.1" } } ] ```Успешный сброс к стандартным
**Тело:** ```json [ { "inet": "dhcp" }, { "inet": "static", "inetStatic": { "netmask": "255.255.255.0", "gateway": "", "ipAddress": "192.168.0.100", "dnsServer": "" } } ] ```**Название** | **Тип** | **Описание** |
name | String | Наименование файла. |
Успешное получение списка файлов
**Тело:** ```json [ { "name": "test.wav" } ] ```**Название** | **Тип** | **Описание** |
name | String | Наименование файла для запуска воспроизведения. |
repeat | Integer | Количество повторений воспроизведений указанного файла. |
Успешное воспроизведение аудио файла
**Тело:** ```json { "name": "test.wav", "repeat": 3 } ```Успешная остановка воспроизводимого аудио файла
**Заголовки:****Название** | **Значение** | **Описание** |
Content-Type | text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
**Название** | **Тип** | **Описание** |
strDisplayOff | Boolean | Флаг включения / выключения бегущей строки. \- По умолчанию: false |
imgStr | String | Текст отображения на дисплее. \- Длина строки: 0 - 10 символов \- По умолчанию: "" **ВАЖНО!** Поддерживается латинский алфавит и цифры ASCII. |
Успешное получение параметров
**Тело:** ```json { "strDisplayOff": true, "imgStr": "" } ```Успешное изменение параметров
**Тело:** ```json { "strDisplayOff": true, "imgStr": "" } ```Успешное получение параметров
**Заголовки:****Название** | **Значение** | **Описание** |
Content-Type | text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
**Название** | **Тип** | **Описание** |
inverseDoor | Boolean | Флаг включения / выключения программного инвертирования "Основного" и "Дополнительного" выходов. \- По умолчанию: false |
alwaysOpenNetMode | Boolean | Флаг включения / выключения режима открытых дверей при недоступности сети. \- По умолчанию: false |
alwaysOpen | Boolean | Флаг включения / выключения режима открытых дверей. \- По умолчанию: false |
Успешное получение параметров
**Тело:** ```json { "inverseDoor": false, "alwaysOpenNetMode": false, "alwaysOpen": false } ```Успешное изменение параметров
**Тело:** ```json { "inverseDoor": false, "alwaysOpenNetMode": false, "alwaysOpen": false } ```**Название** | **Значение** | **Описание** |
Authorization | Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Успешное открытие реле
**Название** | **Тип** | **Описание** |
switchTime | Integer | Время удержания двери в открытом состоянии. \- Ограничения: 1 - 10 секунд \- По умолчанию: 1 |
alwaysOpen | Boolean | Флаг включения / выключения режима открытых дверей. \- По умолчанию: false |
Успешное получение параметров
**Тело:** ```json { "switchTime": 1, "alwaysOpen": false } ```Успешное изменение параметров
**Тело:** ```json { "switchTime": 1, "alwaysOpen": false } ```**Название** | **Тип** | **Описание** |
dtmf | Object | Параметры DTMF для выходов; |
1, 2 | String | Символ необходимый для открытия выхода 1, 2. \- Длина: 1 символ - По умолчанию: 1, 2 |
callDelay | Integer | Задержка вызова в АТ. \- Ограничения: 0 - 255 секунд \- По умолчанию: 0 секунд |
talkDuration | Integer | Время разговора с момента поднятия трубки в АТ или в SIP. \- Ограничения: 1 - 255 секунд \- По умолчанию: 180 секунд |
ringDuration | Integer | Время совершения вызова до поднятия трубки в АТ или в SIP. \- Ограничения: 1 - 255 секунд \- По умолчанию: 60 секунд |
echoD | Boolean | Флаг включения / выключения алгоритма эхоподавления в SIP. \- По умолчанию: true |
**Название** | **Значение** | **Описание** |
Authorization | Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
**Название** | **Значение** | **Описание** |
Content-Type | application/json | Тип возвращаемых данных |
Content-Length | 90 | Размер возвращаемых данных |
X-Device-Mac | 08:13:00:00:00:00 | Мак адрес устройства |
**Название** | **Тип** | **Описание** |
dtmf | Object | Параметры DTMF для выходов; |
1 | String | Символ необходимый для открытия выхода 1. \- Длина: 1 символ - По умолчанию: 1 |
2 | String | Символ необходимый для открытия выхода 2. \- Длина: 1 символ - По умолчанию: 2 |
callDelay | Integer | Задержка вызова в АТ. \- Ограничения: 0 - 255 секунд \- По умолчанию: 0 секунд |
talkDuration | Integer | Время разговора с момента поднятия трубки в АТ или в SIP. \- Ограничения: 1 - 255 секунд \- По умолчанию: 180 секунд |
ringDuration | Integer | Время совершения вызова до поднятия трубки в АТ или в SIP. \- Ограничения: 1 - 255 секунд \- По умолчанию: 60 секунд |
echoD | Boolean | Флаг включения / выключения алгоритма эхоподавления в SIP. \- По умолчанию: true |
Внутренняя ошибка при обработке метода
Успешное изменение параметров
**Тело:** ```json { "dtmf": { "1": "1", "2": "2" }, "callDelay": 0, "talkDuration": 180, "ringDuration": 60, "echoD": true } ```**Название** | **Тип** | **Описание** |
videoEnable | Boolean | Флаг включения / выключения видео-потока в видео вызове; \- По умолчанию: true |
remote | Object | Параметры авторизации на SIP сервере. |
port | Integer | Порт сервера на который отправляются запросы. \- По умолчанию: 5060 |
domain | String | Адрес сервера на который отправляются запросы. \- По умолчанию: domain.com |
username | String | Логин для авторизации на сервере. \- По умолчанию: "" |
password | String | Пароль для авторизации на сервере. \- По умолчанию: "" |
registerStatus | Boolean | Флаг текущего состояния авторизации на сервере. |
**Название** | **Значение** | **Описание** |
Authorization | Basic cm9vdDoxMjM0NTY= | Заголовок "Базовой авторизации" |
Успешное получение параметров
**Заголовки:****Название** | **Значение** | **Описание** |
Content-Type | application/json | Тип возвращаемых данных |
Content-Length | 116 | Размер возвращаемых данных |
X-Device-Mac | 08:13:00:00:00:00 | Мак адрес устройства |
**Название** | **Тип** | **Описание** |
videoEnable | Boolean | Флаг включения / выключения видео-потока в видео вызове; \- По умолчанию: true |
remote | Object | Параметры авторизации на SIP сервере. |
port | Integer | Порт сервера на который отправляются запросы. \- По умолчанию: 5060 |
domain | String | Адрес сервера на который отправляются запросы. \- По умолчанию: domain.com |
username | String | Логин для авторизации на сервере. \- По умолчанию: "" |
password | String | Пароль для авторизации на сервере. \- По умолчанию: "" |
registerStatus | Boolean | Флаг текущего состояния авторизации на сервере. |
Успешное изменение параметров
**Тело:** ```json { "videoEnable": true, "remote": { "port": 5060, "domain": "domain.com", "username": "", "password": "", "registerStatus": false } } ```Внутренняя ошибка при обработке метода
**Тело:** ```json { "errors": [ { "field": "SetServer", "message": "Ошибка установки параметра" } ] } ```Успешная отправка тестового вызова
**Заголовки:****Название** | **Значение** | **Описание** |
Content-Type | text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
Успешная отправка тестового вызова
**Заголовки:****Название** | **Значение** | **Описание** |
Content-Type | text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
Успешная отправка тестового вызова
**Заголовки:****Название** | **Значение** | **Описание** |
Content-Type | text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
Успешное завершение вызова
**Заголовки:****Название** | **Значение** | **Описание** |
Content-Type | text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
**Название** | **Тип** | **Описание** |
id | String | Модель поддерживаемового коммутатора. |
name | String | Наименование поддерживаемового коммутатора. |
eCount | Integer | Количество единиц используемых для коммутации. |
Успешное получение списка
**Тело:** ```json [ { "id": "FACTORIAL", "name": "Факториал", "eCount": 8 }, { "id": "CYFRAL", "name": "Цифрал", "eCount": 10 }, { "id": "VIZIT", "name": "Визит", "eCount": 10 }, { "id": "METAKOM", "name": "Метаком", "eCount": 10 }, { "id": "ELTIS", "name": "Элтис", "eCount": 10 } ] ```**Название** | **Тип** | **Описание** |
modelId | String | Модель используемого коммутатора. Метод для получения поддерживаемых коммутаторов: [**/switch/info/models**](#bkmrk-%2Fswitch%2Finfo%2Fmodels) |
usingCom3 | Boolean | Флаг включения / выключения использования "Платы управления замком" или "Третьего коммутатора". \- По умолчанию: true |
Успешное получение параметров
**Тело:** ```json { "modelId": "CYFRAL", "usingCom3": true } ```Успешное изменение параметров
**Тело:** ```json { "modelId": "CYFRAL", "usingCom3": true } ```Панель поддерживает подключение до 2-х коммутаторов: - Визит. Панель поддерживает подключение до 3-х коммутаторов: - Элтис; - Бевард; - Цифрал; - Метаком; - Факториал.
**Название** | **Тип** | **Описание** |
capacity | Integer | Размер указанного коммутатора. \- Ограничения: 0, 10, 20, 40, 64, 80, 100, 160, 220 - По умолчанию: 0 |
matrix | Array | Двумерный массив с номерами квартир для коммутатора. |
Успешное изменение параметров
**Тело:** ```json { "capacity": 100, "matrix": [ [ 100, 1, 2, 3, 4, 5, 6, 7, 8, 9 ], [ 10, 11, 12, 13, 14, 15, 16, 17, 18, 19 ], [ 20, 21, 22, 23, 24, 25, 26, 27, 28, 29 ], [ 30, 31, 32, 33, 34, 35, 36, 37, 38, 39 ], [ 40, 41, 42, 43, 44, 45, 46, 47, 48, 49 ], [ 50, 51, 52, 53, 54, 55, 56, 57, 58, 59 ], [ 60, 61, 62, 63, 64, 65, 66, 67, 68, 69 ], [ 70, 71, 72, 73, 74, 75, 76, 77, 78, 79 ], [ 80, 81, 82, 83, 84, 85, 86, 87, 88, 89 ], [ 90, 91, 92, 93, 94, 95, 96, 97, 98, 99 ] ] } ```**Название** | **Тип** | **Описание** |
power | Object | Параметры питания панели; |
dc | Float | Входное напряжение; |
chipId | Integer | Идентификатор микроконтроллера; |
Успешное получение параметров
**Тело:** ```json { "power": { "dc": 12.412 }, "chipId": 2321944743649890300 } ```Успешное получение списка
**Тело:** ```json [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmara", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Timbuktu", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/Buenos_Aires", "America/Argentina/Catamarca", "America/Argentina/ComodRivadavia", "America/Argentina/Cordoba", "America/Argentina/Jujuy", "America/Argentina/La_Rioja", "America/Argentina/Mendoza", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Atikokan", "America/Atka", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Ensenada", "America/Fort_Nelson", "America/Fort_Wayne", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Indianapolis", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Louisville", "America/Kentucky/Monticello", "America/Knox_IN", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montreal", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nipigon", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Pangnirtung", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Acre", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rainy_River", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Rosario", "America/Santa_Isabel", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Shiprock", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Thunder_Bay", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Virgin", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "America/Yellowknife", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/South_Pole", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Ashkhabad", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Choibalsan", "Asia/Chongqing", "Asia/Chungking", "Asia/Colombo", "Asia/Dacca", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Harbin", "Asia/Hebron", "Asia/Ho_Chi_Minh", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Istanbul", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Kashgar", "Asia/Kathmandu", "Asia/Katmandu", "Asia/Khandyga", "Asia/Kolkata", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macao", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Tel_Aviv", "Asia/Thimbu", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ujung_Pandang", "Asia/Ulaanbaatar", "Asia/Ulan_Bator", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yangon", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Faroe", "Atlantic/Jan_Mayen", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/ACT", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Canberra", "Australia/Currie", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/LHI", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/NSW", "Australia/North", "Australia/Perth", "Australia/Queensland", "Australia/South", "Australia/Sydney", "Australia/Tasmania", "Australia/Victoria", "Australia/West", "Australia/Yancowinna", "Brazil/Acre", "Brazil/DeNoronha", "Brazil/East", "Brazil/West", "CET", "CST6CDT", "Canada/Atlantic", "Canada/Central", "Canada/Eastern", "Canada/Mountain", "Canada/Newfoundland", "Canada/Pacific", "Canada/Saskatchewan", "Canada/Yukon", "Chile/Continental", "Chile/EasterIsland", "Cuba", "EET", "EST", "EST5EDT", "Egypt", "Eire", "Etc/GMT", "Etc/GMT+0", "Etc/GMT+1", "Etc/GMT+10", "Etc/GMT+11", "Etc/GMT+12", "Etc/GMT+2", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT+6", "Etc/GMT+7", "Etc/GMT+8", "Etc/GMT+9", "Etc/GMT-0", "Etc/GMT-1", "Etc/GMT-10", "Etc/GMT-11", "Etc/GMT-12", "Etc/GMT-13", "Etc/GMT-14", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT-4", "Etc/GMT-5", "Etc/GMT-6", "Etc/GMT-7", "Etc/GMT-8", "Etc/GMT-9", "Etc/GMT0", "Etc/Greenwich", "Etc/UCT", "Etc/UTC", "Etc/Universal", "Etc/Zulu", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belfast", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Nicosia", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Tiraspol", "Europe/Ulyanovsk", "Europe/Uzhgorod", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zaporozhye", "Europe/Zurich", "Factory", "GB", "GB-Eire", "GMT", "GMT+0", "GMT-0", "GMT0", "Greenwich", "HST", "Hongkong", "Iceland", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Iran", "Israel", "Jamaica", "Japan", "Kwajalein", "Libya", "MET", "MST", "MST7MDT", "Mexico/BajaNorte", "Mexico/BajaSur", "Mexico/General", "NZ", "NZ-CHAT", "Navajo", "PRC", "PST8PDT", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Chuuk", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Johnston", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Pohnpei", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Samoa", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis", "Pacific/Yap", "Poland", "Portugal", "ROC", "ROK", "Singapore", "Turkey", "UCT", "US/Alaska", "US/Aleutian", "US/Arizona", "US/Central", "US/East-Indiana", "US/Eastern", "US/Hawaii", "US/Indiana-Starke", "US/Michigan", "US/Mountain", "US/Pacific", "US/Pacific-New", "US/Samoa", "UTC", "Universal", "W-SU", "WET", "Zulu" ] ```**Название** | **Тип** | **Описание** |
model | String | Название модели используемой камеры. |
temperature | Double | Значение температуры процессора камеры. \- Нормальная температура до 95**°**C. |
chipId | String | Идентификатор чипа камеры. |
mac | String | Мак адрес устройства. |
deviceID | String | Серийный номер устройства. |
deviceModel | String | Наименование устройства. |
uptime | Integer | Время работы устройства. |
registerStatus | Boolean | Флаг состояния SIP регистрации. |
Успешное получение параметров
**Тело:** ```json { "model": "HI3516EV200", "temperature": 72.69, "chipId": "020c39870e0038c96370030ac215b9932729d124509c25eb", "mac": "08:13:00:00:00:00", "deviceID": "0000000", "deviceModel": "ISCom X1 (rev.2)", "uptime": 310, "registerStatus": false } ```Метод действителен для устройств на прошивках до 2.5.6.1 (включительно) Советуем использовать новый метод: **[ /v2/system/versions](#bkmrk-%2Fv2%2Fsystem%2Fversions)**
**Название** | **Тип** | **Описание** |
rootfs | String | Версия раздела камеры с Linux. |
web | String | Версия web интерфейса. |
camofon | String | Версия SIP клиента. |
streamer | String | Версия RTSP сервера. |
hw | String | Версия платы устройства. |
sw | String | Версия прошивки микроконтроллера. |
Успешное получение версий прошивки
**Тело:** ```json { "rootfs": "1.1.1", "web": "2.2.2", "camofon": "3.3.3", "streamer": "4.4.4", "hw": "2.2", "sw": "3.3" } ```**Название** | **Тип** | **Описание** |
log\_level | Object | Уровни логирования приложений. |
api uart camofon streamer proguard store baresip libre | Integer | Уровень логирования приложения: \- 1 - Trace; \- 2 - Debug; \- 3 - Info; \- 4 - Warning; \- 5 - Error; \- 6 - Fatal. \- По умолчанию: 3 |
tz | String | Текущая временная зона ([**Поддерживаемые зоны**](#bkmrk-%2Fsystem%2Ftz)). \- По умолчанию: Asia/Yekaterinburg |
dateTime | String | Текущая дата и время |
dns | Object | Параметры DNS серверов **ВАЖНО!** Является устаревшим, советуем использовать метод **[/v1/network](#bkmrk-%2Fv1%2Fnetwork)** для получения и изменения сетевых настроек включая сервера dns. |
auto | Boolean | Флаг работы с dns серверами. \- true - автоматически; \- false - в ручную. \- По умолчанию: true |
nameservers | Array | Массив строк с dns серверами. |
ntp | Array | Массив строк с ntp серверами. |
assist | Object | Параметры для работы ассистента. |
enable | Boolean | Флаг включения / выключения ассистента. \- По умолчанию: true |
online | Boolean | Флаг переключения онлайн и оффлайн ассистента. \- По умолчанию: true **ВАЖНО!** Онлайн ассистент подразумевает входящие вызовы на панель при реагировании на различные события в логах. |
Успешное получение параметров
**Тело:** ```json { "log_level": { "api": 3, "uart": 3, "camofon": 3, "streamer": 3, "proguard": 3, "store": 3, "baresip": 3, "libre": 3 }, "tz": "UTC", "dns": { "auto": true, "nameservers": [ "78.29.2.21", "78.29.2.22" ] }, "ntp": [ "0.pool.ntp.org", "1.pool.ntp.org", "10.100.12.14" ], "assist": { "enable": true, "online": true } } ```Успешное получение параметров
**Тело:** ```json { "log_level": { "api": 3, "uart": 3, "camofon": 3, "streamer": 3, "proguard": 3, "store": 3, "baresip": 3, "libre": 3 }, "tz": "Asia/Yekaterinburg", "dateTime": "2024-06-13T11:02:22+0500", "dns": { "auto": true, "nameservers": [ "78.29.2.21", "78.29.2.22" ] }, "ntp": [ "0.pool.ntp.org", "1.pool.ntp.org", "time.is74.ru" ], "assist": { "enable": true, "online": true } } ```**Название** | **Тип** | **Описание** |
ethaddr | String | MAC адрес устройства |
Успешное получение параметров
**Тело:** ```json { "ethaddr": "08:13:00:00:00:00" } ```Для восстановление резервной копии используется метод: [**/system/restore**](#bkmrk-%2Fsystem%2Frestore)
Успешное создание резервной копии
**Заголовки:****Название** | **Значение** | **Описание** |
Content-Type | application/octet-stream | Тип возвращаемых данных |
Content-Disposition | attachment; filename="backup-08:13:00:00:00:00.bin" | Формат возвращаемых данных |
Для создания резервной копии используется метод: [**/system/backup**](#bkmrk-%2Fsystem%2Fbackup)
**Название** | **Значение** | **Описание** |
Content-Type | application/octet-stream | Тип передаваемых данных |
Успешное восстановление резервной копии
**Заголовки:****Название** | **Значение** | **Описание** |
Content-Type | text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
Успешная перезагрузка устройства
**Заголовки:****Название** | **Значение** | **Описание** |
Content-Type | text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
Список поддерживаемых параметров "{сервис}": - api; - uart; - upgrade; - camofon; - streamer.
Успешный перезапуск сервиса
Успешный сброс устройства к заводским настройкам
Метод действителен для устройств на прошивках до 2.5.6.1 (включительно) На поздних прошивках использовать новый метод: [**/v2/system/upgrade**](#bkmrk-%2Fv2%2Fsystem%2Fupgrade)
Для данного способа обновления необходим TFTP сервер
Успешный запуск обновления
**Заголовки:****Название** | **Значение** | **Описание** |
Content-Type | text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
Метод действителен для устройств на прошивках до 2.5.6.1 (включительно) На поздних прошивках использовать новый метод: [**/v2/system/upgrade**](#bkmrk-%2Fv2%2Fsystem%2Fupgrade)
Для данного способа обновления необходим TFTP сервер
**Название** | **Значение** | **Описание** |
Content-Type | text/html; charset=ISO-8859-1 | Тип возвращаемых данных |
Метод действителен для устройств на прошивкой до 2.5.6.1 (включительно) На поздних прошивках использовать новый метод: [**/v2/system/upgrade**](#bkmrk-%2Fv2%2Fsystem%2Fupgrade)
Для данного способа обновления необходим TFTP сервер
**Название** | **Тип** | **Описание** |
server | String | IP адрес или DNS имя TFTP сервера с папкой для обновления. |
folder | String | Путь до папки с файлами обновления на TFTP сервере. |
stm | Boolean | Флаг обновления прошивки микроконтроллера. \- По умолчанию: false |
opt | Boolean | Флаг обновления раздела камеры с приложениями. \- По умолчанию: false |
media | Boolean | Флаг обновления раздела камеры с аудио записями (оффлайн ассистента, оповещения). \- По умолчанию: false |
rootfs | Boolean | Флаг обновления раздела камеры с Linux. \- По умолчанию: false |
Успешный запуск обновления
**Тело:** ```json { "server": "192.168.0.10", "folder": "ISComX1/2.5.6.1", "stm": true, "opt": true, "media": true, "rootfs": true } ```**Название** | **Тип** | **Описание** |
opt | Object | Версии устройства для раздела с приложениями. |
date | Date | Дата создания прошивки для раздела. |
name | String | Версия прошивки для раздела. |
versions | Object | Версии по конкретным приложения. |
api proguard camofon ddns streamer uart upgrade overlay | Object | Описание версии приложения. |
name | String | Версия приложения. |
hash | String | Хэш сумма коммита приложения. |
hw | Object | Описание версии платы. |
name | String | Версия платы. |
mcu | Object | Описание версии микроконтроллера. |
name | String | Версия прошивки микроконтроллера. |
media | Object | Версии устройства для раздела с аудио записями (оффлайн ассистента, оповещения). |
date | Date | Дата создания прошивки для раздела. |
name | String | Версия прошивки для раздела. |
versions | Object | Версии по конкретным приложения. |
overlay | Object | Описание версии приложения. |
name | String | Версия приложения. |
hash | String | Хэш сумма коммита приложения. |
rootfs | Object | Версии устройства для раздела Linux. |
date | Date | Дата создания прошивки для раздела. |
name | String | Версия прошивки для раздела. |
versions | Object | Версии по конкретным приложения. |
libre libiscom baresip ircut rootfs overlay | Object | Описание версии приложения. |
name | String | Версия приложения. |
hash | String | Хэш сумма коммита приложения. |
Успешное получение версий прошивки
**Тело:** ```json { "opt": { "date": "2023-07-13", "name": "2.2.5.9.0", "versions": { "api": { "name": "0.3.3", "hash": "5c171d90a121cd53847397141784fd446fbf2992" }, "proguard": { "name": "0.0.2", "hash": "2f52c0e931885b33cae5bb995c8e56fcc76baf80" }, "camofon": { "name": "0.1.4", "hash": "9e52cf80bbe1908e6e668467e25e0cdcb4929ddc" }, "ddns": { "name": "0.0.2", "hash": "adc486d21c5e3204980290b1eb413541446aff56" }, "store": { "name": "0.0.4", "hash": "b4838b51190da1eea2e30b3ca0d54be47f565875" }, "streamer": { "name": "2.8.1", "hash": "db96ab3070d1bc2daeb13bd0bd7786b33052c527" }, "uart": { "name": "0.0.7", "hash": "f9e5460bddeef002a85fca1730927f6073e1eb9f" }, "web_front": { "name": "2.5.4", "hash": "d8f8cead3fcb11cce809a4e6e67cb3f0edf77ab5" }, "overlay": { "name": "0.1.8", "hash": "bd66e9a3d542dcced458decbe505ea911640958a" }, "hw": { "name": "2.5" }, "mcu": { "name": "3.44" } } }, "media": { "date": "2023-05-10", "name": "2.5.7.19", "versions": { "overlay": { "name": "0.1.1", "hash": "45acfbd6cc600fee89e00fecbe9aaa9f0434fb13" } } }, "rootfs": { "date": "2023-07-10", "name": "2.2.5.9.0", "versions": { "libre": { "name": "0.0.1", "hash": "fce5ecdd3513d37fa5d87e1515a82072761a7a06" }, "librem": { "name": "0.0.1", "hash": "01ebe94c4b8671e684c2601b339efe211640a5c5" }, "libiscom": { "name": "0.0.10", "hash": "1beb6432294d22c0e35014f059cc844e1eec4c39" }, "baresip": { "name": "0.0.1", "hash": "b711f10af2417de49e4c718ac4a2ad181009d2f8" }, "ircut": { "name": "0.0.9", "hash": "2558b1e9f7f57f1eb91e4d1979b1cbe4aa214082" }, "rootfs": { "name": "0.0.14", "hash": "3a0bfa2ecf5f118fdcd22ce068fa3bd0d73fc48d" }, "overlay": { "name": "0.1.8", "hash": "bd66e9a3d542dcced458decbe505ea911640958a" } } } } ```Метод действителен для устройств на прошивках более 2.5.7.5
Для данного способа обновления необходим HTTP сервер
**Название** | **Тип** | **Описание** |
state | String | Описание состояния обновления. \- По умолчанию: Обновление не запущено |
stateId | Integer | Идентификатор состояния обновления. \- По умолчанию: 0 |
message | String | Описание под состояния обновления. \- По умолчанию: Приложение Upgrade запущено |
messageId | Integer | Идентификатор под состояния обновления \- По умолчанию: 0 |
**Название** | **Тип** | **Описание** |
code | Integer | Код ответа на запрос. |
data | Object | Параметры используемые при обновлении. |
url | String | Ссылка на папку с файлами обновления на HTTP сервере. |
mcu | Boolean | Флаг включения обновления микроконтроллера устройства. \- По умолчанию: false |
opt | Boolean | Флаг включения обновления раздела с приложениями на камере. \- По умолчанию: false |
media | Boolean | Флаг включения обновления раздела с аудио записями (оффлайн ассистент, оповещение) на камере. \- По умолчанию: false |
rootfs | Boolean | Флаг включения обновления раздела Linux на камере. \- По умолчанию: false |
Успешное получение задания на обновление
**Тело:** ```json { "code": 200, "data": { "url": "http://192.168.0.10:8000/2.5.6.1", "mcu": true, "opt": true, "media": true, "rootfs": true } } ```Ошибка при проверки переданных параметров
**Тело:****Название** | **Тип** | **Описание** |
errors | Array | Массив возвращаемых ошибок. |
message | String | Сообщение об ошибке. |