# Протокол

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

- [keyapis/iot_connect/v1/keyapis_iot_connect_callback_v1.proto](#keyapis_iot_connect_v1_keyapis_iot_connect_callback_v1-proto)
    - [IotConnectCallbackService](#keyapis-iot_connect-v1-IotConnectCallbackService)
  
    - [CommonError](#keyapis-iot_connect-v1-CommonError)
    - [Device](#keyapis-iot_connect-v1-Device)
    - [GetCallbackDevicesRequest](#keyapis-iot_connect-v1-GetCallbackDevicesRequest)
    - [GetCallbackDevicesResponse](#keyapis-iot_connect-v1-GetCallbackDevicesResponse)
    - [GetCallbackUserRequest](#keyapis-iot_connect-v1-GetCallbackUserRequest)
    - [GetCallbackUserResponse](#keyapis-iot_connect-v1-GetCallbackUserResponse)
    - [PostCallbackCommandRequest](#keyapis-iot_connect-v1-PostCallbackCommandRequest)
    - [PostCallbackCommandResponse](#keyapis-iot_connect-v1-PostCallbackCommandResponse)
    - [PostCallbackStatusRequest](#keyapis-iot_connect-v1-PostCallbackStatusRequest)
    - [PostCallbackStatusResponse](#keyapis-iot_connect-v1-PostCallbackStatusResponse)
    - [PostCallbackStatusResponse.Status](#keyapis-iot_connect-v1-PostCallbackStatusResponse-Status)
    - [PostCallbackUnlinkRequest](#keyapis-iot_connect-v1-PostCallbackUnlinkRequest)
    - [PostCallbackUnlinkResponse](#keyapis-iot_connect-v1-PostCallbackUnlinkResponse)
  


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




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

## [keyapis/iot_connect/v1/keyapis_iot_connect_callback_v1.proto](/protos/key/keyapis/iot_connect/v1/keyapis_iot_connect_callback_v1.proto)
Сервис реализует функционал взаимодействия с внешними партнёрами IoT


<a name="keyapis-iot_connect-v1-IotConnectCallbackService"></a>

### IotConnectCallbackService
 Сервис для взаимодействия с внешними партнёрами Iot

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-iot_connect-v1-GetCallbackUser"></a> [GetCallbackUser](#keyapis-iot_connect-v1-GetCallbackUser) | Метод получения пользователя. Метод доступен для: TokenACF: Scope: iot | [keyapis.iot_connect.v1.GetCallbackUserRequest](#keyapis-iot_connect-v1-GetCallbackUserRequest) | [keyapis.iot_connect.v1.GetCallbackUserResponse](#keyapis-iot_connect-v1-GetCallbackUserResponse) |
| <a id="keyapis-iot_connect-v1-GetCallbackDevices"></a> [GetCallbackDevices](#keyapis-iot_connect-v1-GetCallbackDevices) | Метод получения устройств, доступных пользователю. Метод доступен для: TokenACF: Scope: iot | [keyapis.iot_connect.v1.GetCallbackDevicesRequest](#keyapis-iot_connect-v1-GetCallbackDevicesRequest) | [keyapis.iot_connect.v1.GetCallbackDevicesResponse](#keyapis-iot_connect-v1-GetCallbackDevicesResponse) |
| <a id="keyapis-iot_connect-v1-PostCallbackStatus"></a> [PostCallbackStatus](#keyapis-iot_connect-v1-PostCallbackStatus) | Метод получения внешним партнёром состояния устройства. Метод доступен для: TokenACF: Scope: iot | [keyapis.iot_connect.v1.PostCallbackStatusRequest](#keyapis-iot_connect-v1-PostCallbackStatusRequest) | [keyapis.iot_connect.v1.PostCallbackStatusResponse](#keyapis-iot_connect-v1-PostCallbackStatusResponse) |
| <a id="keyapis-iot_connect-v1-PostCallbackCommand"></a> [PostCallbackCommand](#keyapis-iot_connect-v1-PostCallbackCommand) | Метод запроса внешнего IoT партнёра на изменение состояния устройства. Поддерживается только открытие домофона. Метод доступен для: TokenACF: Scope: iot | [keyapis.iot_connect.v1.PostCallbackCommandRequest](#keyapis-iot_connect-v1-PostCallbackCommandRequest) | [keyapis.iot_connect.v1.PostCallbackCommandResponse](#keyapis-iot_connect-v1-PostCallbackCommandResponse) |
| <a id="keyapis-iot_connect-v1-PostCallbackUnlink"></a> [PostCallbackUnlink](#keyapis-iot_connect-v1-PostCallbackUnlink) | Метод сообщения от внешнего IoT партнёра о разъединении аккаунтов. Метод доступен для: TokenACF: Scope: iot | [keyapis.iot_connect.v1.PostCallbackUnlinkRequest](#keyapis-iot_connect-v1-PostCallbackUnlinkRequest) | [keyapis.iot_connect.v1.PostCallbackUnlinkResponse](#keyapis-iot_connect-v1-PostCallbackUnlinkResponse) |

 <!-- end services -->


<a name="keyapis-iot_connect-v1-CommonError"></a>


### [CommonError](#keyapis-iot_connect-v1-CommonError)
 Сообщение ошибки на запрос


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect-v1-CommonError-code"></a> [code](#keyapis-iot_connect-v1-CommonError-code) | Коммент 1 |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-CommonError-message"></a> [message](#keyapis-iot_connect-v1-CommonError-message) | Коммент 1 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-CommonError-details"></a> [details](#keyapis-iot_connect-v1-CommonError-details) | Коммент 1 |    [string](#scalar-types) | <nil>|






<a name="keyapis-iot_connect-v1-Device"></a>


### [Device](#keyapis-iot_connect-v1-Device)
 Объект устройства


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect-v1-Device-user_id"></a> [user_id](#keyapis-iot_connect-v1-Device-user_id) | Идентификатор пользователя |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-Device-id"></a> [id](#keyapis-iot_connect-v1-Device-id) | Коммент 1 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-Device-parent_id"></a> [parent_id](#keyapis-iot_connect-v1-Device-parent_id) | Коммент 1 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-Device-name"></a> [name](#keyapis-iot_connect-v1-Device-name) | Коммент 1 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-Device-default_name"></a> [default_name](#keyapis-iot_connect-v1-Device-default_name) | Коммент 1 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-Device-home"></a> [home](#keyapis-iot_connect-v1-Device-home) | Коммент 1 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-Device-room"></a> [room](#keyapis-iot_connect-v1-Device-room) | Коммент 1 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-Device-groups"></a> [groups](#keyapis-iot_connect-v1-Device-groups) | Коммент 1 |  repeated  [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-Device-model_id"></a> [model_id](#keyapis-iot_connect-v1-Device-model_id) | Коммент 1 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-Device-hw_version"></a> [hw_version](#keyapis-iot_connect-v1-Device-hw_version) | Коммент 1 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-Device-sw_version"></a> [sw_version](#keyapis-iot_connect-v1-Device-sw_version) | Коммент 1 |    [string](#scalar-types) | <nil>|






<a name="keyapis-iot_connect-v1-GetCallbackDevicesRequest"></a>


### [GetCallbackDevicesRequest](#keyapis-iot_connect-v1-GetCallbackDevicesRequest)
 Запрос списка домофонов пользователя в виде связки квартира-домофон, к которым имеет доступ пользователь






<a name="keyapis-iot_connect-v1-GetCallbackDevicesResponse"></a>


### [GetCallbackDevicesResponse](#keyapis-iot_connect-v1-GetCallbackDevicesResponse)
 Ответ на запрос списка домофонов пользователя в виде связки квартира-домофон, к которым имеет доступ пользователь


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect-v1-GetCallbackDevicesResponse-data"></a> [data](#keyapis-iot_connect-v1-GetCallbackDevicesResponse-data) | Массив домофонов пользователя |  repeated  [keyapis.iot_connect.v1.Device](#keyapis-iot_connect-v1-Device) | <nil>|






<a name="keyapis-iot_connect-v1-GetCallbackUserRequest"></a>


### [GetCallbackUserRequest](#keyapis-iot_connect-v1-GetCallbackUserRequest)
 Запрос идентификатора пользователя Ключ






<a name="keyapis-iot_connect-v1-GetCallbackUserResponse"></a>


### [GetCallbackUserResponse](#keyapis-iot_connect-v1-GetCallbackUserResponse)
 Ответ на запрос идентификатора пользователя Ключ


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect-v1-GetCallbackUserResponse-data"></a> [data](#keyapis-iot_connect-v1-GetCallbackUserResponse-data) | Идентификатор пользователя |    [int32](#scalar-types) | <nil>|






<a name="keyapis-iot_connect-v1-PostCallbackCommandRequest"></a>


### [PostCallbackCommandRequest](#keyapis-iot_connect-v1-PostCallbackCommandRequest)
 Запрос на изменение статуса домофона






<a name="keyapis-iot_connect-v1-PostCallbackCommandResponse"></a>


### [PostCallbackCommandResponse](#keyapis-iot_connect-v1-PostCallbackCommandResponse)
 Ответ на запрос на изменение статуса домофона






<a name="keyapis-iot_connect-v1-PostCallbackStatusRequest"></a>


### [PostCallbackStatusRequest](#keyapis-iot_connect-v1-PostCallbackStatusRequest)
 Запрос статуса домофонов пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect-v1-PostCallbackStatusRequest-data"></a> [data](#keyapis-iot_connect-v1-PostCallbackStatusRequest-data) | Массив домофонов пользователя |  repeated  [string](#scalar-types) | <nil>|






<a name="keyapis-iot_connect-v1-PostCallbackStatusResponse"></a>


### [PostCallbackStatusResponse](#keyapis-iot_connect-v1-PostCallbackStatusResponse)
 Ответ на запрос статуса домофонов пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect-v1-PostCallbackStatusResponse-data"></a> [data](#keyapis-iot_connect-v1-PostCallbackStatusResponse-data) | Коммент |    [keyapis.iot_connect.v1.PostCallbackStatusResponse.Status](#keyapis-iot_connect-v1-PostCallbackStatusResponse-Status) | <nil>|






<a name="keyapis-iot_connect-v1-PostCallbackStatusResponse-Status"></a>


### [PostCallbackStatusResponse.Status](#keyapis-iot_connect-v1-PostCallbackStatusResponse-Status)
 Коммент 1


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-user_id"></a> [user_id](#keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-user_id) | Идентификатор пользователя |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-id"></a> [id](#keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-id) | Коммент 1 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-parent_id"></a> [parent_id](#keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-parent_id) | Коммент 1 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-name"></a> [name](#keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-name) | Коммент 1 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-default_name"></a> [default_name](#keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-default_name) | Коммент 1 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-home"></a> [home](#keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-home) | Коммент 1 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-room"></a> [room](#keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-room) | Коммент 1 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-groups"></a> [groups](#keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-groups) | Коммент 1 |  repeated  [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-model_id"></a> [model_id](#keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-model_id) | Коммент 1 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-hw_version"></a> [hw_version](#keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-hw_version) | Коммент 1 |    [string](#scalar-types) | <nil>|
| <a id="keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-sw_version"></a> [sw_version](#keyapis-iot_connect-v1-PostCallbackStatusResponse-Status-sw_version) | Коммент 1 |    [string](#scalar-types) | <nil>|






<a name="keyapis-iot_connect-v1-PostCallbackUnlinkRequest"></a>


### [PostCallbackUnlinkRequest](#keyapis-iot_connect-v1-PostCallbackUnlinkRequest)
 Запрос-информирование о разъединении аккаунтов






<a name="keyapis-iot_connect-v1-PostCallbackUnlinkResponse"></a>


### [PostCallbackUnlinkResponse](#keyapis-iot_connect-v1-PostCallbackUnlinkResponse)
 Ответ на запрос-информирование о разъединении аккаунтов





 <!-- end messages -->

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