# Протокол

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

- [keyapis/dial/v1/keyapis_dial_alert_scenario_v1.proto](#keyapis_dial_v1_keyapis_dial_alert_scenario_v1-proto)
    - [BroadcastAlertService](#keyapis-dial-v1-BroadcastAlertService)
  
    - [PostBroadcastAlertStartRequest](#keyapis-dial-v1-PostBroadcastAlertStartRequest)
    - [PostBroadcastAlertStartResponse](#keyapis-dial-v1-PostBroadcastAlertStartResponse)
    - [PostBroadcastAlertStartResponse.Error](#keyapis-dial-v1-PostBroadcastAlertStartResponse-Error)
    - [PostBroadcastAlertStartResponse.Error.ScenarioNotFound](#keyapis-dial-v1-PostBroadcastAlertStartResponse-Error-ScenarioNotFound)
    - [ValidationError](#keyapis-dial-v1-ValidationError)
  


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




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

## [keyapis/dial/v1/keyapis_dial_alert_scenario_v1.proto](/protos/key/keyapis/dial/v1/keyapis_dial_alert_scenario_v1.proto)
Сервис реализует функционал массового оповещения через домофоны


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

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

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

 <!-- end services -->


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


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-dial-v1-PostBroadcastAlertStartRequest-to_number"></a> [to_number](#keyapis-dial-v1-PostBroadcastAlertStartRequest-to_number) | Вызываемый номер. # Паттерн: /^\+[1-9][0-9]{10}$/ |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-dial-v1-PostBroadcastAlertStartRequest-from_number"></a> [from_number](#keyapis-dial-v1-PostBroadcastAlertStartRequest-from_number) | Вызывающий номер. # Паттерн: /^\+[1-9][0-9]{10}$/ |    [string](#scalar-types) | REQUIRED|






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


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


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






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


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


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






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


### [PostBroadcastAlertStartResponse.Error.ScenarioNotFound](#keyapis-dial-v1-PostBroadcastAlertStartResponse-Error-ScenarioNotFound)
 Не найден сценарий оповещения






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


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


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