# Протокол

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

- [deviceapis/device/v1/deviceapis_device_sos_v1.proto](#deviceapis_device_v1_deviceapis_device_sos_v1-proto)
    - [SosService](#deviceapis-device-v1-SosService)
  
    - [EditSosRequest](#deviceapis-device-v1-EditSosRequest)
    - [EditSosResponse](#deviceapis-device-v1-EditSosResponse)
    - [EditSosResponse.Error](#deviceapis-device-v1-EditSosResponse-Error)
    - [GetSosRequest](#deviceapis-device-v1-GetSosRequest)
    - [GetSosResponse](#deviceapis-device-v1-GetSosResponse)
    - [Sos](#deviceapis-device-v1-Sos)
  


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




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

## [deviceapis/device/v1/deviceapis_device_sos_v1.proto](/protos/key/deviceapis/device/v1/deviceapis_device_sos_v1.proto)
Сервис управления настройками SOS


<a name="deviceapis-device-v1-SosService"></a>

### SosService
 Сервис управления настройками SOS

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="deviceapis-device-v1-EditSos"></a> [EditSos](#deviceapis-device-v1-EditSos) | Метод редактирования настроек SOS | [deviceapis.device.v1.EditSosRequest](#deviceapis-device-v1-EditSosRequest) | [deviceapis.device.v1.EditSosResponse](#deviceapis-device-v1-EditSosResponse) |
| <a id="deviceapis-device-v1-GetSos"></a> [GetSos](#deviceapis-device-v1-GetSos) | Метод получения настроек SOS | [deviceapis.device.v1.GetSosRequest](#deviceapis-device-v1-GetSosRequest) | [deviceapis.device.v1.GetSosResponse](#deviceapis-device-v1-GetSosResponse) |

 <!-- end services -->


<a name="deviceapis-device-v1-EditSosRequest"></a>


### [EditSosRequest](#deviceapis-device-v1-EditSosRequest)
 Запрос редактирования настроек SOS


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-EditSosRequest-data"></a> [data](#deviceapis-device-v1-EditSosRequest-data) | Настройки SOS |    [deviceapis.device.v1.Sos](#deviceapis-device-v1-Sos) | REQUIRED|
| <a id="deviceapis-device-v1-EditSosRequest-update_mask"></a> [update_mask](#deviceapis-device-v1-EditSosRequest-update_mask) | Маска полей обновления |    [google.protobuf.FieldMask](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|






<a name="deviceapis-device-v1-EditSosResponse"></a>


### [EditSosResponse](#deviceapis-device-v1-EditSosResponse)
 Ответ на запрос редактирования настроек SOS


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-EditSosResponse-data"></a> [data](#deviceapis-device-v1-EditSosResponse-data) | Настройки SOS |  optional  [deviceapis.device.v1.Sos](#deviceapis-device-v1-Sos) | <nil>|
| <a id="deviceapis-device-v1-EditSosResponse-error"></a> [error](#deviceapis-device-v1-EditSosResponse-error) | Ошибка |  optional  [deviceapis.device.v1.EditSosResponse.Error](#deviceapis-device-v1-EditSosResponse-Error) | <nil>|






<a name="deviceapis-device-v1-EditSosResponse-Error"></a>


### [EditSosResponse.Error](#deviceapis-device-v1-EditSosResponse-Error)
 Ошибка запроса


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






<a name="deviceapis-device-v1-GetSosRequest"></a>


### [GetSosRequest](#deviceapis-device-v1-GetSosRequest)
 Запрос получения настроек SOS






<a name="deviceapis-device-v1-GetSosResponse"></a>


### [GetSosResponse](#deviceapis-device-v1-GetSosResponse)
 Ответ на запрос получения настроек SOS


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-GetSosResponse-data"></a> [data](#deviceapis-device-v1-GetSosResponse-data) | Настройки SOS |  optional  [deviceapis.device.v1.Sos](#deviceapis-device-v1-Sos) | <nil>|






<a name="deviceapis-device-v1-Sos"></a>


### [Sos](#deviceapis-device-v1-Sos)
 Настройки SOS


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="deviceapis-device-v1-Sos-is_sos_on"></a> [is_sos_on](#deviceapis-device-v1-Sos-is_sos_on) | Флаг включения SOS вызова |    [bool](#scalar-types) | REQUIRED|
| <a id="deviceapis-device-v1-Sos-sip_invite"></a> [sip_invite](#deviceapis-device-v1-Sos-sip_invite) | Параметр SIP Invite для SOS вызова. Произвольная строка которая передается в SIP сервер. Диапазон: 1..128 |    [string](#scalar-types) | REQUIRED|
| <a id="deviceapis-device-v1-Sos-sip_server"></a> [sip_server](#deviceapis-device-v1-Sos-sip_server) | Параметр SIP Server для SOS вызова. При пустом sip_server будет использован сервер SIP регистрации |    [string](#scalar-types) | <nil>|





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