# Протокол

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

- [keyapis/access_control/v1/keyapis_access_control_broadcast_alert_v1.proto](#keyapis_access_control_v1_keyapis_access_control_broadcast_alert_v1-proto)
    - [BroadcastAlertService](#keyapis-access_control-v1-BroadcastAlertService)
  
    - [PostBroadcastAlertStartRequest](#keyapis-access_control-v1-PostBroadcastAlertStartRequest)
    - [PostBroadcastAlertStartResponse](#keyapis-access_control-v1-PostBroadcastAlertStartResponse)
    - [PostBroadcastAlertStartResponse.Error](#keyapis-access_control-v1-PostBroadcastAlertStartResponse-Error)
    - [PostBroadcastAlertStartResponse.Error.SoundFileNotFound](#keyapis-access_control-v1-PostBroadcastAlertStartResponse-Error-SoundFileNotFound)
    - [PostBroadcastAlertStopRequest](#keyapis-access_control-v1-PostBroadcastAlertStopRequest)
    - [PostBroadcastAlertStopResponse](#keyapis-access_control-v1-PostBroadcastAlertStopResponse)
    - [PostBroadcastAlertStopResponse.Error](#keyapis-access_control-v1-PostBroadcastAlertStopResponse-Error)
  
    - [PostBroadcastAlertStartRequest.PlayType](#keyapis-access_control-v1-PostBroadcastAlertStartRequest-PlayType)
  


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




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

## [keyapis/access_control/v1/keyapis_access_control_broadcast_alert_v1.proto](/protos/key/keyapis/access_control/v1/keyapis_access_control_broadcast_alert_v1.proto)
Сервис массового оповещения через домофоны


<a name="keyapis-access_control-v1-BroadcastAlertService"></a>

### BroadcastAlertService
 Сервис для массового оповещения через домофоны

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-access_control-v1-PostBroadcastAlertStart"></a> [PostBroadcastAlertStart](#keyapis-access_control-v1-PostBroadcastAlertStart) | Метод запуска массового оповещения через домофоны. Метод доступен для: ApiKey | [keyapis.access_control.v1.PostBroadcastAlertStartRequest](#keyapis-access_control-v1-PostBroadcastAlertStartRequest) | [keyapis.access_control.v1.PostBroadcastAlertStartResponse](#keyapis-access_control-v1-PostBroadcastAlertStartResponse) |
| <a id="keyapis-access_control-v1-PostBroadcastAlertStop"></a> [PostBroadcastAlertStop](#keyapis-access_control-v1-PostBroadcastAlertStop) | Метод прекращения массового оповещения через домофоны. Метод доступен для: ApiKey | [keyapis.access_control.v1.PostBroadcastAlertStopRequest](#keyapis-access_control-v1-PostBroadcastAlertStopRequest) | [keyapis.access_control.v1.PostBroadcastAlertStopResponse](#keyapis-access_control-v1-PostBroadcastAlertStopResponse) |

 <!-- end services -->


<a name="keyapis-access_control-v1-PostBroadcastAlertStartRequest"></a>


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-PostBroadcastAlertStartRequest-sound_file_uri"></a> [sound_file_uri](#keyapis-access_control-v1-PostBroadcastAlertStartRequest-sound_file_uri) | Ссылка на звуковой файл для проигрывания. Файл должен лежать на внутреннем хранилище. # Диапазон: 2..100 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-PostBroadcastAlertStartRequest-orpons"></a> [orpons](#keyapis-access_control-v1-PostBroadcastAlertStartRequest-orpons) | Массив ОРПОНов домов, на которых запускаем проигрывание. # Диапазон: 1..100 |  repeated  [int64](#scalar-types) | <nil>|
| <a id="keyapis-access_control-v1-PostBroadcastAlertStartRequest-tact_play_duration"></a> [tact_play_duration](#keyapis-access_control-v1-PostBroadcastAlertStartRequest-tact_play_duration) | Длительность воспроизведения такта в секундах. Такт включает в себя проигрывание файла на трубках или на динамике. # Диапазон: 0..65536 |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-PostBroadcastAlertStartRequest-tact_repeat_count"></a> [tact_repeat_count](#keyapis-access_control-v1-PostBroadcastAlertStartRequest-tact_repeat_count) | Количество последовательных повторов тактов перед сменой динамика на трубки или наоборот. # Диапазон: 0..65536 |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-PostBroadcastAlertStartRequest-play_repeat_count"></a> [play_repeat_count](#keyapis-access_control-v1-PostBroadcastAlertStartRequest-play_repeat_count) | Количество дополнительных повторов тактов, т.е. умолчание=0 - это проигрывание одного такта. # Диапазон: 0..65536 |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-access_control-v1-PostBroadcastAlertStartRequest-play_type"></a> [play_type](#keyapis-access_control-v1-PostBroadcastAlertStartRequest-play_type) | Тип проигрывания |    [keyapis.access_control.v1.PostBroadcastAlertStartRequest.PlayType](#keyapis-access_control-v1-PostBroadcastAlertStartRequest-PlayType) | REQUIRED|






<a name="keyapis-access_control-v1-PostBroadcastAlertStartResponse"></a>


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


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






<a name="keyapis-access_control-v1-PostBroadcastAlertStartResponse-Error"></a>


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


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






<a name="keyapis-access_control-v1-PostBroadcastAlertStartResponse-Error-SoundFileNotFound"></a>


### [PostBroadcastAlertStartResponse.Error.SoundFileNotFound](#keyapis-access_control-v1-PostBroadcastAlertStartResponse-Error-SoundFileNotFound)
 Звуковой файл не найден






<a name="keyapis-access_control-v1-PostBroadcastAlertStopRequest"></a>


### [PostBroadcastAlertStopRequest](#keyapis-access_control-v1-PostBroadcastAlertStopRequest)
 Запрос на прекращение массового оповещения через домофоны


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-access_control-v1-PostBroadcastAlertStopRequest-orpons"></a> [orpons](#keyapis-access_control-v1-PostBroadcastAlertStopRequest-orpons) | Массив ОРПОНов домов, на которых запускаем проигрывание. # Диапазон: 1..100 |  repeated  [int64](#scalar-types) | <nil>|






<a name="keyapis-access_control-v1-PostBroadcastAlertStopResponse"></a>


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


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






<a name="keyapis-access_control-v1-PostBroadcastAlertStopResponse-Error"></a>


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


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





 <!-- end messages -->



<a name="keyapis-access_control-v1-PostBroadcastAlertStartRequest-PlayType"></a>

### [PostBroadcastAlertStartRequest.PlayType](#keyapis-access_control-v1-PostBroadcastAlertStartRequest-PlayType)
 Тип проигрывания.
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-access_control-v1-PostBroadcastAlertStartRequest-PlayType-PLAY_TYPE_UNKNOWN"></a> [PLAY_TYPE_UNKNOWN](#keyapis-access_control-v1-PostBroadcastAlertStartRequest-PlayType-PLAY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-access_control-v1-PostBroadcastAlertStartRequest-PlayType-HANDSET_ONLY"></a> [HANDSET_ONLY](#keyapis-access_control-v1-PostBroadcastAlertStartRequest-PlayType-HANDSET_ONLY) | Только на аналоговые трубки |
| 2 | <a id="keyapis-access_control-v1-PostBroadcastAlertStartRequest-PlayType-SPEAKER_ONLY"></a> [SPEAKER_ONLY](#keyapis-access_control-v1-PostBroadcastAlertStartRequest-PlayType-SPEAKER_ONLY) | Tолько на динамик домофона |
| 3 | <a id="keyapis-access_control-v1-PostBroadcastAlertStartRequest-PlayType-HANDSET_AND_SPEAKER"></a> [HANDSET_AND_SPEAKER](#keyapis-access_control-v1-PostBroadcastAlertStartRequest-PlayType-HANDSET_AND_SPEAKER) | Сначала на аналоговые трубки проигрываем заданное количество тактов, затем на динамик домофона |
| 4 | <a id="keyapis-access_control-v1-PostBroadcastAlertStartRequest-PlayType-SPEAKER_AND_HANDSET"></a> [SPEAKER_AND_HANDSET](#keyapis-access_control-v1-PostBroadcastAlertStartRequest-PlayType-SPEAKER_AND_HANDSET) | Сначала на динамик домофона проигрываем заданное количество тактов, затем на аналоговые трубки |


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