# Протокол

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

- [keyapis/iot_connect/v1/keyapis_iot_connect_manage_v1.proto](#keyapis_iot_connect_v1_keyapis_iot_connect_manage_v1-proto)
    - [IotConnectManageService](#keyapis-iot_connect-v1-IotConnectManageService)
  
    - [PostManageCallCancelRequest](#keyapis-iot_connect-v1-PostManageCallCancelRequest)
    - [PostManageCallCancelResponse](#keyapis-iot_connect-v1-PostManageCallCancelResponse)
    - [PostManageCallCancelResponse.Error](#keyapis-iot_connect-v1-PostManageCallCancelResponse-Error)
    - [PostManageCallRequest](#keyapis-iot_connect-v1-PostManageCallRequest)
    - [PostManageCallResponse](#keyapis-iot_connect-v1-PostManageCallResponse)
    - [PostManageCallResponse.Error](#keyapis-iot_connect-v1-PostManageCallResponse-Error)
    - [PutManageUserScopeDetachRequest](#keyapis-iot_connect-v1-PutManageUserScopeDetachRequest)
    - [PutManageUserScopeDetachResponse](#keyapis-iot_connect-v1-PutManageUserScopeDetachResponse)
    - [PutManageUserScopeDetachResponse.Error](#keyapis-iot_connect-v1-PutManageUserScopeDetachResponse-Error)
    - [ValidationError](#keyapis-iot_connect-v1-ValidationError)
  


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




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

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


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

### IotConnectManageService
 Сервис для отправки команд и сообщений внешним партнёрам IoT

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-iot_connect-v1-PutManageUserScopeDetach"></a> [PutManageUserScopeDetach](#keyapis-iot_connect-v1-PutManageUserScopeDetach) | Метод разъединения аккаунтов. Метод доступен для: admin | [keyapis.iot_connect.v1.PutManageUserScopeDetachRequest](#keyapis-iot_connect-v1-PutManageUserScopeDetachRequest) | [keyapis.iot_connect.v1.PutManageUserScopeDetachResponse](#keyapis-iot_connect-v1-PutManageUserScopeDetachResponse) |
| <a id="keyapis-iot_connect-v1-PostManageCall"></a> [PostManageCall](#keyapis-iot_connect-v1-PostManageCall) | Метод обработки события звонка с домофона. Метод доступен для: service | [keyapis.iot_connect.v1.PostManageCallRequest](#keyapis-iot_connect-v1-PostManageCallRequest) | [keyapis.iot_connect.v1.PostManageCallResponse](#keyapis-iot_connect-v1-PostManageCallResponse) |
| <a id="keyapis-iot_connect-v1-PostManageCallCancel"></a> [PostManageCallCancel](#keyapis-iot_connect-v1-PostManageCallCancel) | Метод обработки события об окончании группового звонка с домофона. Метод доступен для: service | [keyapis.iot_connect.v1.PostManageCallCancelRequest](#keyapis-iot_connect-v1-PostManageCallCancelRequest) | [keyapis.iot_connect.v1.PostManageCallCancelResponse](#keyapis-iot_connect-v1-PostManageCallCancelResponse) |

 <!-- end services -->


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


### [PostManageCallCancelRequest](#keyapis-iot_connect-v1-PostManageCallCancelRequest)
 Запрос на передачу события об окончании группового звонка с домофона


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect-v1-PostManageCallCancelRequest-to_number"></a> [to_number](#keyapis-iot_connect-v1-PostManageCallCancelRequest-to_number) | Вызываемый номер |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-iot_connect-v1-PostManageCallCancelRequest-from_number"></a> [from_number](#keyapis-iot_connect-v1-PostManageCallCancelRequest-from_number) | Вызывающий номер |    [string](#scalar-types) | REQUIRED|






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


### [PostManageCallCancelResponse](#keyapis-iot_connect-v1-PostManageCallCancelResponse)
 Ответ на запрос на передачу события об окончании группового звонка с домофона


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect-v1-PostManageCallCancelResponse-error"></a> [error](#keyapis-iot_connect-v1-PostManageCallCancelResponse-error) | Ошибка |  optional  [keyapis.iot_connect.v1.PostManageCallCancelResponse.Error](#keyapis-iot_connect-v1-PostManageCallCancelResponse-Error) | <nil>|






<a name="keyapis-iot_connect-v1-PostManageCallCancelResponse-Error"></a>


### [PostManageCallCancelResponse.Error](#keyapis-iot_connect-v1-PostManageCallCancelResponse-Error)
 Ошибка запроса


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect-v1-PostManageCallCancelResponse-Error-validation"></a> [validation](#keyapis-iot_connect-v1-PostManageCallCancelResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.iot_connect.v1.ValidationError](#keyapis-iot_connect-v1-ValidationError) | <nil>|






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


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect-v1-PostManageCallRequest-to_number"></a> [to_number](#keyapis-iot_connect-v1-PostManageCallRequest-to_number) | Вызываемый номер |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-iot_connect-v1-PostManageCallRequest-from_number"></a> [from_number](#keyapis-iot_connect-v1-PostManageCallRequest-from_number) | Вызывающий номер |    [string](#scalar-types) | REQUIRED|






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


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect-v1-PostManageCallResponse-error"></a> [error](#keyapis-iot_connect-v1-PostManageCallResponse-error) | Ошибка |  optional  [keyapis.iot_connect.v1.PostManageCallResponse.Error](#keyapis-iot_connect-v1-PostManageCallResponse-Error) | <nil>|






<a name="keyapis-iot_connect-v1-PostManageCallResponse-Error"></a>


### [PostManageCallResponse.Error](#keyapis-iot_connect-v1-PostManageCallResponse-Error)
 Ошибка запроса


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect-v1-PostManageCallResponse-Error-validation"></a> [validation](#keyapis-iot_connect-v1-PostManageCallResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.iot_connect.v1.ValidationError](#keyapis-iot_connect-v1-ValidationError) | <nil>|






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


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


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






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


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect-v1-PutManageUserScopeDetachResponse-error"></a> [error](#keyapis-iot_connect-v1-PutManageUserScopeDetachResponse-error) | Ошибка |  optional  [keyapis.iot_connect.v1.PutManageUserScopeDetachResponse.Error](#keyapis-iot_connect-v1-PutManageUserScopeDetachResponse-Error) | <nil>|






<a name="keyapis-iot_connect-v1-PutManageUserScopeDetachResponse-Error"></a>


### [PutManageUserScopeDetachResponse.Error](#keyapis-iot_connect-v1-PutManageUserScopeDetachResponse-Error)
 Ошибка запроса


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect-v1-PutManageUserScopeDetachResponse-Error-validation"></a> [validation](#keyapis-iot_connect-v1-PutManageUserScopeDetachResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.iot_connect.v1.ValidationError](#keyapis-iot_connect-v1-ValidationError) | <nil>|






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


### [ValidationError](#keyapis-iot_connect-v1-ValidationError)
 Ошибки валидации


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-iot_connect-v1-ValidationError-path"></a> [path](#keyapis-iot_connect-v1-ValidationError-path) | Путь к полю в формате наименования protobuf |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-iot_connect-v1-ValidationError-message"></a> [message](#keyapis-iot_connect-v1-ValidationError-message) | Валидационное сообщение |    [string](#scalar-types) | REQUIRED|





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