# Протокол
## Оглавление
- [keyapis/device/v1/keyapis_device_device_v1.proto](#keyapis_device_v1_keyapis_device_device_v1-proto)
- [DeviceService](#keyapis-device-v1-DeviceService)
- [CameraStatus](#keyapis-device-v1-CameraStatus)
- [DeleteDeviceRequest](#keyapis-device-v1-DeleteDeviceRequest)
- [DeleteDeviceResponse](#keyapis-device-v1-DeleteDeviceResponse)
- [Device](#keyapis-device-v1-Device)
- [Device.AutochangePasswordSettings](#keyapis-device-v1-Device-AutochangePasswordSettings)
- [Device.Credentials](#keyapis-device-v1-Device-Credentials)
- [Device.Dispatching](#keyapis-device-v1-Device-Dispatching)
- [Device.Location](#keyapis-device-v1-Device-Location)
- [Device.Redirect](#keyapis-device-v1-Device-Redirect)
- [Device.SavingError](#keyapis-device-v1-Device-SavingError)
- [Device.SavingError.AbcNumberIsExistOnAnotherDevice](#keyapis-device-v1-Device-SavingError-AbcNumberIsExistOnAnotherDevice)
- [Device.SavingError.CapabilityIsNotSupported](#keyapis-device-v1-Device-SavingError-CapabilityIsNotSupported)
- [Device.SavingError.ConciergeRoomNotFound](#keyapis-device-v1-Device-SavingError-ConciergeRoomNotFound)
- [Device.SavingError.CredentialsAreRequired](#keyapis-device-v1-Device-SavingError-CredentialsAreRequired)
- [Device.SavingError.FieldIsNotSupported](#keyapis-device-v1-Device-SavingError-FieldIsNotSupported)
- [Device.SavingError.LoginIsExist](#keyapis-device-v1-Device-SavingError-LoginIsExist)
- [Device.SavingError.MacAddressInvalid](#keyapis-device-v1-Device-SavingError-MacAddressInvalid)
- [Device.SavingError.MacAddressIsExist](#keyapis-device-v1-Device-SavingError-MacAddressIsExist)
- [Device.SavingError.NotAllowedForModel](#keyapis-device-v1-Device-SavingError-NotAllowedForModel)
- [Device.SavingError.NotAllowedForType](#keyapis-device-v1-Device-SavingError-NotAllowedForType)
- [Device.SavingError.PublicIdentityIsExist](#keyapis-device-v1-Device-SavingError-PublicIdentityIsExist)
- [Device.SavingError.SerialNumberForModelIsExist](#keyapis-device-v1-Device-SavingError-SerialNumberForModelIsExist)
- [Device.SavingError.SerialNumberInvalid](#keyapis-device-v1-Device-SavingError-SerialNumberInvalid)
- [Device.Settings](#keyapis-device-v1-Device-Settings)
- [Device.Settings.Autocollect](#keyapis-device-v1-Device-Settings-Autocollect)
- [Device.Settings.ConciergeCall](#keyapis-device-v1-Device-Settings-ConciergeCall)
- [Device.Settings.CoordinateMatrixSwitch](#keyapis-device-v1-Device-Settings-CoordinateMatrixSwitch)
- [Device.Settings.EmergencyCall](#keyapis-device-v1-Device-Settings-EmergencyCall)
- [Device.Settings.FaceRecognition](#keyapis-device-v1-Device-Settings-FaceRecognition)
- [Device.Settings.Sl3Mode](#keyapis-device-v1-Device-Settings-Sl3Mode)
- [Device.SipTrunk](#keyapis-device-v1-Device-SipTrunk)
- [Device.SputnikCredentials](#keyapis-device-v1-Device-SputnikCredentials)
- [DeviceConfigurationStatus](#keyapis-device-v1-DeviceConfigurationStatus)
- [DeviceConfigurationStatus.Payload](#keyapis-device-v1-DeviceConfigurationStatus-Payload)
- [DeviceConfigurationStatus.Payload.Autocollect](#keyapis-device-v1-DeviceConfigurationStatus-Payload-Autocollect)
- [DeviceConfigurationStatusGrouped](#keyapis-device-v1-DeviceConfigurationStatusGrouped)
- [DeviceConfigurationStatusGroupedFilter](#keyapis-device-v1-DeviceConfigurationStatusGroupedFilter)
- [DeviceConfigurationStatusGroupedPaging](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging)
- [DeviceFilter](#keyapis-device-v1-DeviceFilter)
- [DeviceLite](#keyapis-device-v1-DeviceLite)
- [DevicePaging](#keyapis-device-v1-DevicePaging)
- [GetDeviceConfigurationStatusGroupedCountRequest](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedCountRequest)
- [GetDeviceConfigurationStatusGroupedCountResponse](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedCountResponse)
- [GetDeviceConfigurationStatusGroupedListRequest](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedListRequest)
- [GetDeviceConfigurationStatusGroupedListResponse](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedListResponse)
- [GetDeviceConfigurationStatusGroupedListResponse.Error](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedListResponse-Error)
- [GetDeviceConfigurationStatusesRequest](#keyapis-device-v1-GetDeviceConfigurationStatusesRequest)
- [GetDeviceConfigurationStatusesResponse](#keyapis-device-v1-GetDeviceConfigurationStatusesResponse)
- [GetDeviceConfigurationStatusesResponse.Error](#keyapis-device-v1-GetDeviceConfigurationStatusesResponse-Error)
- [GetDeviceConfigurationStatusesResponse.Statuses](#keyapis-device-v1-GetDeviceConfigurationStatusesResponse-Statuses)
- [GetDeviceCountRequest](#keyapis-device-v1-GetDeviceCountRequest)
- [GetDeviceCountResponse](#keyapis-device-v1-GetDeviceCountResponse)
- [GetDeviceCountResponse.Error](#keyapis-device-v1-GetDeviceCountResponse-Error)
- [GetDeviceListRequest](#keyapis-device-v1-GetDeviceListRequest)
- [GetDeviceListResponse](#keyapis-device-v1-GetDeviceListResponse)
- [GetDeviceListResponse.Error](#keyapis-device-v1-GetDeviceListResponse-Error)
- [GetDeviceLiteRequest](#keyapis-device-v1-GetDeviceLiteRequest)
- [GetDeviceLiteResponse](#keyapis-device-v1-GetDeviceLiteResponse)
- [GetDeviceRequest](#keyapis-device-v1-GetDeviceRequest)
- [GetDeviceResponse](#keyapis-device-v1-GetDeviceResponse)
- [PostDeviceConfigurationStatusRequest](#keyapis-device-v1-PostDeviceConfigurationStatusRequest)
- [PostDeviceConfigurationStatusResponse](#keyapis-device-v1-PostDeviceConfigurationStatusResponse)
- [PostDeviceConfigurationStatusResponse.Error](#keyapis-device-v1-PostDeviceConfigurationStatusResponse-Error)
- [PostDeviceInstallPresetRequest](#keyapis-device-v1-PostDeviceInstallPresetRequest)
- [PostDeviceInstallPresetResponse](#keyapis-device-v1-PostDeviceInstallPresetResponse)
- [PostDeviceInstallPresetResponse.Error](#keyapis-device-v1-PostDeviceInstallPresetResponse-Error)
- [PostDeviceInstallPresetResponse.Error.PresetStatusIsProcessing](#keyapis-device-v1-PostDeviceInstallPresetResponse-Error-PresetStatusIsProcessing)
- [PostDeviceReconfigureRequest](#keyapis-device-v1-PostDeviceReconfigureRequest)
- [PostDeviceReconfigureResponse](#keyapis-device-v1-PostDeviceReconfigureResponse)
- [PostDeviceReconfigureResponse.Error](#keyapis-device-v1-PostDeviceReconfigureResponse-Error)
- [PostDeviceReplaceRequest](#keyapis-device-v1-PostDeviceReplaceRequest)
- [PostDeviceReplaceResponse](#keyapis-device-v1-PostDeviceReplaceResponse)
- [PostDeviceReplaceResponse.Error](#keyapis-device-v1-PostDeviceReplaceResponse-Error)
- [PostDeviceReplaceResponse.Error.HostExists](#keyapis-device-v1-PostDeviceReplaceResponse-Error-HostExists)
- [PostDeviceReplaceResponse.Error.LoginExists](#keyapis-device-v1-PostDeviceReplaceResponse-Error-LoginExists)
- [PostDeviceReplaceResponse.Error.LoginIsRequired](#keyapis-device-v1-PostDeviceReplaceResponse-Error-LoginIsRequired)
- [PostDeviceReplaceResponse.Error.MacAddressExists](#keyapis-device-v1-PostDeviceReplaceResponse-Error-MacAddressExists)
- [PostDeviceReplaceResponse.Error.SerialNumberExists](#keyapis-device-v1-PostDeviceReplaceResponse-Error-SerialNumberExists)
- [PostDeviceRequest](#keyapis-device-v1-PostDeviceRequest)
- [PostDeviceResponse](#keyapis-device-v1-PostDeviceResponse)
- [PostDeviceResponse.Error](#keyapis-device-v1-PostDeviceResponse-Error)
- [Preset](#keyapis-device-v1-Preset)
- [Preset.Dtmf](#keyapis-device-v1-Preset-Dtmf)
- [Preset.FaceRecognition](#keyapis-device-v1-Preset-FaceRecognition)
- [Preset.Ntp](#keyapis-device-v1-Preset-Ntp)
- [Preset.Room](#keyapis-device-v1-Preset-Room)
- [Preset.SavingError](#keyapis-device-v1-Preset-SavingError)
- [Preset.SavingError.Conflict](#keyapis-device-v1-Preset-SavingError-Conflict)
- [Preset.SavingError.NotAllowedForDefault](#keyapis-device-v1-Preset-SavingError-NotAllowedForDefault)
- [Preset.Sip](#keyapis-device-v1-Preset-Sip)
- [Preset.Syslog](#keyapis-device-v1-Preset-Syslog)
- [Preset.VideoConfig](#keyapis-device-v1-Preset-VideoConfig)
- [Preset.VideoConfig.RtspUser](#keyapis-device-v1-Preset-VideoConfig-RtspUser)
- [PutDeviceRequest](#keyapis-device-v1-PutDeviceRequest)
- [PutDeviceResponse](#keyapis-device-v1-PutDeviceResponse)
- [ReinstallError](#keyapis-device-v1-ReinstallError)
- [ReinstallError.SipLoginIsMissing](#keyapis-device-v1-ReinstallError-SipLoginIsMissing)
- [SyncStatus](#keyapis-device-v1-SyncStatus)
- [ValidationError](#keyapis-device-v1-ValidationError)
- [CameraStatus.StatusType](#keyapis-device-v1-CameraStatus-StatusType)
- [Device.Credentials.UserAccessType](#keyapis-device-v1-Device-Credentials-UserAccessType)
- [Device.ModelType](#keyapis-device-v1-Device-ModelType)
- [Device.PresetStatusType](#keyapis-device-v1-Device-PresetStatusType)
- [Device.SipTrunk.SipType](#keyapis-device-v1-Device-SipTrunk-SipType)
- [Device.StatusType](#keyapis-device-v1-Device-StatusType)
- [Device.Type](#keyapis-device-v1-Device-Type)
- [DeviceConfigurationStatus.ConfigurationType](#keyapis-device-v1-DeviceConfigurationStatus-ConfigurationType)
- [DeviceConfigurationStatus.StatusType](#keyapis-device-v1-DeviceConfigurationStatus-StatusType)
- [DeviceConfigurationStatusGroupedPaging.DirectionType](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging-DirectionType)
- [DeviceConfigurationStatusGroupedPaging.OrderByType](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging-OrderByType)
- [DevicePaging.DirectionType](#keyapis-device-v1-DevicePaging-DirectionType)
- [DevicePaging.OrderByType](#keyapis-device-v1-DevicePaging-OrderByType)
- [Preset.FaceRecognition.ConfigurationType](#keyapis-device-v1-Preset-FaceRecognition-ConfigurationType)
- [Preset.StatusType](#keyapis-device-v1-Preset-StatusType)
- [Preset.Syslog.ProtocolType](#keyapis-device-v1-Preset-Syslog-ProtocolType)
- [Preset.VideoConfig.QualityType](#keyapis-device-v1-Preset-VideoConfig-QualityType)
- [SyncStatus.StatusType](#keyapis-device-v1-SyncStatus-StatusType)
## [Схема классов](/svg/protos/key/keyapis/device/v1/keyapis_device_device_v1.proto.svg)
## [keyapis/device/v1/keyapis_device_device_v1.proto](/protos/key/keyapis/device/v1/keyapis_device_device_v1.proto)
Сервис реализует функционал управления устройствами
### DeviceService
Сервис устройств
| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| [GetDevice](#keyapis-device-v1-GetDevice) | Метод получаения устройства. Метод доступен для: admin, service, owner, employee, bti, ltp_first | [keyapis.device.v1.GetDeviceRequest](#keyapis-device-v1-GetDeviceRequest) | [keyapis.device.v1.GetDeviceResponse](#keyapis-device-v1-GetDeviceResponse) |
| [GetDeviceList](#keyapis-device-v1-GetDeviceList) | Метод получения списка устройств. Метод доступен для: admin, service, owner, employee, bti, ltp_first | [keyapis.device.v1.GetDeviceListRequest](#keyapis-device-v1-GetDeviceListRequest) | [keyapis.device.v1.GetDeviceListResponse](#keyapis-device-v1-GetDeviceListResponse) stream |
| [GetDeviceCount](#keyapis-device-v1-GetDeviceCount) | Метод получения количества устройств. Метод доступен для: admin, service, owner, employee, bti, ltp_first | [keyapis.device.v1.GetDeviceCountRequest](#keyapis-device-v1-GetDeviceCountRequest) | [keyapis.device.v1.GetDeviceCountResponse](#keyapis-device-v1-GetDeviceCountResponse) |
| [PostDevice](#keyapis-device-v1-PostDevice) | Метод создания устройства. Метод доступен для: admin, bti, service, owner, employee. Для owner, employee доступно создание и редактирование только в КВГ, привязанных к компании пользователя | [keyapis.device.v1.PostDeviceRequest](#keyapis-device-v1-PostDeviceRequest) | [keyapis.device.v1.PostDeviceResponse](#keyapis-device-v1-PostDeviceResponse) |
| [PutDevice](#keyapis-device-v1-PutDevice) | **Deprecated.** Метод изменения устройства. Метод доступен для: admin, bti, service | [keyapis.device.v1.PutDeviceRequest](#keyapis-device-v1-PutDeviceRequest) | [keyapis.device.v1.PutDeviceResponse](#keyapis-device-v1-PutDeviceResponse) |
| [PostDeviceInstallPreset](#keyapis-device-v1-PostDeviceInstallPreset) | Метод установки пресета на устройство. Метод доступен для: admin, service | [keyapis.device.v1.PostDeviceInstallPresetRequest](#keyapis-device-v1-PostDeviceInstallPresetRequest) | [keyapis.device.v1.PostDeviceInstallPresetResponse](#keyapis-device-v1-PostDeviceInstallPresetResponse) |
| [PostDeviceReplace](#keyapis-device-v1-PostDeviceReplace) | Метод замены устройста. Логика работы метода: https://confluence.rt.ru/pages/viewpage.action?pageId=655256574. Метод доступен для: admin, bti, service | [keyapis.device.v1.PostDeviceReplaceRequest](#keyapis-device-v1-PostDeviceReplaceRequest) | [keyapis.device.v1.PostDeviceReplaceResponse](#keyapis-device-v1-PostDeviceReplaceResponse) |
| [PostDeviceReconfigure](#keyapis-device-v1-PostDeviceReconfigure) | Метод переконфигурирования устройста. Логика работы метода: https://confluence.rt.ru/pages/viewpage.action?pageId=630337555. Метод доступен для: admin, bti, service | [keyapis.device.v1.PostDeviceReconfigureRequest](#keyapis-device-v1-PostDeviceReconfigureRequest) | [keyapis.device.v1.PostDeviceReconfigureResponse](#keyapis-device-v1-PostDeviceReconfigureResponse) |
| [GetDeviceConfigurationStatuses](#keyapis-device-v1-GetDeviceConfigurationStatuses) | Метод получения статусов конфигурации устройства. Метод доступен для: admin, service, bti, ltp_first | [keyapis.device.v1.GetDeviceConfigurationStatusesRequest](#keyapis-device-v1-GetDeviceConfigurationStatusesRequest) | [keyapis.device.v1.GetDeviceConfigurationStatusesResponse](#keyapis-device-v1-GetDeviceConfigurationStatusesResponse) |
| [PostDeviceConfigurationStatus](#keyapis-device-v1-PostDeviceConfigurationStatus) | Метод изменения статуса конфигурации устройства. Метод доступен для: admin, service | [keyapis.device.v1.PostDeviceConfigurationStatusRequest](#keyapis-device-v1-PostDeviceConfigurationStatusRequest) | [keyapis.device.v1.PostDeviceConfigurationStatusResponse](#keyapis-device-v1-PostDeviceConfigurationStatusResponse) |
| [GetDeviceConfigurationStatusGroupedList](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedList) | Метод получения списка конфигураций сгруппированных по устройствам. Метод доступен для: admin, service | [keyapis.device.v1.GetDeviceConfigurationStatusGroupedListRequest](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedListRequest) | [keyapis.device.v1.GetDeviceConfigurationStatusGroupedListResponse](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedListResponse) stream |
| [GetDeviceConfigurationStatusGroupedCount](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedCount) | Метод получения количества конфигураций сгруппированных по устройствам. Метод доступен для: admin, service | [keyapis.device.v1.GetDeviceConfigurationStatusGroupedCountRequest](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedCountRequest) | [keyapis.device.v1.GetDeviceConfigurationStatusGroupedCountResponse](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedCountResponse) |
| [DeleteDevice](#keyapis-device-v1-DeleteDevice) | Метод удаления устройства. Метод доступен для: admin, service | [keyapis.device.v1.DeleteDeviceRequest](#keyapis-device-v1-DeleteDeviceRequest) | [keyapis.device.v1.DeleteDeviceResponse](#keyapis-device-v1-DeleteDeviceResponse) |
| [GetDeviceLite](#keyapis-device-v1-GetDeviceLite) | Метод получаения упрощенного устройства. Метод доступен для: admin, service, owner, employee, bti, ltp_first. Метод доступен для: ApiKey | [keyapis.device.v1.GetDeviceLiteRequest](#keyapis-device-v1-GetDeviceLiteRequest) | [keyapis.device.v1.GetDeviceLiteResponse](#keyapis-device-v1-GetDeviceLiteResponse) |
### [CameraStatus](#keyapis-device-v1-CameraStatus)
Статус камеры.
# Описание модели
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [id](#keyapis-device-v1-CameraStatus-id) | Идентификатор камеры uid. # Тип: Guid | [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [status_type](#keyapis-device-v1-CameraStatus-status_type) | Статус камеры | [keyapis.device.v1.CameraStatus.StatusType](#keyapis-device-v1-CameraStatus-StatusType) | OUTPUT_ONLY|
| [error_message](#keyapis-device-v1-CameraStatus-error_message) | Сообщение об ошибке | [string](#scalar-types) | OUTPUT_ONLY|
### [DeleteDeviceRequest](#keyapis-device-v1-DeleteDeviceRequest)
Запрос удаления устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [id](#keyapis-device-v1-DeleteDeviceRequest-id) | Идентификатор устройства | [int32](#scalar-types) | REQUIRED|
### [DeleteDeviceResponse](#keyapis-device-v1-DeleteDeviceResponse)
Ответ на запрос удаления устройства
### [Device](#keyapis-device-v1-Device)
Устройство.
# Описание модели
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [id](#keyapis-device-v1-Device-id) | Идентификатор. # Диапазон: 0..2147483647 | [int32](#scalar-types) | |
| [preset_id](#keyapis-device-v1-Device-preset_id) | Идентификатор пресета. # Диапазон: 1..2147483647 | [int32](#scalar-types) | REQUIRED|
| [preset_status_type](#keyapis-device-v1-Device-preset_status_type) | **Deprecated.** Статус установки пресета. # Поле вычисляется в коде приложения | [keyapis.device.v1.Device.PresetStatusType](#keyapis-device-v1-Device-PresetStatusType) | OUTPUT_ONLY|
| [preset_configured_at](#keyapis-device-v1-Device-preset_configured_at) | **Deprecated.** Дата установки пресета на устройство. # Тип: DateTime | [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| [is_sl3_mode_enabled](#keyapis-device-v1-Device-is_sl3_mode_enabled) | **Deprecated.** Настройка режима SL3 | [bool](#scalar-types) | REQUIRED|
| [type](#keyapis-device-v1-Device-type) | Тип назначения устройства | [keyapis.device.v1.Device.Type](#keyapis-device-v1-Device-Type) | REQUIRED|
| [mac_address](#keyapis-device-v1-Device-mac_address) | MAC-адрес. # Диапазон: 17..17. # Паттерн: /^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/ | [string](#scalar-types) | REQUIRED|
| [title](#keyapis-device-v1-Device-title) | Наименование устройства. # Диапазон: 3..256 | [string](#scalar-types) | REQUIRED|
| [model_type](#keyapis-device-v1-Device-model_type) | Модель устройства | [keyapis.device.v1.Device.ModelType](#keyapis-device-v1-Device-ModelType) | REQUIRED|
| [owner_company_id](#keyapis-device-v1-Device-owner_company_id) | Идентификатор компании владельца. # Диапазон: 1..2147483647 | [int32](#scalar-types) | REQUIRED|
| [serial_number](#keyapis-device-v1-Device-serial_number) | Серийный номер. # Диапазон: 1..16 | [string](#scalar-types) | REQUIRED|
| [flatgramm_id](#keyapis-device-v1-Device-flatgramm_id) | Идентификатор квартирограммы. # Диапазон: 1..2147483647 | [int32](#scalar-types) | REQUIRED|
| [utc_offset](#keyapis-device-v1-Device-utc_offset) | Смещение таймзоны в минутах. # Диапазон: -720..840 | [int32](#scalar-types) | REQUIRED|
| [status_type](#keyapis-device-v1-Device-status_type) | Статус устройства | [keyapis.device.v1.Device.StatusType](#keyapis-device-v1-Device-StatusType) | OUTPUT_ONLY|
| [ip_address](#keyapis-device-v1-Device-ip_address) | Сетевой адрес. # Диапазон: 0..250 | [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [port](#keyapis-device-v1-Device-port) | Сетевой порт. # Диапазон: 0..65535 | [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [sputnik_credentials](#keyapis-device-v1-Device-sputnik_credentials) | Учетные данные. Используется для устройств с типом модели SPUTNIK_IO | [keyapis.device.v1.Device.SputnikCredentials](#keyapis-device-v1-Device-SputnikCredentials) | |
| [location](#keyapis-device-v1-Device-location) | Координаты | [keyapis.device.v1.Device.Location](#keyapis-device-v1-Device-Location) | |
| [camera_id](#keyapis-device-v1-Device-camera_id) | Идентификатор камеры uid. # Тип: Guid | [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [tags](#keyapis-device-v1-Device-tags) | Список тегов устройства. # Диапазон: 1..50 | repeated [string](#scalar-types) | |
| [settings](#keyapis-device-v1-Device-settings) | Настройки устройства | [keyapis.device.v1.Device.Settings](#keyapis-device-v1-Device-Settings) | |
| [hardware_version](#keyapis-device-v1-Device-hardware_version) | Версия аппаратного обеспенения | [string](#scalar-types) | OUTPUT_ONLY|
| [software_version](#keyapis-device-v1-Device-software_version) | Версия программного обеспенения | [string](#scalar-types) | OUTPUT_ONLY|
| [dispatching](#keyapis-device-v1-Device-dispatching) | Диспетчеризации | [keyapis.device.v1.Device.Dispatching](#keyapis-device-v1-Device-Dispatching) | |
| [sip_trunk](#keyapis-device-v1-Device-sip_trunk) | Транк | [keyapis.device.v1.Device.SipTrunk](#keyapis-device-v1-Device-SipTrunk) | |
| [redirect](#keyapis-device-v1-Device-redirect) | Переадресация | [keyapis.device.v1.Device.Redirect](#keyapis-device-v1-Device-Redirect) | |
| [autochange_password_settings](#keyapis-device-v1-Device-autochange_password_settings) | Настройки автозамены пароля | [keyapis.device.v1.Device.AutochangePasswordSettings](#keyapis-device-v1-Device-AutochangePasswordSettings) | |
| [credentials](#keyapis-device-v1-Device-credentials) | Учетные данные пользователей | repeated [keyapis.device.v1.Device.Credentials](#keyapis-device-v1-Device-Credentials) | OUTPUT_ONLY|
| [sip_account](#keyapis-device-v1-Device-sip_account) | Сип-аккаунт | [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| [sync_status](#keyapis-device-v1-Device-sync_status) | Статус синхронизации | [keyapis.device.v1.SyncStatus](#keyapis-device-v1-SyncStatus) | OUTPUT_ONLY|
### [Device.AutochangePasswordSettings](#keyapis-device-v1-Device-AutochangePasswordSettings)
Настройки автозамены пароля
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [is_enabled](#keyapis-device-v1-Device-AutochangePasswordSettings-is_enabled) | Статус настройки автозамены пароля | [bool](#scalar-types) | REQUIRED|
### [Device.Credentials](#keyapis-device-v1-Device-Credentials)
Учетные данные пользователей
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [login](#keyapis-device-v1-Device-Credentials-login) | Логин. # Диапазон: 0..100 | [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [password](#keyapis-device-v1-Device-Credentials-password) | Пароль. # Диапазон: 0..100 | [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [user_access_type](#keyapis-device-v1-Device-Credentials-user_access_type) | Тип доступа пользователя | [keyapis.device.v1.Device.Credentials.UserAccessType](#keyapis-device-v1-Device-Credentials-UserAccessType) | |
### [Device.Dispatching](#keyapis-device-v1-Device-Dispatching)
Диспетчеризации
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [is_enabled](#keyapis-device-v1-Device-Dispatching-is_enabled) | Статус настройки диспетчеризации | [bool](#scalar-types) | REQUIRED|
| [public_identity](#keyapis-device-v1-Device-Dispatching-public_identity) | Публичный номер. # Паттерн: /^[1-9]\d{3,7}$/ | [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
### [Device.Location](#keyapis-device-v1-Device-Location)
Координаты
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [latitude](#keyapis-device-v1-Device-Location-latitude) | Широта | [float](#scalar-types) | REQUIRED|
| [longitude](#keyapis-device-v1-Device-Location-longitude) | Долгота | [float](#scalar-types) | REQUIRED|
### [Device.Redirect](#keyapis-device-v1-Device-Redirect)
Переадресация.
Требуется капабилити SIP_CALLS
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [is_enabled_sip](#keyapis-device-v1-Device-Redirect-is_enabled_sip) | Переадресация на SIP | [bool](#scalar-types) | REQUIRED|
| [is_enabled_phone](#keyapis-device-v1-Device-Redirect-is_enabled_phone) | Переадресация на телефон | [bool](#scalar-types) | REQUIRED|
### [Device.SavingError](#keyapis-device-v1-Device-SavingError)
Ошибка сохранения.
Эти проверки выполняются при работе с базой данных и сторонними сервисами
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [mac_address_invalid](#keyapis-device-v1-Device-SavingError-mac_address_invalid) | **Deprecated.** Переданный мак-адрес не валидный | optional [keyapis.device.v1.Device.SavingError.MacAddressInvalid](#keyapis-device-v1-Device-SavingError-MacAddressInvalid) | |
| [serial_number_invalid](#keyapis-device-v1-Device-SavingError-serial_number_invalid) | **Deprecated.** Переданный серийный номер не валидный | optional [keyapis.device.v1.Device.SavingError.SerialNumberInvalid](#keyapis-device-v1-Device-SavingError-SerialNumberInvalid) | |
| [not_allowed_for_type](#keyapis-device-v1-Device-SavingError-not_allowed_for_type) | Нельзя изменить тип назначения девайса | optional [keyapis.device.v1.Device.SavingError.NotAllowedForType](#keyapis-device-v1-Device-SavingError-NotAllowedForType) | |
| [not_allowed_for_model](#keyapis-device-v1-Device-SavingError-not_allowed_for_model) | Нельзя изменить модель девайса | optional [keyapis.device.v1.Device.SavingError.NotAllowedForModel](#keyapis-device-v1-Device-SavingError-NotAllowedForModel) | |
| [serial_number_for_model_is_exist](#keyapis-device-v1-Device-SavingError-serial_number_for_model_is_exist) | Серийный номер для данной модели уже существует на платформе | optional [keyapis.device.v1.Device.SavingError.SerialNumberForModelIsExist](#keyapis-device-v1-Device-SavingError-SerialNumberForModelIsExist) | |
| [mac_address_is_exist](#keyapis-device-v1-Device-SavingError-mac_address_is_exist) | MAC-адрес уже существует на платформе | optional [keyapis.device.v1.Device.SavingError.MacAddressIsExist](#keyapis-device-v1-Device-SavingError-MacAddressIsExist) | |
| [capability_is_not_supported](#keyapis-device-v1-Device-SavingError-capability_is_not_supported) | Настройка не поддерживается | optional [keyapis.device.v1.Device.SavingError.CapabilityIsNotSupported](#keyapis-device-v1-Device-SavingError-CapabilityIsNotSupported) | |
| [abc_number_is_exist_on_another_device](#keyapis-device-v1-Device-SavingError-abc_number_is_exist_on_another_device) | ABC-номер присвоен другому устройству | optional [keyapis.device.v1.Device.SavingError.AbcNumberIsExistOnAnotherDevice](#keyapis-device-v1-Device-SavingError-AbcNumberIsExistOnAnotherDevice) | |
| [public_identity_is_exist](#keyapis-device-v1-Device-SavingError-public_identity_is_exist) | Публичный номер уже существует на платформе | optional [keyapis.device.v1.Device.SavingError.PublicIdentityIsExist](#keyapis-device-v1-Device-SavingError-PublicIdentityIsExist) | |
| [concierge_room_not_found](#keyapis-device-v1-Device-SavingError-concierge_room_not_found) | Не найдена квартира для консьержа | optional [keyapis.device.v1.Device.SavingError.ConciergeRoomNotFound](#keyapis-device-v1-Device-SavingError-ConciergeRoomNotFound) | |
| [login_is_exist](#keyapis-device-v1-Device-SavingError-login_is_exist) | Логин уже существует на платформе | optional [keyapis.device.v1.Device.SavingError.LoginIsExist](#keyapis-device-v1-Device-SavingError-LoginIsExist) | |
| [credentials_are_required](#keyapis-device-v1-Device-SavingError-credentials_are_required) | Отсутствуют реквизиты для модели "Спутник" | optional [keyapis.device.v1.Device.SavingError.CredentialsAreRequired](#keyapis-device-v1-Device-SavingError-CredentialsAreRequired) | |
| [field_is_not_supported](#keyapis-device-v1-Device-SavingError-field_is_not_supported) | Переданное поле не поддерживается | optional [keyapis.device.v1.Device.SavingError.FieldIsNotSupported](#keyapis-device-v1-Device-SavingError-FieldIsNotSupported) | |
### [Device.SavingError.AbcNumberIsExistOnAnotherDevice](#keyapis-device-v1-Device-SavingError-AbcNumberIsExistOnAnotherDevice)
ABC-номер присвоен другому устройству
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [device_id](#keyapis-device-v1-Device-SavingError-AbcNumberIsExistOnAnotherDevice-device_id) | Идентификатор устройства на котором находится ABC-номер | [int32](#scalar-types) | REQUIRED|
### [Device.SavingError.CapabilityIsNotSupported](#keyapis-device-v1-Device-SavingError-CapabilityIsNotSupported)
Функциональность не поддерживается моделью устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [model_capability_type](#keyapis-device-v1-Device-SavingError-CapabilityIsNotSupported-model_capability_type) | Возможность | [keyapis.device.v1.Model.CapabilityType](#keyapis-device-v1-Model-CapabilityType) | |
### [Device.SavingError.ConciergeRoomNotFound](#keyapis-device-v1-Device-SavingError-ConciergeRoomNotFound)
Не найдена квартира для консьержа
### [Device.SavingError.CredentialsAreRequired](#keyapis-device-v1-Device-SavingError-CredentialsAreRequired)
Отсутствуют реквизиты для модели "Спутник"
### [Device.SavingError.FieldIsNotSupported](#keyapis-device-v1-Device-SavingError-FieldIsNotSupported)
Переданное поле не поддерживается
### [Device.SavingError.LoginIsExist](#keyapis-device-v1-Device-SavingError-LoginIsExist)
Логин уже существует на платформе
### [Device.SavingError.MacAddressInvalid](#keyapis-device-v1-Device-SavingError-MacAddressInvalid)
Переданный мак-адрес не валидный
### [Device.SavingError.MacAddressIsExist](#keyapis-device-v1-Device-SavingError-MacAddressIsExist)
MAC-адрес уже существует на платформе
### [Device.SavingError.NotAllowedForModel](#keyapis-device-v1-Device-SavingError-NotAllowedForModel)
Нельзя изменить модель девайса
### [Device.SavingError.NotAllowedForType](#keyapis-device-v1-Device-SavingError-NotAllowedForType)
Нельзя изменить тип назначения девайса
### [Device.SavingError.PublicIdentityIsExist](#keyapis-device-v1-Device-SavingError-PublicIdentityIsExist)
Публичный номер уже существует на платформе
### [Device.SavingError.SerialNumberForModelIsExist](#keyapis-device-v1-Device-SavingError-SerialNumberForModelIsExist)
Серийный номер для данной модели уже существует на платформе
### [Device.SavingError.SerialNumberInvalid](#keyapis-device-v1-Device-SavingError-SerialNumberInvalid)
Переданный серийный номер не валидный
### [Device.Settings](#keyapis-device-v1-Device-Settings)
Настройки устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [coordinate_matrix_switch](#keyapis-device-v1-Device-Settings-coordinate_matrix_switch) | Настройки ККМ | [keyapis.device.v1.Device.Settings.CoordinateMatrixSwitch](#keyapis-device-v1-Device-Settings-CoordinateMatrixSwitch) | |
| [concierge_call](#keyapis-device-v1-Device-Settings-concierge_call) | Настройки вызова консьержа. Требуется капабилити CONCIERGE_CALL | [keyapis.device.v1.Device.Settings.ConciergeCall](#keyapis-device-v1-Device-Settings-ConciergeCall) | |
| [autocollect](#keyapis-device-v1-Device-Settings-autocollect) | Настройки автосбора | [keyapis.device.v1.Device.Settings.Autocollect](#keyapis-device-v1-Device-Settings-Autocollect) | |
| [face_recognition](#keyapis-device-v1-Device-Settings-face_recognition) | Настройки распознования лиц | [keyapis.device.v1.Device.Settings.FaceRecognition](#keyapis-device-v1-Device-Settings-FaceRecognition) | |
| [sl3_mode](#keyapis-device-v1-Device-Settings-sl3_mode) | Настройки режима SL3 | [keyapis.device.v1.Device.Settings.Sl3Mode](#keyapis-device-v1-Device-Settings-Sl3Mode) | |
| [emergency_call](#keyapis-device-v1-Device-Settings-emergency_call) | Настройки вызова экстренной службы. Только для устройств с CapabilityType=EMERGENCY_CALL | [keyapis.device.v1.Device.Settings.EmergencyCall](#keyapis-device-v1-Device-Settings-EmergencyCall) | |
### [Device.Settings.Autocollect](#keyapis-device-v1-Device-Settings-Autocollect)
Настройки автосбора
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [is_enabled](#keyapis-device-v1-Device-Settings-Autocollect-is_enabled) | Статус настройки автосбора | [bool](#scalar-types) | REQUIRED|
### [Device.Settings.ConciergeCall](#keyapis-device-v1-Device-Settings-ConciergeCall)
Настройки вызова консьержа
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [is_enabled](#keyapis-device-v1-Device-Settings-ConciergeCall-is_enabled) | Статус настройки вызова консьержа | [bool](#scalar-types) | REQUIRED|
| [orpon](#keyapis-device-v1-Device-Settings-ConciergeCall-orpon) | Идентификатор ОРПОН | [int64](#scalar-types) | REQUIRED|
| [room_number](#keyapis-device-v1-Device-Settings-ConciergeCall-room_number) | Номер квартиры. # Диапазон: 1..5 | [string](#scalar-types) | REQUIRED|
| [sip_number](#keyapis-device-v1-Device-Settings-ConciergeCall-sip_number) | Номер сип-трубки | [string](#scalar-types) | OUTPUT_ONLY|
### [Device.Settings.CoordinateMatrixSwitch](#keyapis-device-v1-Device-Settings-CoordinateMatrixSwitch)
Настройки ККМ.
Коммутатор координатно-матричный (устройство для подключения аналоговых трубок к домофону)
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [is_enabled](#keyapis-device-v1-Device-Settings-CoordinateMatrixSwitch-is_enabled) | Состояние | [bool](#scalar-types) | REQUIRED|
### [Device.Settings.EmergencyCall](#keyapis-device-v1-Device-Settings-EmergencyCall)
Настройки вызова экстренной службы.
Только для устройств с CapabilityType=EMERGENCY_CALL
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [is_call_available](#keyapis-device-v1-Device-Settings-EmergencyCall-is_call_available) | Возможность вызова экстренной службы | [bool](#scalar-types) | REQUIRED|
| [emergency_number](#keyapis-device-v1-Device-Settings-EmergencyCall-emergency_number) | АБС-номер экстренной службы. # Паттерн: /^\+[1-9][0-9]{10}$/ | [string](#scalar-types) | REQUIRED|
### [Device.Settings.FaceRecognition](#keyapis-device-v1-Device-Settings-FaceRecognition)
Настройки распознования лиц
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [is_enabled](#keyapis-device-v1-Device-Settings-FaceRecognition-is_enabled) | Статус настройки | [bool](#scalar-types) | REQUIRED|
### [Device.Settings.Sl3Mode](#keyapis-device-v1-Device-Settings-Sl3Mode)
Настройки режима SL3
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [is_enabled](#keyapis-device-v1-Device-Settings-Sl3Mode-is_enabled) | Статус настройки | [bool](#scalar-types) | REQUIRED|
| [encryption_profile_id](#keyapis-device-v1-Device-Settings-Sl3Mode-encryption_profile_id) | Идентификатор профиля шифрования | [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
### [Device.SipTrunk](#keyapis-device-v1-Device-SipTrunk)
Транк.
Параметры для соединения между устрйоством и телефонной сетью общего пользования.
Требуется капабилити SIP_CALLS
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [abc_number](#keyapis-device-v1-Device-SipTrunk-abc_number) | ABC-номер. # Паттерн: /^(\+7)(\d{10})$/ | [string](#scalar-types) | REQUIRED|
| [host](#keyapis-device-v1-Device-SipTrunk-host) | Хост. # Диапазон: 0..250 | [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [port](#keyapis-device-v1-Device-SipTrunk-port) | Порт. # Диапазон: 0..65535 | [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [sip_type](#keyapis-device-v1-Device-SipTrunk-sip_type) | Тип сети связи | [keyapis.device.v1.Device.SipTrunk.SipType](#keyapis-device-v1-Device-SipTrunk-SipType) | REQUIRED|
### [Device.SputnikCredentials](#keyapis-device-v1-Device-SputnikCredentials)
Учетные данные.
Используется для устройств с типом модели SPUTNIK_IO
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [login](#keyapis-device-v1-Device-SputnikCredentials-login) | Логин. # Тип: Guid | [string](#scalar-types) | REQUIRED|
| [password](#keyapis-device-v1-Device-SputnikCredentials-password) | Пароль. На чтение выводится только для пользователя с типом service | [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
### [DeviceConfigurationStatus](#keyapis-device-v1-DeviceConfigurationStatus)
Статус конфигурации устройства.
# Описание модели
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [id](#keyapis-device-v1-DeviceConfigurationStatus-id) | Идентификатор | [int32](#scalar-types) | |
| [device_id](#keyapis-device-v1-DeviceConfigurationStatus-device_id) | Идентификатор устройства | [int32](#scalar-types) | REQUIRED|
| [configuration_type](#keyapis-device-v1-DeviceConfigurationStatus-configuration_type) | Тип конфигурации | [keyapis.device.v1.DeviceConfigurationStatus.ConfigurationType](#keyapis-device-v1-DeviceConfigurationStatus-ConfigurationType) | REQUIRED|
| [status_type](#keyapis-device-v1-DeviceConfigurationStatus-status_type) | Статус конфигурации настройки устройства | [keyapis.device.v1.DeviceConfigurationStatus.StatusType](#keyapis-device-v1-DeviceConfigurationStatus-StatusType) | REQUIRED|
| [configured_at](#keyapis-device-v1-DeviceConfigurationStatus-configured_at) | Дата последней конфигурации устройства. # Тип: DateTime | [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| [error_message](#keyapis-device-v1-DeviceConfigurationStatus-error_message) | Текст ошибки | [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [retry_count](#keyapis-device-v1-DeviceConfigurationStatus-retry_count) | Количество попыток | [int32](#scalar-types) | REQUIRED|
| [payload](#keyapis-device-v1-DeviceConfigurationStatus-payload) | Дополнительная полезная нагрузка | [keyapis.device.v1.DeviceConfigurationStatus.Payload](#keyapis-device-v1-DeviceConfigurationStatus-Payload) | OUTPUT_ONLY|
| [next_retry_at](#keyapis-device-v1-DeviceConfigurationStatus-next_retry_at) | Минимально возможная дата выполнения следующей попытки. # Тип: DateTime | [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
### [DeviceConfigurationStatus.Payload](#keyapis-device-v1-DeviceConfigurationStatus-Payload)
Дополнительная полезная нагрузка
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [autocollect](#keyapis-device-v1-DeviceConfigurationStatus-Payload-autocollect) | Автоколлект | optional [keyapis.device.v1.DeviceConfigurationStatus.Payload.Autocollect](#keyapis-device-v1-DeviceConfigurationStatus-Payload-Autocollect) | |
### [DeviceConfigurationStatus.Payload.Autocollect](#keyapis-device-v1-DeviceConfigurationStatus-Payload-Autocollect)
Автоколлект
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [enabled_at](#keyapis-device-v1-DeviceConfigurationStatus-Payload-Autocollect-enabled_at) | Дата включения автосбора. # Тип: DateTime | [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [to_be_disabled_at](#keyapis-device-v1-DeviceConfigurationStatus-Payload-Autocollect-to_be_disabled_at) | Дата отключения автосбора. # Тип: DateTime | [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
### [DeviceConfigurationStatusGrouped](#keyapis-device-v1-DeviceConfigurationStatusGrouped)
Сгруппированный по устройству список конфигураций
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [device_id](#keyapis-device-v1-DeviceConfigurationStatusGrouped-device_id) | Идентификатор устройства | [int32](#scalar-types) | REQUIRED|
| [statuses](#keyapis-device-v1-DeviceConfigurationStatusGrouped-statuses) | Список конфигураций | repeated [keyapis.device.v1.DeviceConfigurationStatus](#keyapis-device-v1-DeviceConfigurationStatus) | REQUIRED|
### [DeviceConfigurationStatusGroupedFilter](#keyapis-device-v1-DeviceConfigurationStatusGroupedFilter)
Фильтр конфигураций сгруппированных по устройству
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [device_ids](#keyapis-device-v1-DeviceConfigurationStatusGroupedFilter-device_ids) | По идентификаторам устройства | repeated [int32](#scalar-types) | |
| [configuration_types](#keyapis-device-v1-DeviceConfigurationStatusGroupedFilter-configuration_types) | По типам конфигурации | repeated [keyapis.device.v1.DeviceConfigurationStatus.ConfigurationType](#keyapis-device-v1-DeviceConfigurationStatus-ConfigurationType) | |
| [status_types](#keyapis-device-v1-DeviceConfigurationStatusGroupedFilter-status_types) | По статусам конфигурации настройки | repeated [keyapis.device.v1.DeviceConfigurationStatus.StatusType](#keyapis-device-v1-DeviceConfigurationStatus-StatusType) | |
| [is_ready_for_retry](#keyapis-device-v1-DeviceConfigurationStatusGroupedFilter-is_ready_for_retry) | Флаг, указывающий на готовность настройки к конфигурированию. Значение next_retry_at меньше текущей даты | [google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [retry_count_less_then](#keyapis-device-v1-DeviceConfigurationStatusGroupedFilter-retry_count_less_then) | Пороговое значение количества попыток. Возвращает записи, у которых retry_count меньше этого значения | [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
### [DeviceConfigurationStatusGroupedPaging](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging)
Постраничный вывод конфигураций сгруппированных по устройству
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [order_by_type](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging-order_by_type) | Тип значения сортировки. Если значение не передано, то будет взято значение по умолчанию. # По умолчанию: DEVICE_ID | [keyapis.device.v1.DeviceConfigurationStatusGroupedPaging.OrderByType](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging-OrderByType) | |
| [direction_type](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging-direction_type) | Тип направления сортировки. # По умолчанию: DESC | [keyapis.device.v1.DeviceConfigurationStatusGroupedPaging.DirectionType](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging-DirectionType) | |
| [limit](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging-limit) | Количество записей на страницу. Если значение 0 (не передано), то будет взято значение по умолчанию. # Диапазон: 0..1000. # По умолчанию: 20 | [int32](#scalar-types) | |
| [offset](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging-offset) | Сдвиг. # Диапазон: 0..2147483647 | [int32](#scalar-types) | |
### [DeviceFilter](#keyapis-device-v1-DeviceFilter)
Фильтр устройств
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [owner_company_ids](#keyapis-device-v1-DeviceFilter-owner_company_ids) | По идентификаторам компании владельца | repeated [int32](#scalar-types) | |
| [text](#keyapis-device-v1-DeviceFilter-text) | Поиск по тексту. Если значение не передано то поиск по нему не производится. # Диапазон: 3..64. # Поиск производится по полям: # - Наименование; # - MAC-адрес; # - Список тегов устройства; # - Сетевой адрес; # - Серийный номер | [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [flatgramm_ids](#keyapis-device-v1-DeviceFilter-flatgramm_ids) | Идентификатор квартирограммы | repeated [int32](#scalar-types) | |
| [serial_numbers](#keyapis-device-v1-DeviceFilter-serial_numbers) | Серийный номер | repeated [string](#scalar-types) | |
| [device_status_types](#keyapis-device-v1-DeviceFilter-device_status_types) | Статус устройства | repeated [keyapis.device.v1.Device.StatusType](#keyapis-device-v1-Device-StatusType) | |
| [device_types](#keyapis-device-v1-DeviceFilter-device_types) | Тип назначения устройства | repeated [keyapis.device.v1.Device.Type](#keyapis-device-v1-Device-Type) | |
| [device_model_types](#keyapis-device-v1-DeviceFilter-device_model_types) | Модель устройства | repeated [keyapis.device.v1.Device.ModelType](#keyapis-device-v1-Device-ModelType) | |
| [is_concierge_enabled](#keyapis-device-v1-DeviceFilter-is_concierge_enabled) | Переадресация на консъержа | [google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [is_dispatching_enabled](#keyapis-device-v1-DeviceFilter-is_dispatching_enabled) | Диспетчеризация | [google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [dispatching_public_number](#keyapis-device-v1-DeviceFilter-dispatching_public_number) | Поиск по публичному номеру диспетчеризации. Если значение не передано то поиск по нему не производится. # Диапазон: 3..64 | [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [hardware_version](#keyapis-device-v1-DeviceFilter-hardware_version) | Версия аппаратного обеспенения. # Диапазон: 3..64 | [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [software_version](#keyapis-device-v1-DeviceFilter-software_version) | Версия программного обеспенения. # Диапазон: 3..64 | [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [is_autochange_password_enabled](#keyapis-device-v1-DeviceFilter-is_autochange_password_enabled) | Автозамена пароля | [google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [abc_number](#keyapis-device-v1-DeviceFilter-abc_number) | ABC-номер | repeated [string](#scalar-types) | |
| [camera_ids](#keyapis-device-v1-DeviceFilter-camera_ids) | Идентификаторы камер | repeated [string](#scalar-types) | |
| [sync_status_status_types](#keyapis-device-v1-DeviceFilter-sync_status_status_types) | Фильтр по статусу синхронизации (SyncStatus.status_type) | repeated [keyapis.device.v1.SyncStatus.StatusType](#keyapis-device-v1-SyncStatus-StatusType) | |
| [sync_retry_count_less_then](#keyapis-device-v1-DeviceFilter-sync_retry_count_less_then) | Пороговое значение количества попыток синхронизации. Возвращает записи, у которых sync_retry_count меньше этого значения | [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [begin_sync_successful_at](#keyapis-device-v1-DeviceFilter-begin_sync_successful_at) | От даты успешной синхронизации включительно (>=) | [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [end_sync_successful_at](#keyapis-device-v1-DeviceFilter-end_sync_successful_at) | До даты успешной синхронизации (<) | [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [begin_sync_at](#keyapis-device-v1-DeviceFilter-begin_sync_at) | От даты синхронизации включительно (>=) | [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
| [end_sync_at](#keyapis-device-v1-DeviceFilter-end_sync_at) | До даты синхронизации (<) | [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | |
### [DeviceLite](#keyapis-device-v1-DeviceLite)
Облегчённое устройство.
# Описание модели
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [id](#keyapis-device-v1-DeviceLite-id) | Идентификатор. # Диапазон: 0..2147483647 | [int32](#scalar-types) | |
| [type](#keyapis-device-v1-DeviceLite-type) | Тип назначения устройства | [keyapis.device.v1.Device.Type](#keyapis-device-v1-Device-Type) | REQUIRED|
| [title](#keyapis-device-v1-DeviceLite-title) | # Диапазон: 3..256 | [string](#scalar-types) | REQUIRED|
| [location](#keyapis-device-v1-DeviceLite-location) | Координаты | [keyapis.device.v1.Device.Location](#keyapis-device-v1-Device-Location) | |
| [status_type](#keyapis-device-v1-DeviceLite-status_type) | Статус устройства | [keyapis.device.v1.Device.StatusType](#keyapis-device-v1-Device-StatusType) | |
### [DevicePaging](#keyapis-device-v1-DevicePaging)
Постраничный вывод
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [order_by_type](#keyapis-device-v1-DevicePaging-order_by_type) | Тип значения сортировки. Если значение не передано, то будет взято значение по умолчанию. # По умолчанию: ID | [keyapis.device.v1.DevicePaging.OrderByType](#keyapis-device-v1-DevicePaging-OrderByType) | |
| [direction_type](#keyapis-device-v1-DevicePaging-direction_type) | Тип направления сортировки. # По умолчанию: DESC | [keyapis.device.v1.DevicePaging.DirectionType](#keyapis-device-v1-DevicePaging-DirectionType) | |
| [limit](#keyapis-device-v1-DevicePaging-limit) | Количество записей на страницу. Если значение 0 (не передано), то будет взято значение по умолчанию. # Диапазон: 0..100. # По умолчанию: 20 | [int32](#scalar-types) | |
| [offset](#keyapis-device-v1-DevicePaging-offset) | Сдвиг. # Диапазон: 0..2147483647 | [int32](#scalar-types) | |
### [GetDeviceConfigurationStatusGroupedCountRequest](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedCountRequest)
Запрос получения количества конфигураций сгруппированных по устройству
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [filter](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedCountRequest-filter) | Фильтр | [keyapis.device.v1.DeviceConfigurationStatusGroupedFilter](#keyapis-device-v1-DeviceConfigurationStatusGroupedFilter) | |
### [GetDeviceConfigurationStatusGroupedCountResponse](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedCountResponse)
Ответ на запрос получения количества конфигураций сгруппированных по устройству
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [data](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedCountResponse-data) | Количество | optional [int32](#scalar-types) | |
### [GetDeviceConfigurationStatusGroupedListRequest](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedListRequest)
Запрос получения списка конфигураций сгруппированных по устройству
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [filter](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedListRequest-filter) | Фильтр | [keyapis.device.v1.DeviceConfigurationStatusGroupedFilter](#keyapis-device-v1-DeviceConfigurationStatusGroupedFilter) | |
| [paging](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedListRequest-paging) | Стандартный постраничный вывод | optional [keyapis.device.v1.DeviceConfigurationStatusGroupedPaging](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging) | |
### [GetDeviceConfigurationStatusGroupedListResponse](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedListResponse)
Ответ на запрос получения списка конфигураций сгруппированных по устройству
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [data](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedListResponse-data) | Конфигурации устройства | optional [keyapis.device.v1.DeviceConfigurationStatusGrouped](#keyapis-device-v1-DeviceConfigurationStatusGrouped) | |
| [error](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedListResponse-error) | Ошибка | optional [keyapis.device.v1.GetDeviceConfigurationStatusGroupedListResponse.Error](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedListResponse-Error) | |
### [GetDeviceConfigurationStatusGroupedListResponse.Error](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedListResponse-Error)
Ошибка
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [validation](#keyapis-device-v1-GetDeviceConfigurationStatusGroupedListResponse-Error-validation) | Ошибка валидации | optional [keyapis.device.v1.ValidationError](#keyapis-device-v1-ValidationError) | |
### [GetDeviceConfigurationStatusesRequest](#keyapis-device-v1-GetDeviceConfigurationStatusesRequest)
Запрос получения статусов конфигурации устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [id](#keyapis-device-v1-GetDeviceConfigurationStatusesRequest-id) | Идентификатор | [int32](#scalar-types) | REQUIRED|
### [GetDeviceConfigurationStatusesResponse](#keyapis-device-v1-GetDeviceConfigurationStatusesResponse)
Ответ на запрос получения статусов конфигурации устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [data](#keyapis-device-v1-GetDeviceConfigurationStatusesResponse-data) | Устройство | optional [keyapis.device.v1.GetDeviceConfigurationStatusesResponse.Statuses](#keyapis-device-v1-GetDeviceConfigurationStatusesResponse-Statuses) | |
| [error](#keyapis-device-v1-GetDeviceConfigurationStatusesResponse-error) | Ошибка | optional [keyapis.device.v1.GetDeviceConfigurationStatusesResponse.Error](#keyapis-device-v1-GetDeviceConfigurationStatusesResponse-Error) | |
### [GetDeviceConfigurationStatusesResponse.Error](#keyapis-device-v1-GetDeviceConfigurationStatusesResponse-Error)
Ошибка
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [validation_error](#keyapis-device-v1-GetDeviceConfigurationStatusesResponse-Error-validation_error) | Ошибка валидации | optional [keyapis.device.v1.ValidationError](#keyapis-device-v1-ValidationError) | |
### [GetDeviceConfigurationStatusesResponse.Statuses](#keyapis-device-v1-GetDeviceConfigurationStatusesResponse-Statuses)
Статусы
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [device_configuration_statuses](#keyapis-device-v1-GetDeviceConfigurationStatusesResponse-Statuses-device_configuration_statuses) | Статусы конфигурации устройства | repeated [keyapis.device.v1.DeviceConfigurationStatus](#keyapis-device-v1-DeviceConfigurationStatus) | |
| [camera_status](#keyapis-device-v1-GetDeviceConfigurationStatusesResponse-Statuses-camera_status) | Статус камеры | [keyapis.device.v1.CameraStatus](#keyapis-device-v1-CameraStatus) | |
| [sync_status](#keyapis-device-v1-GetDeviceConfigurationStatusesResponse-Statuses-sync_status) | Статус синхронизации | [keyapis.device.v1.SyncStatus](#keyapis-device-v1-SyncStatus) | |
| [device_status_type](#keyapis-device-v1-GetDeviceConfigurationStatusesResponse-Statuses-device_status_type) | Статус устройства | [keyapis.device.v1.Device.StatusType](#keyapis-device-v1-Device-StatusType) | |
### [GetDeviceCountRequest](#keyapis-device-v1-GetDeviceCountRequest)
Запрос получения количества устройств
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [filter](#keyapis-device-v1-GetDeviceCountRequest-filter) | Фильтр | [keyapis.device.v1.DeviceFilter](#keyapis-device-v1-DeviceFilter) | |
### [GetDeviceCountResponse](#keyapis-device-v1-GetDeviceCountResponse)
Ответ на запрос получения количества устройств
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [data](#keyapis-device-v1-GetDeviceCountResponse-data) | Количество | optional [int32](#scalar-types) | |
| [error](#keyapis-device-v1-GetDeviceCountResponse-error) | Ошибка | optional [keyapis.device.v1.GetDeviceCountResponse.Error](#keyapis-device-v1-GetDeviceCountResponse-Error) | |
### [GetDeviceCountResponse.Error](#keyapis-device-v1-GetDeviceCountResponse-Error)
Ошибка
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [validation](#keyapis-device-v1-GetDeviceCountResponse-Error-validation) | Ошибка валидации | optional [keyapis.device.v1.ValidationError](#keyapis-device-v1-ValidationError) | |
### [GetDeviceListRequest](#keyapis-device-v1-GetDeviceListRequest)
Запрос получения списка устройств
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [filter](#keyapis-device-v1-GetDeviceListRequest-filter) | Фильтр | [keyapis.device.v1.DeviceFilter](#keyapis-device-v1-DeviceFilter) | |
| [paging](#keyapis-device-v1-GetDeviceListRequest-paging) | Пагинация | optional [keyapis.device.v1.DevicePaging](#keyapis-device-v1-DevicePaging) | |
### [GetDeviceListResponse](#keyapis-device-v1-GetDeviceListResponse)
Ответ на запрос получения списка устройств
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [data](#keyapis-device-v1-GetDeviceListResponse-data) | Устройство | optional [keyapis.device.v1.Device](#keyapis-device-v1-Device) | |
| [error](#keyapis-device-v1-GetDeviceListResponse-error) | Ошибка | optional [keyapis.device.v1.GetDeviceListResponse.Error](#keyapis-device-v1-GetDeviceListResponse-Error) | |
### [GetDeviceListResponse.Error](#keyapis-device-v1-GetDeviceListResponse-Error)
Ошибка запроса на получение списка устройств
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [validation](#keyapis-device-v1-GetDeviceListResponse-Error-validation) | Ошибка валидации | optional [keyapis.device.v1.ValidationError](#keyapis-device-v1-ValidationError) | |
### [GetDeviceLiteRequest](#keyapis-device-v1-GetDeviceLiteRequest)
Запрос получения устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [id](#keyapis-device-v1-GetDeviceLiteRequest-id) | Идентификатор | [int32](#scalar-types) | REQUIRED|
### [GetDeviceLiteResponse](#keyapis-device-v1-GetDeviceLiteResponse)
Ответ на запрос получения устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [data](#keyapis-device-v1-GetDeviceLiteResponse-data) | Устройство | optional [keyapis.device.v1.DeviceLite](#keyapis-device-v1-DeviceLite) | |
### [GetDeviceRequest](#keyapis-device-v1-GetDeviceRequest)
Запрос получения устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [id](#keyapis-device-v1-GetDeviceRequest-id) | Идентификатор | [int32](#scalar-types) | REQUIRED|
### [GetDeviceResponse](#keyapis-device-v1-GetDeviceResponse)
Ответ на запрос получения устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [data](#keyapis-device-v1-GetDeviceResponse-data) | Устройство | optional [keyapis.device.v1.Device](#keyapis-device-v1-Device) | |
### [PostDeviceConfigurationStatusRequest](#keyapis-device-v1-PostDeviceConfigurationStatusRequest)
Запрос на изменение статуса конфигурации устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [data](#keyapis-device-v1-PostDeviceConfigurationStatusRequest-data) | Статус конфигурации устройства | [keyapis.device.v1.DeviceConfigurationStatus](#keyapis-device-v1-DeviceConfigurationStatus) | REQUIRED|
### [PostDeviceConfigurationStatusResponse](#keyapis-device-v1-PostDeviceConfigurationStatusResponse)
Ответ на запрос на изменение статуса конфигурации устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [data](#keyapis-device-v1-PostDeviceConfigurationStatusResponse-data) | Статус конфигурации устройства | optional [keyapis.device.v1.DeviceConfigurationStatus](#keyapis-device-v1-DeviceConfigurationStatus) | |
| [error](#keyapis-device-v1-PostDeviceConfigurationStatusResponse-error) | Ошибка | optional [keyapis.device.v1.PostDeviceConfigurationStatusResponse.Error](#keyapis-device-v1-PostDeviceConfigurationStatusResponse-Error) | |
### [PostDeviceConfigurationStatusResponse.Error](#keyapis-device-v1-PostDeviceConfigurationStatusResponse-Error)
Ошибка запроса сохранения статуса конфигурации устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [validation](#keyapis-device-v1-PostDeviceConfigurationStatusResponse-Error-validation) | Ошибка валидации | optional [keyapis.device.v1.ValidationError](#keyapis-device-v1-ValidationError) | |
### [PostDeviceInstallPresetRequest](#keyapis-device-v1-PostDeviceInstallPresetRequest)
Запрос установки пресета на устройство
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [id](#keyapis-device-v1-PostDeviceInstallPresetRequest-id) | Идентификатор | [int32](#scalar-types) | REQUIRED|
### [PostDeviceInstallPresetResponse](#keyapis-device-v1-PostDeviceInstallPresetResponse)
Ответ на запрос установки пресета на устройство
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [error](#keyapis-device-v1-PostDeviceInstallPresetResponse-error) | Ошибка при установке пресета | optional [keyapis.device.v1.PostDeviceInstallPresetResponse.Error](#keyapis-device-v1-PostDeviceInstallPresetResponse-Error) | |
### [PostDeviceInstallPresetResponse.Error](#keyapis-device-v1-PostDeviceInstallPresetResponse-Error)
Ошибка при установке пресета
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [preset_status_is_processing](#keyapis-device-v1-PostDeviceInstallPresetResponse-Error-preset_status_is_processing) | Пресет в процессе установки | optional [keyapis.device.v1.PostDeviceInstallPresetResponse.Error.PresetStatusIsProcessing](#keyapis-device-v1-PostDeviceInstallPresetResponse-Error-PresetStatusIsProcessing) | |
### [PostDeviceInstallPresetResponse.Error.PresetStatusIsProcessing](#keyapis-device-v1-PostDeviceInstallPresetResponse-Error-PresetStatusIsProcessing)
Пресет в процессе установки
### [PostDeviceReconfigureRequest](#keyapis-device-v1-PostDeviceReconfigureRequest)
Запрос на переконфигурирование устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [id](#keyapis-device-v1-PostDeviceReconfigureRequest-id) | Идентификатор устройства | [int32](#scalar-types) | REQUIRED|
### [PostDeviceReconfigureResponse](#keyapis-device-v1-PostDeviceReconfigureResponse)
Ответ на запрос на переконфигурирование устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [error](#keyapis-device-v1-PostDeviceReconfigureResponse-error) | Ошибка переконфигурирования устройства | optional [keyapis.device.v1.PostDeviceReconfigureResponse.Error](#keyapis-device-v1-PostDeviceReconfigureResponse-Error) | |
### [PostDeviceReconfigureResponse.Error](#keyapis-device-v1-PostDeviceReconfigureResponse-Error)
Ошибка переконфигурирования устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [validation_error](#keyapis-device-v1-PostDeviceReconfigureResponse-Error-validation_error) | Ошибка валидации | optional [keyapis.device.v1.ValidationError](#keyapis-device-v1-ValidationError) | |
| [reinstall_error](#keyapis-device-v1-PostDeviceReconfigureResponse-Error-reinstall_error) | Ошибка реинстала | optional [keyapis.device.v1.ReinstallError](#keyapis-device-v1-ReinstallError) | |
### [PostDeviceReplaceRequest](#keyapis-device-v1-PostDeviceReplaceRequest)
Запрос на замену устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [id](#keyapis-device-v1-PostDeviceReplaceRequest-id) | Идентификатор устройства | [int32](#scalar-types) | REQUIRED|
| [host](#keyapis-device-v1-PostDeviceReplaceRequest-host) | Хост | [string](#scalar-types) | |
| [mac_address](#keyapis-device-v1-PostDeviceReplaceRequest-mac_address) | MAC-адрес. # Диапазон: 17..17. # Паттерн: /^([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})$/ | [string](#scalar-types) | REQUIRED|
| [serial_number](#keyapis-device-v1-PostDeviceReplaceRequest-serial_number) | Серийный номер | [string](#scalar-types) | REQUIRED|
| [login](#keyapis-device-v1-PostDeviceReplaceRequest-login) | Логин (для модели спутник) | [string](#scalar-types) | |
### [PostDeviceReplaceResponse](#keyapis-device-v1-PostDeviceReplaceResponse)
Ответ на запрос на замену устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [error](#keyapis-device-v1-PostDeviceReplaceResponse-error) | Ошибка замены устройства | optional [keyapis.device.v1.PostDeviceReplaceResponse.Error](#keyapis-device-v1-PostDeviceReplaceResponse-Error) | |
### [PostDeviceReplaceResponse.Error](#keyapis-device-v1-PostDeviceReplaceResponse-Error)
Ошибка замены устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [validation_error](#keyapis-device-v1-PostDeviceReplaceResponse-Error-validation_error) | Ошибка валидации | optional [keyapis.device.v1.ValidationError](#keyapis-device-v1-ValidationError) | |
| [host_exists](#keyapis-device-v1-PostDeviceReplaceResponse-Error-host_exists) | На платформе уже существует устройство с таким хостом | optional [keyapis.device.v1.PostDeviceReplaceResponse.Error.HostExists](#keyapis-device-v1-PostDeviceReplaceResponse-Error-HostExists) | |
| [mac_address_exists](#keyapis-device-v1-PostDeviceReplaceResponse-Error-mac_address_exists) | На платформе уже существует устройство с таким MAC-адресом | optional [keyapis.device.v1.PostDeviceReplaceResponse.Error.MacAddressExists](#keyapis-device-v1-PostDeviceReplaceResponse-Error-MacAddressExists) | |
| [serial_number_exists](#keyapis-device-v1-PostDeviceReplaceResponse-Error-serial_number_exists) | На платформе уже существует устройство с таким серийным номером | optional [keyapis.device.v1.PostDeviceReplaceResponse.Error.SerialNumberExists](#keyapis-device-v1-PostDeviceReplaceResponse-Error-SerialNumberExists) | |
| [login_exists](#keyapis-device-v1-PostDeviceReplaceResponse-Error-login_exists) | На платформе уже существует устройство с таким логином (для устройст модели "Спутник") | optional [keyapis.device.v1.PostDeviceReplaceResponse.Error.LoginExists](#keyapis-device-v1-PostDeviceReplaceResponse-Error-LoginExists) | |
| [login_is_required](#keyapis-device-v1-PostDeviceReplaceResponse-Error-login_is_required) | Отсутствует поле Login для модели "Спутник" | optional [keyapis.device.v1.PostDeviceReplaceResponse.Error.LoginIsRequired](#keyapis-device-v1-PostDeviceReplaceResponse-Error-LoginIsRequired) | |
| [reinstall_error](#keyapis-device-v1-PostDeviceReplaceResponse-Error-reinstall_error) | Ошибка реинстала | optional [keyapis.device.v1.ReinstallError](#keyapis-device-v1-ReinstallError) | |
### [PostDeviceReplaceResponse.Error.HostExists](#keyapis-device-v1-PostDeviceReplaceResponse-Error-HostExists)
На платформе уже существует устройство с таким хостом
### [PostDeviceReplaceResponse.Error.LoginExists](#keyapis-device-v1-PostDeviceReplaceResponse-Error-LoginExists)
На платформе уже существует устройство с таким логином (для устройст модели "Спутник")
### [PostDeviceReplaceResponse.Error.LoginIsRequired](#keyapis-device-v1-PostDeviceReplaceResponse-Error-LoginIsRequired)
Отсутствует поле Login для модели "Спутник"
### [PostDeviceReplaceResponse.Error.MacAddressExists](#keyapis-device-v1-PostDeviceReplaceResponse-Error-MacAddressExists)
На платформе уже существует устройство с таким MAC-адресом
### [PostDeviceReplaceResponse.Error.SerialNumberExists](#keyapis-device-v1-PostDeviceReplaceResponse-Error-SerialNumberExists)
На платформе уже существует устройство с таким серийным номером
### [PostDeviceRequest](#keyapis-device-v1-PostDeviceRequest)
Запрос на создание/изменение устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [data](#keyapis-device-v1-PostDeviceRequest-data) | Устройство | [keyapis.device.v1.Device](#keyapis-device-v1-Device) | REQUIRED|
### [PostDeviceResponse](#keyapis-device-v1-PostDeviceResponse)
Ответ на запрос на создание/изменение устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [data](#keyapis-device-v1-PostDeviceResponse-data) | Устройство | optional [keyapis.device.v1.Device](#keyapis-device-v1-Device) | |
| [error](#keyapis-device-v1-PostDeviceResponse-error) | Ошибка | optional [keyapis.device.v1.PostDeviceResponse.Error](#keyapis-device-v1-PostDeviceResponse-Error) | |
### [PostDeviceResponse.Error](#keyapis-device-v1-PostDeviceResponse-Error)
Ошибка запроса сохранения устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [validation](#keyapis-device-v1-PostDeviceResponse-Error-validation) | Ошибка валидации | optional [keyapis.device.v1.ValidationError](#keyapis-device-v1-ValidationError) | |
| [saving](#keyapis-device-v1-PostDeviceResponse-Error-saving) | Ошибка сохранения | optional [keyapis.device.v1.Device.SavingError](#keyapis-device-v1-Device-SavingError) | |
### [Preset](#keyapis-device-v1-Preset)
Пресет.
Пресет с id=1 устанавливается при создании устройства по умолчанию
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [id](#keyapis-device-v1-Preset-id) | Идентификатор. # Диапазон: 1..2147483647 | [int32](#scalar-types) | |
| [title](#keyapis-device-v1-Preset-title) | Наименование. # Диапазон: 3..256 | [string](#scalar-types) | REQUIRED|
| [mrf_ids](#keyapis-device-v1-Preset-mrf_ids) | Идентификатор МРФ. # Диапазон: 0..10 | repeated [int32](#scalar-types) | REQUIRED|
| [rf_ids](#keyapis-device-v1-Preset-rf_ids) | Идентификатор РФ. # Диапазон: 0..100 | repeated [int32](#scalar-types) | REQUIRED|
| [description](#keyapis-device-v1-Preset-description) | Описание. # Диапазон: 3..1024 | [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OPTIONAL|
| [created_at](#keyapis-device-v1-Preset-created_at) | Дата и время создания. # Тип: DateTime | [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| [changed_at](#keyapis-device-v1-Preset-changed_at) | Дата последнего изменения. Заполняется и обновляется сервером. Заполняется при создании и изменении. Является версией объекта. # Тип: DateTime | [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| [status_type](#keyapis-device-v1-Preset-status_type) | Статус | [keyapis.device.v1.Preset.StatusType](#keyapis-device-v1-Preset-StatusType) | REQUIRED|
| [sip](#keyapis-device-v1-Preset-sip) | Параметр SIP | [keyapis.device.v1.Preset.Sip](#keyapis-device-v1-Preset-Sip) | REQUIRED|
| [ntp](#keyapis-device-v1-Preset-ntp) | Параметр NTP | [keyapis.device.v1.Preset.Ntp](#keyapis-device-v1-Preset-Ntp) | REQUIRED|
| [syslog](#keyapis-device-v1-Preset-syslog) | Параметр Syslog | [keyapis.device.v1.Preset.Syslog](#keyapis-device-v1-Preset-Syslog) | REQUIRED|
| [rooms](#keyapis-device-v1-Preset-rooms) | Помещения. # Диапазон: 0..10000 | repeated [keyapis.device.v1.Preset.Room](#keyapis-device-v1-Preset-Room) | REQUIRED|
| [video_config](#keyapis-device-v1-Preset-video_config) | Параметры конфигурации видео | [keyapis.device.v1.Preset.VideoConfig](#keyapis-device-v1-Preset-VideoConfig) | REQUIRED|
| [dtmf](#keyapis-device-v1-Preset-dtmf) | Параметр DTMF. # Диапазон: 0..64 | repeated [keyapis.device.v1.Preset.Dtmf](#keyapis-device-v1-Preset-Dtmf) | REQUIRED|
| [face_recognition](#keyapis-device-v1-Preset-face_recognition) | Распознование лиц | [keyapis.device.v1.Preset.FaceRecognition](#keyapis-device-v1-Preset-FaceRecognition) | |
### [Preset.Dtmf](#keyapis-device-v1-Preset-Dtmf)
Параметр DTMF
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [code](#keyapis-device-v1-Preset-Dtmf-code) | Код. # Диапазон: 1..1 | [string](#scalar-types) | REQUIRED|
| [relay_index](#keyapis-device-v1-Preset-Dtmf-relay_index) | Индекс реле. # Диапазон: 0..64 | [int32](#scalar-types) | |
### [Preset.FaceRecognition](#keyapis-device-v1-Preset-FaceRecognition)
Распознование лиц
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [host](#keyapis-device-v1-Preset-FaceRecognition-host) | Адрес | [string](#scalar-types) | REQUIRED|
| [alt_host](#keyapis-device-v1-Preset-FaceRecognition-alt_host) | Альтернативный адрес | [string](#scalar-types) | |
| [endpoint](#keyapis-device-v1-Preset-FaceRecognition-endpoint) | Путь запроса к серверу | [string](#scalar-types) | REQUIRED|
| [auth_token](#keyapis-device-v1-Preset-FaceRecognition-auth_token) | Токен | [string](#scalar-types) | REQUIRED|
| [configuration_type](#keyapis-device-v1-Preset-FaceRecognition-configuration_type) | Тип конфигурации | [keyapis.device.v1.Preset.FaceRecognition.ConfigurationType](#keyapis-device-v1-Preset-FaceRecognition-ConfigurationType) | REQUIRED|
| [origin_id](#keyapis-device-v1-Preset-FaceRecognition-origin_id) | Идентификатор источника в identix | [string](#scalar-types) | REQUIRED|
| [group_ids](#keyapis-device-v1-Preset-FaceRecognition-group_ids) | Идентификаторы групп профилей в identix | repeated [int32](#scalar-types) | |
### [Preset.Ntp](#keyapis-device-v1-Preset-Ntp)
Параметр NTP
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [host](#keyapis-device-v1-Preset-Ntp-host) | Хост. # Диапазон: 5..256 | [string](#scalar-types) | REQUIRED|
| [port](#keyapis-device-v1-Preset-Ntp-port) | Порт. # Диапазон: 1..65536 | [int32](#scalar-types) | REQUIRED|
### [Preset.Room](#keyapis-device-v1-Preset-Room)
Помещение
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [phone](#keyapis-device-v1-Preset-Room-phone) | Номер телефона. # Диапазон: 5..14 | [string](#scalar-types) | REQUIRED|
| [num](#keyapis-device-v1-Preset-Room-num) | Номер помещения. # Диапазон: 1..10000 | [int32](#scalar-types) | REQUIRED|
### [Preset.SavingError](#keyapis-device-v1-Preset-SavingError)
Ошибка сохранения.
Эти проверки выполняются при работе с базой данных и сторонними сервисами
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [conflict](#keyapis-device-v1-Preset-SavingError-conflict) | Конфликт версий | optional [keyapis.device.v1.Preset.SavingError.Conflict](#keyapis-device-v1-Preset-SavingError-Conflict) | |
| [not_allowed_for_default](#keyapis-device-v1-Preset-SavingError-not_allowed_for_default) | Запрещено для дефолтного пресета | optional [keyapis.device.v1.Preset.SavingError.NotAllowedForDefault](#keyapis-device-v1-Preset-SavingError-NotAllowedForDefault) | |
### [Preset.SavingError.Conflict](#keyapis-device-v1-Preset-SavingError-Conflict)
Конфликт версий.
Причины:
- В базе хранится другая версия строки, значения changed_at отличаются
### [Preset.SavingError.NotAllowedForDefault](#keyapis-device-v1-Preset-SavingError-NotAllowedForDefault)
Недоступно для дефолтного пресета.
Причины:
- Смена статуса на Архивный
### [Preset.Sip](#keyapis-device-v1-Preset-Sip)
Параметр SIP
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [host](#keyapis-device-v1-Preset-Sip-host) | Хост. # Диапазон: 5..256 | [string](#scalar-types) | REQUIRED|
| [port](#keyapis-device-v1-Preset-Sip-port) | Порт. # Диапазон: 1..65536 | [int32](#scalar-types) | REQUIRED|
| [reg_host](#keyapis-device-v1-Preset-Sip-reg_host) | Хост reg. # Диапазон: 5..256 | [string](#scalar-types) | REQUIRED|
| [reg_port](#keyapis-device-v1-Preset-Sip-reg_port) | Порт reg. # Диапазон: 1..65536 | [int32](#scalar-types) | REQUIRED|
| [proxy_host](#keyapis-device-v1-Preset-Sip-proxy_host) | Хост proxy. # Диапазон: 5..256 | [string](#scalar-types) | REQUIRED|
| [proxy_port](#keyapis-device-v1-Preset-Sip-proxy_port) | Порт proxy. # Диапазон: 1..65536 | [int32](#scalar-types) | REQUIRED|
### [Preset.Syslog](#keyapis-device-v1-Preset-Syslog)
Параметр Syslog
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [host](#keyapis-device-v1-Preset-Syslog-host) | Хост. # Диапазон: 5..256 | [string](#scalar-types) | REQUIRED|
| [port](#keyapis-device-v1-Preset-Syslog-port) | Порт. # Диапазон: 1..65536 | [int32](#scalar-types) | REQUIRED|
| [protocol_type](#keyapis-device-v1-Preset-Syslog-protocol_type) | Протокол | [keyapis.device.v1.Preset.Syslog.ProtocolType](#keyapis-device-v1-Preset-Syslog-ProtocolType) | REQUIRED|
### [Preset.VideoConfig](#keyapis-device-v1-Preset-VideoConfig)
Параметры конфигурации видео
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [quality_type](#keyapis-device-v1-Preset-VideoConfig-quality_type) | Тип пресета | [keyapis.device.v1.Preset.VideoConfig.QualityType](#keyapis-device-v1-Preset-VideoConfig-QualityType) | REQUIRED|
| [rtsp_user](#keyapis-device-v1-Preset-VideoConfig-rtsp_user) | Пользователь | [keyapis.device.v1.Preset.VideoConfig.RtspUser](#keyapis-device-v1-Preset-VideoConfig-RtspUser) | REQUIRED|
### [Preset.VideoConfig.RtspUser](#keyapis-device-v1-Preset-VideoConfig-RtspUser)
Пользователь
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [username](#keyapis-device-v1-Preset-VideoConfig-RtspUser-username) | Имя пользователя. # Диапазон: 3..256 | [string](#scalar-types) | REQUIRED|
| [password](#keyapis-device-v1-Preset-VideoConfig-RtspUser-password) | Пароль. # Диапазон: 3..256 | [string](#scalar-types) | REQUIRED|
### [PutDeviceRequest](#keyapis-device-v1-PutDeviceRequest)
Запрос изменения устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [id](#keyapis-device-v1-PutDeviceRequest-id) | Идентификатор устройства | [int32](#scalar-types) | REQUIRED|
| [preset_id](#keyapis-device-v1-PutDeviceRequest-preset_id) | Идентификатор пресета | [int32](#scalar-types) | OPTIONAL|
| [is_sl3_mode_enabled](#keyapis-device-v1-PutDeviceRequest-is_sl3_mode_enabled) | Настройка режима SL3 | [bool](#scalar-types) | OPTIONAL|
### [PutDeviceResponse](#keyapis-device-v1-PutDeviceResponse)
ответ на завпрос изменения устройства
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [data](#keyapis-device-v1-PutDeviceResponse-data) | Устройство | optional [keyapis.device.v1.Device](#keyapis-device-v1-Device) | |
### [ReinstallError](#keyapis-device-v1-ReinstallError)
Ошибки реинстала
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [sip_login_is_missing](#keyapis-device-v1-ReinstallError-sip_login_is_missing) | Сип-логин отсутствует на устройстве | optional [keyapis.device.v1.ReinstallError.SipLoginIsMissing](#keyapis-device-v1-ReinstallError-SipLoginIsMissing) | |
### [ReinstallError.SipLoginIsMissing](#keyapis-device-v1-ReinstallError-SipLoginIsMissing)
Сип-логин отсутствует на устройстве
### [SyncStatus](#keyapis-device-v1-SyncStatus)
Статус синхронизации.
# Описание модели
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [status_type](#keyapis-device-v1-SyncStatus-status_type) | Статус синхронизации | [keyapis.device.v1.SyncStatus.StatusType](#keyapis-device-v1-SyncStatus-StatusType) | OUTPUT_ONLY|
| [error_message](#keyapis-device-v1-SyncStatus-error_message) | Сообщение об ошибке | [string](#scalar-types) | OUTPUT_ONLY|
| [retry_count](#keyapis-device-v1-SyncStatus-retry_count) | Количество попыток | [int32](#scalar-types) | OUTPUT_ONLY|
| [successful_at](#keyapis-device-v1-SyncStatus-successful_at) | Дата последней успешной синхронизации. # Тип: DateTime | [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| [sync_at](#keyapis-device-v1-SyncStatus-sync_at) | Дата последней синхронизации. # Тип: DateTime | [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
### [ValidationError](#keyapis-device-v1-ValidationError)
Ошибки валидации.
Эти проверки выполняются до обращения в базу данных
| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| [path](#keyapis-device-v1-ValidationError-path) | Путь к полю в формате наименования прото | [string](#scalar-types) | REQUIRED|
| [message](#keyapis-device-v1-ValidationError-message) | Валидационное сообщение | [string](#scalar-types) | REQUIRED|
### [CameraStatus.StatusType](#keyapis-device-v1-CameraStatus-StatusType)
Статус камеры.
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [STATUS_TYPE_UNKNOWN](#keyapis-device-v1-CameraStatus-StatusType-STATUS_TYPE_UNKNOWN) | Значение не указано |
| 1 | [PROCESSING](#keyapis-device-v1-CameraStatus-StatusType-PROCESSING) | В процессе регистрации |
| 2 | [PROCESSING_ERROR](#keyapis-device-v1-CameraStatus-StatusType-PROCESSING_ERROR) | Ошибка регистрации |
| 3 | [ACTIVE](#keyapis-device-v1-CameraStatus-StatusType-ACTIVE) | Активна |
### [Device.Credentials.UserAccessType](#keyapis-device-v1-Device-Credentials-UserAccessType)
Тип доступа пользователя.
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [USER_ACCESS_TYPE_UNKNOWN](#keyapis-device-v1-Device-Credentials-UserAccessType-USER_ACCESS_TYPE_UNKNOWN) | Значение не указано |
| 1 | [API](#keyapis-device-v1-Device-Credentials-UserAccessType-API) | Доступ к api |
| 2 | [WEB](#keyapis-device-v1-Device-Credentials-UserAccessType-WEB) | Доступ к web-интерфейсу |
| 3 | [RTSP](#keyapis-device-v1-Device-Credentials-UserAccessType-RTSP) | Доступ к rtsp-потоку |
| 4 | [SU](#keyapis-device-v1-Device-Credentials-UserAccessType-SU) | Полный доступ |
### [Device.ModelType](#keyapis-device-v1-Device-ModelType)
Модель устройства.
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [MODEL_TYPE_UNKNOWN](#keyapis-device-v1-Device-ModelType-MODEL_TYPE_UNKNOWN) | Значение не указано |
| 1 | [RODOS8](#keyapis-device-v1-Device-ModelType-RODOS8) | Модель RODOS-8 |
| 2 | [BEWARD](#keyapis-device-v1-Device-ModelType-BEWARD) | Модель Beward |
| 3 | [QTECH](#keyapis-device-v1-Device-ModelType-QTECH) | Модель QTECH |
| 4 | [NATEKS](#keyapis-device-v1-Device-ModelType-NATEKS) | Модель Натекс |
| 5 | [TNB](#keyapis-device-v1-Device-ModelType-TNB) | Модель ТНБ |
| 6 | [MAXETLINE](#keyapis-device-v1-Device-ModelType-MAXETLINE) | Модель Maxet Line |
| 7 | [TNB_DO2](#keyapis-device-v1-Device-ModelType-TNB_DO2) | Модель Двойная открывашка |
| 8 | [BEWARD_DS86017CP](#keyapis-device-v1-Device-ModelType-BEWARD_DS86017CP) | Модель Beward DS86017CP |
| 9 | [BEWARD_DS85006MP](#keyapis-device-v1-Device-ModelType-BEWARD_DS85006MP) | Модель Beward DS85006MP |
| 10 | [DAHUA_VTO2101E_P](#keyapis-device-v1-Device-ModelType-DAHUA_VTO2101E_P) | Модель Dahua DHI-VTO2101E-P |
| 11 | [HIKVISION_DS_KV8155_IM](#keyapis-device-v1-Device-ModelType-HIKVISION_DS_KV8155_IM) | Модель Hikvision DS-KV8155-IM |
| 12 | [RODOS8_2](#keyapis-device-v1-Device-ModelType-RODOS8_2) | Модель RODOS-8-2 |
| 13 | [AKUVOX_R29C](#keyapis-device-v1-Device-ModelType-AKUVOX_R29C) | Модель Akuvox R29C |
| 14 | [SAFE_LOGIC](#keyapis-device-v1-Device-ModelType-SAFE_LOGIC) | Модель Safe-logic |
| 15 | [BEWARD_DS86006AP](#keyapis-device-v1-Device-ModelType-BEWARD_DS86006AP) | Модель Beward DS86006AP |
| 16 | [SPUTNIK_IO](#keyapis-device-v1-Device-ModelType-SPUTNIK_IO) | Модель Спутник Ио |
| 17 | [BEWARD_FR](#keyapis-device-v1-Device-ModelType-BEWARD_FR) | Модель Beward c FR |
| 18 | [QTECH_FR](#keyapis-device-v1-Device-ModelType-QTECH_FR) | Модель QTECH с FR |
| 19 | [ELTEX_IPA_ER_010](#keyapis-device-v1-Device-ModelType-ELTEX_IPA_ER_010) | Модель Eltex IPA-ER-10 |
| 20 | [BEWARD_MIFARE](#keyapis-device-v1-Device-ModelType-BEWARD_MIFARE) | Модель Beward с новым API ключей |
| 21 | [BAS_IP_AA_12FB](#keyapis-device-v1-Device-ModelType-BAS_IP_AA_12FB) | Модель BAS-IP AA-12FB |
| 22 | [AKUVOX_X915S](#keyapis-device-v1-Device-ModelType-AKUVOX_X915S) | Модель Akuvox X915S |
| 23 | [RUBETEK_RV_3434](#keyapis-device-v1-Device-ModelType-RUBETEK_RV_3434) | Модель Rubetek RV-3434 |
| 24 | [SOKOL_PLUS](#keyapis-device-v1-Device-ModelType-SOKOL_PLUS) | Модель Сокол плюс |
| 25 | [BEWARD_LOW_COST](#keyapis-device-v1-Device-ModelType-BEWARD_LOW_COST) | Модель Beward Эконом |
### [Device.PresetStatusType](#keyapis-device-v1-Device-PresetStatusType)
**Deprecated.** Справочник статусов установки пресета.
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [PRESET_STATUS_TYPE_UNKNOWN](#keyapis-device-v1-Device-PresetStatusType-PRESET_STATUS_TYPE_UNKNOWN) | **Deprecated.** Значение не указано |
| 1 | [PROCESSING](#keyapis-device-v1-Device-PresetStatusType-PROCESSING) | **Deprecated.** Устанавливается |
| 2 | [SUCCESS](#keyapis-device-v1-Device-PresetStatusType-SUCCESS) | **Deprecated.** Установлен |
| 3 | [ERROR](#keyapis-device-v1-Device-PresetStatusType-ERROR) | **Deprecated.** Ошибка |
### [Device.SipTrunk.SipType](#keyapis-device-v1-Device-SipTrunk-SipType)
Тип сети связи.
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [SIP_TYPE_UNKNOWN](#keyapis-device-v1-Device-SipTrunk-SipType-SIP_TYPE_UNKNOWN) | Значение не указано |
| 1 | [VIMS](#keyapis-device-v1-Device-SipTrunk-SipType-VIMS) | Тип Viprtual IP Multimedia Subsystem |
| 2 | [NGN](#keyapis-device-v1-Device-SipTrunk-SipType-NGN) | Тип Next Generation Networks |
### [Device.StatusType](#keyapis-device-v1-Device-StatusType)
Справочник статусов устройства.
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [STATUS_TYPE_UNKNOWN](#keyapis-device-v1-Device-StatusType-STATUS_TYPE_UNKNOWN) | Значение не указано |
| 1 | [OFFLINE](#keyapis-device-v1-Device-StatusType-OFFLINE) | Не в сети |
| 2 | [ONLINE](#keyapis-device-v1-Device-StatusType-ONLINE) | В сети |
### [Device.Type](#keyapis-device-v1-Device-Type)
Справочник назначений типов устройств (в качестве чего выступает устройство).
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [TYPE_UNKNOWN](#keyapis-device-v1-Device-Type-TYPE_UNKNOWN) | Значение не указано |
| 1 | [INTERCOM](#keyapis-device-v1-Device-Type-INTERCOM) | Домофон |
| 2 | [VIDEOCAMERA](#keyapis-device-v1-Device-Type-VIDEOCAMERA) | **Deprecated.** Видеокамера |
| 3 | [BARRIER](#keyapis-device-v1-Device-Type-BARRIER) | Шлагбаум |
| 4 | [GATE](#keyapis-device-v1-Device-Type-GATE) | Калитка |
| 5 | [ACCESS_CONTROL_PANEL](#keyapis-device-v1-Device-Type-ACCESS_CONTROL_PANEL) | **Deprecated.** СКУД |
| 6 | [OUTDOOR_CAMERA](#keyapis-device-v1-Device-Type-OUTDOOR_CAMERA) | **Deprecated.** Наружняя видеокамера |
### [DeviceConfigurationStatus.ConfigurationType](#keyapis-device-v1-DeviceConfigurationStatus-ConfigurationType)
Тип конфигурации.
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [CONFIGURATION_TYPE_UNKNOWN](#keyapis-device-v1-DeviceConfigurationStatus-ConfigurationType-CONFIGURATION_TYPE_UNKNOWN) | Значение не указано |
| 1 | [PRESET](#keyapis-device-v1-DeviceConfigurationStatus-ConfigurationType-PRESET) | Пресет |
| 2 | [SIP_ACCOUNT](#keyapis-device-v1-DeviceConfigurationStatus-ConfigurationType-SIP_ACCOUNT) | Сип-аккаунт |
| 3 | [SIP_ROOMS](#keyapis-device-v1-DeviceConfigurationStatus-ConfigurationType-SIP_ROOMS) | сип-номера в помещениях |
| 4 | [GATE](#keyapis-device-v1-DeviceConfigurationStatus-ConfigurationType-GATE) | Калитка |
| 5 | [RFIDS](#keyapis-device-v1-DeviceConfigurationStatus-ConfigurationType-RFIDS) | Ключи |
| 6 | [CODES](#keyapis-device-v1-DeviceConfigurationStatus-ConfigurationType-CODES) | Коды |
| 7 | [FACE_RECOGNITION](#keyapis-device-v1-DeviceConfigurationStatus-ConfigurationType-FACE_RECOGNITION) | Распознование лиц |
| 8 | [CONCIERGE](#keyapis-device-v1-DeviceConfigurationStatus-ConfigurationType-CONCIERGE) | Консьерж |
| 9 | [AUTOCOLLECT](#keyapis-device-v1-DeviceConfigurationStatus-ConfigurationType-AUTOCOLLECT) | Автосбор |
| 10 | [SL3](#keyapis-device-v1-DeviceConfigurationStatus-ConfigurationType-SL3) | Режим Sl3 |
| 11 | [EMERGENCY_CALL](#keyapis-device-v1-DeviceConfigurationStatus-ConfigurationType-EMERGENCY_CALL) | Вызов экстренной службы |
### [DeviceConfigurationStatus.StatusType](#keyapis-device-v1-DeviceConfigurationStatus-StatusType)
Справочник статусов конфигурации настройки устройства.
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [STATUS_TYPE_UNKNOWN](#keyapis-device-v1-DeviceConfigurationStatus-StatusType-STATUS_TYPE_UNKNOWN) | Значение не указано |
| 1 | [SUCCESS](#keyapis-device-v1-DeviceConfigurationStatus-StatusType-SUCCESS) | Настроен |
| 2 | [ERROR](#keyapis-device-v1-DeviceConfigurationStatus-StatusType-ERROR) | Ошибка |
| 3 | [PENDING](#keyapis-device-v1-DeviceConfigurationStatus-StatusType-PENDING) | В ожидании обработки |
| 4 | [PROCESSING](#keyapis-device-v1-DeviceConfigurationStatus-StatusType-PROCESSING) | В процессе обработки |
### [DeviceConfigurationStatusGroupedPaging.DirectionType](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging-DirectionType)
Справочник типов направлений сортировки.
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [DIRECTION_TYPE_UNKNOWN](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging-DirectionType-DIRECTION_TYPE_UNKNOWN) | Значение не указано |
| 1 | [DESC](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging-DirectionType-DESC) | От большего к меньшему |
| 2 | [ASC](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging-DirectionType-ASC) | От меньшего к большему |
### [DeviceConfigurationStatusGroupedPaging.OrderByType](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging-OrderByType)
Справочник типов значений сортировки.
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [ORDER_BY_TYPE_UNKNOWN](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging-OrderByType-ORDER_BY_TYPE_UNKNOWN) | Значение не указано |
| 1 | [DEVICE_ID](#keyapis-device-v1-DeviceConfigurationStatusGroupedPaging-OrderByType-DEVICE_ID) | По идентификатору устройства |
### [DevicePaging.DirectionType](#keyapis-device-v1-DevicePaging-DirectionType)
Справочник типов направлений сортировки.
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [DIRECTION_TYPE_UNKNOWN](#keyapis-device-v1-DevicePaging-DirectionType-DIRECTION_TYPE_UNKNOWN) | Значение не указано |
| 1 | [DESC](#keyapis-device-v1-DevicePaging-DirectionType-DESC) | От большего к меньшему |
| 2 | [ASC](#keyapis-device-v1-DevicePaging-DirectionType-ASC) | От меньшего к большему |
### [DevicePaging.OrderByType](#keyapis-device-v1-DevicePaging-OrderByType)
Справочник типов значений сортировки.
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [ORDER_BY_TYPE_UNKNOWN](#keyapis-device-v1-DevicePaging-OrderByType-ORDER_BY_TYPE_UNKNOWN) | Значение не указано |
| 1 | [ID](#keyapis-device-v1-DevicePaging-OrderByType-ID) | По идентификатору |
| 2 | [TITLE](#keyapis-device-v1-DevicePaging-OrderByType-TITLE) | По наименованию |
| 3 | [SYNC_AT](#keyapis-device-v1-DevicePaging-OrderByType-SYNC_AT) | По дате последней попытки синхронизации |
### [Preset.FaceRecognition.ConfigurationType](#keyapis-device-v1-Preset-FaceRecognition-ConfigurationType)
Тип конфигурации.
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [CONFIGURATION_TYPE_UNKNOWN](#keyapis-device-v1-Preset-FaceRecognition-ConfigurationType-CONFIGURATION_TYPE_UNKNOWN) | Значение не указано |
| 1 | [DEFAULT](#keyapis-device-v1-Preset-FaceRecognition-ConfigurationType-DEFAULT) | По умолчанию |
### [Preset.StatusType](#keyapis-device-v1-Preset-StatusType)
Справочник статусов.
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [STATUS_TYPE_UNKNOWN](#keyapis-device-v1-Preset-StatusType-STATUS_TYPE_UNKNOWN) | Значение не указано |
| 1 | [ACTIVE](#keyapis-device-v1-Preset-StatusType-ACTIVE) | Активный |
| 2 | [ARCHIVE](#keyapis-device-v1-Preset-StatusType-ARCHIVE) | Архивный |
### [Preset.Syslog.ProtocolType](#keyapis-device-v1-Preset-Syslog-ProtocolType)
Тип протокола.
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [PROTOCOL_TYPE_UNKNOWN](#keyapis-device-v1-Preset-Syslog-ProtocolType-PROTOCOL_TYPE_UNKNOWN) | Значение не указано |
| 1 | [UDP](#keyapis-device-v1-Preset-Syslog-ProtocolType-UDP) | Протокол UDP |
| 2 | [TCP](#keyapis-device-v1-Preset-Syslog-ProtocolType-TCP) | Протокол TCP |
### [Preset.VideoConfig.QualityType](#keyapis-device-v1-Preset-VideoConfig-QualityType)
Справочник качеств.
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [QUALITY_TYPE_UNKNOWN](#keyapis-device-v1-Preset-VideoConfig-QualityType-QUALITY_TYPE_UNKNOWN) | Значение не указано |
| 1 | [HIGH](#keyapis-device-v1-Preset-VideoConfig-QualityType-HIGH) | Высокое качество |
| 2 | [MEDIUM](#keyapis-device-v1-Preset-VideoConfig-QualityType-MEDIUM) | Среднее качество |
### [SyncStatus.StatusType](#keyapis-device-v1-SyncStatus-StatusType)
Статус синхронизации.
# Тип: byte
| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | [STATUS_TYPE_UNKNOWN](#keyapis-device-v1-SyncStatus-StatusType-STATUS_TYPE_UNKNOWN) | Значение не указано |
| 1 | [NEW](#keyapis-device-v1-SyncStatus-StatusType-NEW) | Новый |
| 2 | [PENDING](#keyapis-device-v1-SyncStatus-StatusType-PENDING) | В процессе |
| 3 | [ERROR](#keyapis-device-v1-SyncStatus-StatusType-ERROR) | Ошибка |
| 4 | [SUCCESS](#keyapis-device-v1-SyncStatus-StatusType-SUCCESS) | Успешно |
| 5 | [DISABLED](#keyapis-device-v1-SyncStatus-StatusType-DISABLED) | Выключено |
## Скалярные типы значений
| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
| ----------- | ---------- | ------ | -- | ---- | -- | --- | ---- | --- |
| [double](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | | float | float64 | Float | double | double | double | float |
| [float](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | | float | float32 | Float | float | float | float | float |
| [int32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [int64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [uint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [uint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| [sint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [fixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | int | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [fixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | int/long | uint64 | Bignum | ulong | uint64 | long | integer/string |
| [sfixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sfixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [bool](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean |
| [string](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| [bytes](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |