# Протокол

## Оглавление

- [keyapis/event/v1/keyapis_event_event_v1.proto](#keyapis_event_v1_keyapis_event_event_v1-proto)
    - [Event](#keyapis-event-v1-Event)
  
    - [Event.DeviceType](#keyapis-event-v1-Event-DeviceType)
    - [Event.Type](#keyapis-event-v1-Event-Type)
  


## [Схема классов](/svg/protos/key/keyapis/event/v1/keyapis_event_event_v1.proto.svg)
<a href="/svg/protos/key/keyapis/event/v1/keyapis_event_event_v1.proto.svg"><img src="/svg/protos/key/keyapis/event/v1/keyapis_event_event_v1.proto.svg" alt="/svg/protos/key/keyapis/event/v1/keyapis_event_event_v1.proto.svg" style="height:100%;"></a>




<a name="keyapis_event_v1_keyapis_event_event_v1-proto"></a>

## [keyapis/event/v1/keyapis_event_event_v1.proto](/protos/key/keyapis/event/v1/keyapis_event_event_v1.proto)
Сервис реализует функционал управления событиями

 <!-- end services -->


<a name="keyapis-event-v1-Event"></a>


### [Event](#keyapis-event-v1-Event)
 Событие


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-event-v1-Event-type"></a> [type](#keyapis-event-v1-Event-type) | Тип события. Поле event_type |    [keyapis.event.v1.Event.Type](#keyapis-event-v1-Event-Type) | REQUIRED|
| <a id="keyapis-event-v1-Event-raised_at"></a> [raised_at](#keyapis-event-v1-Event-raised_at) | Дата создания события. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-event-v1-Event-device_id"></a> [device_id](#keyapis-event-v1-Event-device_id) | Идентификатор устройства |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-device_type"></a> [device_type](#keyapis-event-v1-Event-device_type) | Тип устройства на момент события |    [keyapis.event.v1.Event.DeviceType](#keyapis-event-v1-Event-DeviceType) | <nil>|
| <a id="keyapis-event-v1-Event-company_id"></a> [company_id](#keyapis-event-v1-Event-company_id) | Идентификатор компании |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-room_id"></a> [room_id](#keyapis-event-v1-Event-room_id) | Идентификатор квартиры |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-relay"></a> [relay](#keyapis-event-v1-Event-relay) | Индекс реле |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-user_id"></a> [user_id](#keyapis-event-v1-Event-user_id) | Идентификатор пользователя |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-user_agent"></a> [user_agent](#keyapis-event-v1-Event-user_agent) | Юзерагент клиента из которого пользователь выполнял запрос |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-building_id"></a> [building_id](#keyapis-event-v1-Event-building_id) | Идентификатор дома |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-orpon_id"></a> [orpon_id](#keyapis-event-v1-Event-orpon_id) | ОРПОН |    [google.protobuf.Int64Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-room_number"></a> [room_number](#keyapis-event-v1-Event-room_number) | Номер квартиры |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-ivr_phone_number"></a> [ivr_phone_number](#keyapis-event-v1-Event-ivr_phone_number) | Телефон ИВР |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-guest_phone_number"></a> [guest_phone_number](#keyapis-event-v1-Event-guest_phone_number) | Телефон гостя / звонящего |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-code"></a> [code](#keyapis-event-v1-Event-code) | Код / пин код при открытии при звонке |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-rfid"></a> [rfid](#keyapis-event-v1-Event-rfid) | RFID номер |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-request_id"></a> [request_id](#keyapis-event-v1-Event-request_id) | ИД запроса. # Тип: Guid |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-dtmf_phone_number"></a> [dtmf_phone_number](#keyapis-event-v1-Event-dtmf_phone_number) | Номер телефона с которого было открытие по DTMF коду |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-user_kind"></a> [user_kind](#keyapis-event-v1-Event-user_kind) | Тип УЗ на устройстве. Поле user_type |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-login"></a> [login](#keyapis-event-v1-Event-login) | Логин на устройстве |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-password"></a> [password](#keyapis-event-v1-Event-password) | Пароль на устройстве |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-host"></a> [host](#keyapis-event-v1-Event-host) | ip адрес устройства |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-device_model"></a> [device_model](#keyapis-event-v1-Event-device_model) | Модель устройства |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-rfid_id"></a> [rfid_id](#keyapis-event-v1-Event-rfid_id) | Идентификатор ключа |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-code_id"></a> [code_id](#keyapis-event-v1-Event-code_id) | Идентификатор кода |    [google.protobuf.Int32Value](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-car_number"></a> [car_number](#keyapis-event-v1-Event-car_number) | Номер машины |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-os"></a> [os](#keyapis-event-v1-Event-os) | Операционная система |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-push_token"></a> [push_token](#keyapis-event-v1-Event-push_token) | Пуш-токен для устройства |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-camera_uid"></a> [camera_uid](#keyapis-event-v1-Event-camera_uid) | ИД камеры. # Тип: Guid |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-screenshot_url"></a> [screenshot_url](#keyapis-event-v1-Event-screenshot_url) | Ссылка на скриншот события |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-vehicle"></a> [vehicle](#keyapis-event-v1-Event-vehicle) | Тип ТС |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-courier_company_name"></a> [courier_company_name](#keyapis-event-v1-Event-courier_company_name) | Наименование курьерской компании |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-order_number"></a> [order_number](#keyapis-event-v1-Event-order_number) | Номер заказа |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-event-v1-Event-courier_id"></a> [courier_id](#keyapis-event-v1-Event-courier_id) | Идентификатор курьера |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|





 <!-- end messages -->



<a name="keyapis-event-v1-Event-DeviceType"></a>

### [Event.DeviceType](#keyapis-event-v1-Event-DeviceType)
 Тип устройства

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-event-v1-Event-DeviceType-DEVICE_TYPE_UNKNOWN"></a> [DEVICE_TYPE_UNKNOWN](#keyapis-event-v1-Event-DeviceType-DEVICE_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-event-v1-Event-DeviceType-INTERCOM"></a> [INTERCOM](#keyapis-event-v1-Event-DeviceType-INTERCOM) | Домофон |
| 2 | <a id="keyapis-event-v1-Event-DeviceType-BARRIER"></a> [BARRIER](#keyapis-event-v1-Event-DeviceType-BARRIER) | Шлагбаум |
| 3 | <a id="keyapis-event-v1-Event-DeviceType-GATE"></a> [GATE](#keyapis-event-v1-Event-DeviceType-GATE) | Калитка |
| 4 | <a id="keyapis-event-v1-Event-DeviceType-ACCESS_CONTROL_PANEL"></a> [ACCESS_CONTROL_PANEL](#keyapis-event-v1-Event-DeviceType-ACCESS_CONTROL_PANEL) | СКУД |
| 5 | <a id="keyapis-event-v1-Event-DeviceType-VIDEOCAMERA"></a> [VIDEOCAMERA](#keyapis-event-v1-Event-DeviceType-VIDEOCAMERA) | Камера |




<a name="keyapis-event-v1-Event-Type"></a>

### [Event.Type](#keyapis-event-v1-Event-Type)
 Тип события

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-event-v1-Event-Type-TYPE_UNKNOWN"></a> [TYPE_UNKNOWN](#keyapis-event-v1-Event-Type-TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-event-v1-Event-Type-API_OPEN_REMOTE"></a> [API_OPEN_REMOTE](#keyapis-event-v1-Event-Type-API_OPEN_REMOTE) | Удалённое открытие |
| 2 | <a id="keyapis-event-v1-Event-Type-FACE_OPEN_REMOTE"></a> [FACE_OPEN_REMOTE](#keyapis-event-v1-Event-Type-FACE_OPEN_REMOTE) | Открытие по лицу |
| 3 | <a id="keyapis-event-v1-Event-Type-PIN_CODE_OPEN_REMOTE"></a> [PIN_CODE_OPEN_REMOTE](#keyapis-event-v1-Event-Type-PIN_CODE_OPEN_REMOTE) | Открытие по звонку |
| 4 | <a id="keyapis-event-v1-Event-Type-DTMF_OPEN_REMOTE"></a> [DTMF_OPEN_REMOTE](#keyapis-event-v1-Event-Type-DTMF_OPEN_REMOTE) | Открытие по DTMF коду |
| 5 | <a id="keyapis-event-v1-Event-Type-EMERGENCY_MODE_ON_REMOTE"></a> [EMERGENCY_MODE_ON_REMOTE](#keyapis-event-v1-Event-Type-EMERGENCY_MODE_ON_REMOTE) | Включение аварийного режима |
| 6 | <a id="keyapis-event-v1-Event-Type-EMERGENCY_MODE_OFF_REMOTE"></a> [EMERGENCY_MODE_OFF_REMOTE](#keyapis-event-v1-Event-Type-EMERGENCY_MODE_OFF_REMOTE) | Отключение аварийного режима |
| 7 | <a id="keyapis-event-v1-Event-Type-CODE_OPEN_LOCAL"></a> [CODE_OPEN_LOCAL](#keyapis-event-v1-Event-Type-CODE_OPEN_LOCAL) | Открытие по коду |
| 8 | <a id="keyapis-event-v1-Event-Type-RFID_OPEN_LOCAL"></a> [RFID_OPEN_LOCAL](#keyapis-event-v1-Event-Type-RFID_OPEN_LOCAL) | Открытие по ключу |
| 9 | <a id="keyapis-event-v1-Event-Type-EMERGENCY_ALARM_REMOTE"></a> [EMERGENCY_ALARM_REMOTE](#keyapis-event-v1-Event-Type-EMERGENCY_ALARM_REMOTE) | Включение проигрывания звукового предупреждения |
| 10 | <a id="keyapis-event-v1-Event-Type-GET_CREDENTIALS"></a> [GET_CREDENTIALS](#keyapis-event-v1-Event-Type-GET_CREDENTIALS) | Получение логопас УЗ устройства в админке |
| 11 | <a id="keyapis-event-v1-Event-Type-CHANGE_PASSWORD"></a> [CHANGE_PASSWORD](#keyapis-event-v1-Event-Type-CHANGE_PASSWORD) | Смена пароля на устройстве, логируется как успешная, так и неуспешная |
| 12 | <a id="keyapis-event-v1-Event-Type-USER_ENTRY"></a> [USER_ENTRY](#keyapis-event-v1-Event-Type-USER_ENTRY) | Вход пользователя |
| 13 | <a id="keyapis-event-v1-Event-Type-DTMF_OPEN_LOCAL"></a> [DTMF_OPEN_LOCAL](#keyapis-event-v1-Event-Type-DTMF_OPEN_LOCAL) | Открытие по DTMF коду |
| 14 | <a id="keyapis-event-v1-Event-Type-CAR_NUMBER_OPEN_REMOTE"></a> [CAR_NUMBER_OPEN_REMOTE](#keyapis-event-v1-Event-Type-CAR_NUMBER_OPEN_REMOTE) | Открытие по номеру машины |
| 15 | <a id="keyapis-event-v1-Event-Type-EMERGENCY_ALARM_OFF_REMOTE"></a> [EMERGENCY_ALARM_OFF_REMOTE](#keyapis-event-v1-Event-Type-EMERGENCY_ALARM_OFF_REMOTE) | Выключение проигрывания звукового предупреждения |
| 16 | <a id="keyapis-event-v1-Event-Type-EMERGENCY_ALARM_ON_REMOTE"></a> [EMERGENCY_ALARM_ON_REMOTE](#keyapis-event-v1-Event-Type-EMERGENCY_ALARM_ON_REMOTE) | Включение проигрывания звукового предупреждения |
| 17 | <a id="keyapis-event-v1-Event-Type-DISPATCHER_OPEN"></a> [DISPATCHER_OPEN](#keyapis-event-v1-Event-Type-DISPATCHER_OPEN) | Устройство открыто сотрудником ЛТП |
| 18 | <a id="keyapis-event-v1-Event-Type-DISPATCHER_DENIED_OPEN"></a> [DISPATCHER_DENIED_OPEN](#keyapis-event-v1-Event-Type-DISPATCHER_DENIED_OPEN) | Отказано в доступе сотрудником ЛТП |
| 19 | <a id="keyapis-event-v1-Event-Type-VEHICLE_TYPE_OPEN_REMOTE"></a> [VEHICLE_TYPE_OPEN_REMOTE](#keyapis-event-v1-Event-Type-VEHICLE_TYPE_OPEN_REMOTE) | Открытие по типу авто |


 <!-- end enums -->

 <!-- end HasExtensions -->



## Скалярные типы значений
<a id="scalar-types"></a>

| .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 |