# Протокол

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

- [keyapis/device/v1/keyapis_device_cms_phone_v1.proto](#keyapis_device_v1_keyapis_device_cms_phone_v1-proto)
    - [CmsPhoneService](#keyapis-device-v1-CmsPhoneService)
  
    - [CmsPhone](#keyapis-device-v1-CmsPhone)
    - [CmsPhone.SavingError](#keyapis-device-v1-CmsPhone-SavingError)
    - [CmsPhone.SavingError.Conflict](#keyapis-device-v1-CmsPhone-SavingError-Conflict)
    - [CmsPhoneFilter](#keyapis-device-v1-CmsPhoneFilter)
    - [CmsPhonePaging](#keyapis-device-v1-CmsPhonePaging)
    - [DeleteCmsPhoneDeviceIdRequest](#keyapis-device-v1-DeleteCmsPhoneDeviceIdRequest)
    - [DeleteCmsPhoneDeviceIdResponse](#keyapis-device-v1-DeleteCmsPhoneDeviceIdResponse)
    - [DeleteCmsPhoneOrponIdRequest](#keyapis-device-v1-DeleteCmsPhoneOrponIdRequest)
    - [DeleteCmsPhoneOrponIdResponse](#keyapis-device-v1-DeleteCmsPhoneOrponIdResponse)
    - [DeleteCmsPhoneOrponIdRoomNumberRequest](#keyapis-device-v1-DeleteCmsPhoneOrponIdRoomNumberRequest)
    - [DeleteCmsPhoneOrponIdRoomNumberResponse](#keyapis-device-v1-DeleteCmsPhoneOrponIdRoomNumberResponse)
    - [DeleteCmsPhoneOrponRoomNumberDeviceIdRequest](#keyapis-device-v1-DeleteCmsPhoneOrponRoomNumberDeviceIdRequest)
    - [DeleteCmsPhoneOrponRoomNumberDeviceIdResponse](#keyapis-device-v1-DeleteCmsPhoneOrponRoomNumberDeviceIdResponse)
    - [DeleteCmsPhoneRequest](#keyapis-device-v1-DeleteCmsPhoneRequest)
    - [DeleteCmsPhoneResponse](#keyapis-device-v1-DeleteCmsPhoneResponse)
    - [GetCmsPhoneCountRequest](#keyapis-device-v1-GetCmsPhoneCountRequest)
    - [GetCmsPhoneCountResponse](#keyapis-device-v1-GetCmsPhoneCountResponse)
    - [GetCmsPhoneCountResponse.Error](#keyapis-device-v1-GetCmsPhoneCountResponse-Error)
    - [GetCmsPhoneListRequest](#keyapis-device-v1-GetCmsPhoneListRequest)
    - [GetCmsPhoneListResponse](#keyapis-device-v1-GetCmsPhoneListResponse)
    - [GetCmsPhoneListResponse.Error](#keyapis-device-v1-GetCmsPhoneListResponse-Error)
    - [GetCmsPhoneRequest](#keyapis-device-v1-GetCmsPhoneRequest)
    - [GetCmsPhoneResponse](#keyapis-device-v1-GetCmsPhoneResponse)
    - [GetCmsPhoneResponse.Error](#keyapis-device-v1-GetCmsPhoneResponse-Error)
    - [PostCmsPhoneRefreshRequest](#keyapis-device-v1-PostCmsPhoneRefreshRequest)
    - [PostCmsPhoneRefreshResponse](#keyapis-device-v1-PostCmsPhoneRefreshResponse)
  
    - [CmsPhone.StatusType](#keyapis-device-v1-CmsPhone-StatusType)
    - [CmsPhonePaging.DirectionType](#keyapis-device-v1-CmsPhonePaging-DirectionType)
    - [CmsPhonePaging.OrderByType](#keyapis-device-v1-CmsPhonePaging-OrderByType)
  


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




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

## [keyapis/device/v1/keyapis_device_cms_phone_v1.proto](/protos/key/keyapis/device/v1/keyapis_device_cms_phone_v1.proto)
Сервис реализует функционал управления трубками аналоговых трубок


<a name="keyapis-device-v1-CmsPhoneService"></a>

### CmsPhoneService
 Сервис трубок аналоговых трубок

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-device-v1-GetCmsPhone"></a> [GetCmsPhone](#keyapis-device-v1-GetCmsPhone) | Метод получения аналоговой трубки по идентификатору. Метод доступен для: admin, service, owner, employee, bti, ltp_first | [keyapis.device.v1.GetCmsPhoneRequest](#keyapis-device-v1-GetCmsPhoneRequest) | [keyapis.device.v1.GetCmsPhoneResponse](#keyapis-device-v1-GetCmsPhoneResponse) |
| <a id="keyapis-device-v1-GetCmsPhoneList"></a> [GetCmsPhoneList](#keyapis-device-v1-GetCmsPhoneList) | Метод получения списка аналоговых трубок. Метод доступен для: admin, service, owner, employee, bti, ltp_first | [keyapis.device.v1.GetCmsPhoneListRequest](#keyapis-device-v1-GetCmsPhoneListRequest) | [keyapis.device.v1.GetCmsPhoneListResponse](#keyapis-device-v1-GetCmsPhoneListResponse) stream |
| <a id="keyapis-device-v1-GetCmsPhoneCount"></a> [GetCmsPhoneCount](#keyapis-device-v1-GetCmsPhoneCount) | Метод получения количества аналоговых трубок. Метод доступен для: admin, service, owner, employee, bti, ltp_first | [keyapis.device.v1.GetCmsPhoneCountRequest](#keyapis-device-v1-GetCmsPhoneCountRequest) | [keyapis.device.v1.GetCmsPhoneCountResponse](#keyapis-device-v1-GetCmsPhoneCountResponse) |
| <a id="keyapis-device-v1-DeleteCmsPhone"></a> [DeleteCmsPhone](#keyapis-device-v1-DeleteCmsPhone) | Метод удаления аналоговой трубки. Метод доступен для: admin, service | [keyapis.device.v1.DeleteCmsPhoneRequest](#keyapis-device-v1-DeleteCmsPhoneRequest) | [keyapis.device.v1.DeleteCmsPhoneResponse](#keyapis-device-v1-DeleteCmsPhoneResponse) |
| <a id="keyapis-device-v1-DeleteCmsPhoneDeviceId"></a> [DeleteCmsPhoneDeviceId](#keyapis-device-v1-DeleteCmsPhoneDeviceId) | Метод удаления аналоговой трубки по идентификатору устройсва. Метод доступен для: admin, service | [keyapis.device.v1.DeleteCmsPhoneDeviceIdRequest](#keyapis-device-v1-DeleteCmsPhoneDeviceIdRequest) | [keyapis.device.v1.DeleteCmsPhoneDeviceIdResponse](#keyapis-device-v1-DeleteCmsPhoneDeviceIdResponse) |
| <a id="keyapis-device-v1-DeleteCmsPhoneOrponId"></a> [DeleteCmsPhoneOrponId](#keyapis-device-v1-DeleteCmsPhoneOrponId) | Метод удаления аналоговой трубки по идентификатору ОРПОН. Метод доступен для: admin, service | [keyapis.device.v1.DeleteCmsPhoneOrponIdRequest](#keyapis-device-v1-DeleteCmsPhoneOrponIdRequest) | [keyapis.device.v1.DeleteCmsPhoneOrponIdResponse](#keyapis-device-v1-DeleteCmsPhoneOrponIdResponse) |
| <a id="keyapis-device-v1-DeleteCmsPhoneOrponIdRoomNumber"></a> [DeleteCmsPhoneOrponIdRoomNumber](#keyapis-device-v1-DeleteCmsPhoneOrponIdRoomNumber) | Метод удаления аналоговой трубки по идентификатору ОРПОН и номеру квартиры. Метод доступен для: admin, service | [keyapis.device.v1.DeleteCmsPhoneOrponIdRoomNumberRequest](#keyapis-device-v1-DeleteCmsPhoneOrponIdRoomNumberRequest) | [keyapis.device.v1.DeleteCmsPhoneOrponIdRoomNumberResponse](#keyapis-device-v1-DeleteCmsPhoneOrponIdRoomNumberResponse) |
| <a id="keyapis-device-v1-PostCmsPhoneRefresh"></a> [PostCmsPhoneRefresh](#keyapis-device-v1-PostCmsPhoneRefresh) | Метод для принудительного обновления статуса аналоговых трубок. Метод доступен для: admin, service, bti, ltp_first | [keyapis.device.v1.PostCmsPhoneRefreshRequest](#keyapis-device-v1-PostCmsPhoneRefreshRequest) | [keyapis.device.v1.PostCmsPhoneRefreshResponse](#keyapis-device-v1-PostCmsPhoneRefreshResponse) |
| <a id="keyapis-device-v1-DeleteCmsPhoneOrponRoomNumberDeviceId"></a> [DeleteCmsPhoneOrponRoomNumberDeviceId](#keyapis-device-v1-DeleteCmsPhoneOrponRoomNumberDeviceId) | Метод удаления аналоговой трубки по идентификатору ОРПОН, номеру квартиры и идентификатору устройства. Метод доступен для: admin, service | [keyapis.device.v1.DeleteCmsPhoneOrponRoomNumberDeviceIdRequest](#keyapis-device-v1-DeleteCmsPhoneOrponRoomNumberDeviceIdRequest) | [keyapis.device.v1.DeleteCmsPhoneOrponRoomNumberDeviceIdResponse](#keyapis-device-v1-DeleteCmsPhoneOrponRoomNumberDeviceIdResponse) |

 <!-- end services -->


<a name="keyapis-device-v1-CmsPhone"></a>


### [CmsPhone](#keyapis-device-v1-CmsPhone)
 Аналоговая трубка.
# Описание модели


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-device-v1-CmsPhone-id"></a> [id](#keyapis-device-v1-CmsPhone-id) | Идентификатор. # Диапазон: 0..2147483647 |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-device-v1-CmsPhone-orpon_id"></a> [orpon_id](#keyapis-device-v1-CmsPhone-orpon_id) | ОРПОН Дома. # Диапазон: 0..2147483647 |    [int64](#scalar-types) | REQUIRED|
| <a id="keyapis-device-v1-CmsPhone-room"></a> [room](#keyapis-device-v1-CmsPhone-room) | Номер квартиры. # Диапазон: 1..5 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-device-v1-CmsPhone-device_id"></a> [device_id](#keyapis-device-v1-CmsPhone-device_id) | Идентификатор устройства. # Диапазон: 0..2147483647 |    [int32](#scalar-types) | REQUIRED|
| <a id="keyapis-device-v1-CmsPhone-status_type"></a> [status_type](#keyapis-device-v1-CmsPhone-status_type) | Статус аналоговой трубки |    [keyapis.device.v1.CmsPhone.StatusType](#keyapis-device-v1-CmsPhone-StatusType) | REQUIRED|
| <a id="keyapis-device-v1-CmsPhone-created_at"></a> [created_at](#keyapis-device-v1-CmsPhone-created_at) | Дата создания. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-device-v1-CmsPhone-changed_at"></a> [changed_at](#keyapis-device-v1-CmsPhone-changed_at) | Дата последнего изменения. Заполняется и обновляется сервером. Заполняется при создании и изменении. Является версией объекта. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-device-v1-CmsPhone-retry_count"></a> [retry_count](#keyapis-device-v1-CmsPhone-retry_count) | Счетчик попыток обновления. # Диапазон: 0..2147483647 |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-device-v1-CmsPhone-SavingError"></a>


### [CmsPhone.SavingError](#keyapis-device-v1-CmsPhone-SavingError)
 Ошибка сохранения.
Эти проверки выполняются при работе с базой данных и сторонними сервисами


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-device-v1-CmsPhone-SavingError-conflict"></a> [conflict](#keyapis-device-v1-CmsPhone-SavingError-conflict) | Конфликт версий |  optional  [keyapis.device.v1.CmsPhone.SavingError.Conflict](#keyapis-device-v1-CmsPhone-SavingError-Conflict) | <nil>|






<a name="keyapis-device-v1-CmsPhone-SavingError-Conflict"></a>


### [CmsPhone.SavingError.Conflict](#keyapis-device-v1-CmsPhone-SavingError-Conflict)
 Конфликт версий.
Причины:
- В базе хранится другая версия строки, значения changed_at оличаются






<a name="keyapis-device-v1-CmsPhoneFilter"></a>


### [CmsPhoneFilter](#keyapis-device-v1-CmsPhoneFilter)
 Фильтр по аналоговой трубким


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-device-v1-CmsPhoneFilter-device_ids"></a> [device_ids](#keyapis-device-v1-CmsPhoneFilter-device_ids) | По идентификаторам устройства |  repeated  [int32](#scalar-types) | <nil>|
| <a id="keyapis-device-v1-CmsPhoneFilter-status_types"></a> [status_types](#keyapis-device-v1-CmsPhoneFilter-status_types) | По статусам аналоговой трубки |  repeated  [keyapis.device.v1.CmsPhone.StatusType](#keyapis-device-v1-CmsPhone-StatusType) | <nil>|
| <a id="keyapis-device-v1-CmsPhoneFilter-orpon_ids"></a> [orpon_ids](#keyapis-device-v1-CmsPhoneFilter-orpon_ids) | По идентификаторам ОРПОН (дома) |  repeated  [int64](#scalar-types) | <nil>|
| <a id="keyapis-device-v1-CmsPhoneFilter-rooms"></a> [rooms](#keyapis-device-v1-CmsPhoneFilter-rooms) | По номерам квартиры |  repeated  [string](#scalar-types) | <nil>|






<a name="keyapis-device-v1-CmsPhonePaging"></a>


### [CmsPhonePaging](#keyapis-device-v1-CmsPhonePaging)
 Постраничный вывод


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-device-v1-CmsPhonePaging-order_by_type"></a> [order_by_type](#keyapis-device-v1-CmsPhonePaging-order_by_type) | Тип значения сортировки. Если значение не передано, то будет взято значение по умолчанию. # По умолчанию: CHANGED_AT |    [keyapis.device.v1.CmsPhonePaging.OrderByType](#keyapis-device-v1-CmsPhonePaging-OrderByType) | <nil>|
| <a id="keyapis-device-v1-CmsPhonePaging-direction_type"></a> [direction_type](#keyapis-device-v1-CmsPhonePaging-direction_type) | Тип направления сортировки. # По умолчанию: DESC |    [keyapis.device.v1.CmsPhonePaging.DirectionType](#keyapis-device-v1-CmsPhonePaging-DirectionType) | <nil>|
| <a id="keyapis-device-v1-CmsPhonePaging-limit"></a> [limit](#keyapis-device-v1-CmsPhonePaging-limit) | Количество записей на страницу. Если значение 0 (не передано), то будет взято значение по умолчанию. # Диапазон: 0..100. # По умолчанию: 20 |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-device-v1-CmsPhonePaging-offset"></a> [offset](#keyapis-device-v1-CmsPhonePaging-offset) | Сдвиг. # Диапазон: 0..2147483647 |    [int32](#scalar-types) | <nil>|






<a name="keyapis-device-v1-DeleteCmsPhoneDeviceIdRequest"></a>


### [DeleteCmsPhoneDeviceIdRequest](#keyapis-device-v1-DeleteCmsPhoneDeviceIdRequest)
 Запрос удаления аналоговых трубок по идентификатору устройства


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-device-v1-DeleteCmsPhoneDeviceIdRequest-device_id"></a> [device_id](#keyapis-device-v1-DeleteCmsPhoneDeviceIdRequest-device_id) | Идентификатор устройства |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-device-v1-DeleteCmsPhoneDeviceIdResponse"></a>


### [DeleteCmsPhoneDeviceIdResponse](#keyapis-device-v1-DeleteCmsPhoneDeviceIdResponse)
 Ответ на запрос удаления аналоговых трубок по идентификатору устройства






<a name="keyapis-device-v1-DeleteCmsPhoneOrponIdRequest"></a>


### [DeleteCmsPhoneOrponIdRequest](#keyapis-device-v1-DeleteCmsPhoneOrponIdRequest)
 Запрос удаления аналоговых трубок по идентификатору ОРПОН


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-device-v1-DeleteCmsPhoneOrponIdRequest-orpon_id"></a> [orpon_id](#keyapis-device-v1-DeleteCmsPhoneOrponIdRequest-orpon_id) | Идентификатор ОРПОН |    [int64](#scalar-types) | REQUIRED|






<a name="keyapis-device-v1-DeleteCmsPhoneOrponIdResponse"></a>


### [DeleteCmsPhoneOrponIdResponse](#keyapis-device-v1-DeleteCmsPhoneOrponIdResponse)
 Ответ на запрос удаления аналоговых трубок по идентификатору ОРПОН






<a name="keyapis-device-v1-DeleteCmsPhoneOrponIdRoomNumberRequest"></a>


### [DeleteCmsPhoneOrponIdRoomNumberRequest](#keyapis-device-v1-DeleteCmsPhoneOrponIdRoomNumberRequest)
 Запрос удаления аналоговых трубок по идентификатору ОРПОН и номеру квартиры


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-device-v1-DeleteCmsPhoneOrponIdRoomNumberRequest-orpon_id"></a> [orpon_id](#keyapis-device-v1-DeleteCmsPhoneOrponIdRoomNumberRequest-orpon_id) | Идентификатор ОРПОН |    [int64](#scalar-types) | REQUIRED|
| <a id="keyapis-device-v1-DeleteCmsPhoneOrponIdRoomNumberRequest-room_number"></a> [room_number](#keyapis-device-v1-DeleteCmsPhoneOrponIdRoomNumberRequest-room_number) | Номер квартиры |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-device-v1-DeleteCmsPhoneOrponIdRoomNumberResponse"></a>


### [DeleteCmsPhoneOrponIdRoomNumberResponse](#keyapis-device-v1-DeleteCmsPhoneOrponIdRoomNumberResponse)
 Ответ на запрос удаления аналоговых трубок по идентификатору ОРПОН и номеру квартиры






<a name="keyapis-device-v1-DeleteCmsPhoneOrponRoomNumberDeviceIdRequest"></a>


### [DeleteCmsPhoneOrponRoomNumberDeviceIdRequest](#keyapis-device-v1-DeleteCmsPhoneOrponRoomNumberDeviceIdRequest)
 Запрос удаления аналоговых трубок по идентификатору ОРПОН, номеру квартиры и идентификатору устройства


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-device-v1-DeleteCmsPhoneOrponRoomNumberDeviceIdRequest-orpon"></a> [orpon](#keyapis-device-v1-DeleteCmsPhoneOrponRoomNumberDeviceIdRequest-orpon) | Идентификатор ОРПОН |    [int64](#scalar-types) | REQUIRED|
| <a id="keyapis-device-v1-DeleteCmsPhoneOrponRoomNumberDeviceIdRequest-room_number"></a> [room_number](#keyapis-device-v1-DeleteCmsPhoneOrponRoomNumberDeviceIdRequest-room_number) | Номер квартиры |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-device-v1-DeleteCmsPhoneOrponRoomNumberDeviceIdRequest-device_id"></a> [device_id](#keyapis-device-v1-DeleteCmsPhoneOrponRoomNumberDeviceIdRequest-device_id) | Идентификатор устройства |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-device-v1-DeleteCmsPhoneOrponRoomNumberDeviceIdResponse"></a>


### [DeleteCmsPhoneOrponRoomNumberDeviceIdResponse](#keyapis-device-v1-DeleteCmsPhoneOrponRoomNumberDeviceIdResponse)
 Ответ на запрос удаления аналоговых трубок по идентификатору ОРПОН, номеру квартиры и идентификатору устройства






<a name="keyapis-device-v1-DeleteCmsPhoneRequest"></a>


### [DeleteCmsPhoneRequest](#keyapis-device-v1-DeleteCmsPhoneRequest)
 Запрос удаления аналоговой трубки


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-device-v1-DeleteCmsPhoneRequest-id"></a> [id](#keyapis-device-v1-DeleteCmsPhoneRequest-id) | Идентификатор аналоговой трубки |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-device-v1-DeleteCmsPhoneResponse"></a>


### [DeleteCmsPhoneResponse](#keyapis-device-v1-DeleteCmsPhoneResponse)
 Ответ на запрос удаления аналоговой трубки






<a name="keyapis-device-v1-GetCmsPhoneCountRequest"></a>


### [GetCmsPhoneCountRequest](#keyapis-device-v1-GetCmsPhoneCountRequest)
 Запрос получения количества аналоговых трубок


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-device-v1-GetCmsPhoneCountRequest-filter"></a> [filter](#keyapis-device-v1-GetCmsPhoneCountRequest-filter) | Фильтр |    [keyapis.device.v1.CmsPhoneFilter](#keyapis-device-v1-CmsPhoneFilter) | <nil>|






<a name="keyapis-device-v1-GetCmsPhoneCountResponse"></a>


### [GetCmsPhoneCountResponse](#keyapis-device-v1-GetCmsPhoneCountResponse)
 Ответ на запрос получения количества аналоговых трубок


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-device-v1-GetCmsPhoneCountResponse-data"></a> [data](#keyapis-device-v1-GetCmsPhoneCountResponse-data) | Всего устройтсв |  optional  [int32](#scalar-types) | <nil>|
| <a id="keyapis-device-v1-GetCmsPhoneCountResponse-error"></a> [error](#keyapis-device-v1-GetCmsPhoneCountResponse-error) | Ошибка |  optional  [keyapis.device.v1.GetCmsPhoneCountResponse.Error](#keyapis-device-v1-GetCmsPhoneCountResponse-Error) | <nil>|






<a name="keyapis-device-v1-GetCmsPhoneCountResponse-Error"></a>


### [GetCmsPhoneCountResponse.Error](#keyapis-device-v1-GetCmsPhoneCountResponse-Error)
 Ошибка запроса получения количества аналоговых трубок


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






<a name="keyapis-device-v1-GetCmsPhoneListRequest"></a>


### [GetCmsPhoneListRequest](#keyapis-device-v1-GetCmsPhoneListRequest)
 Запрос на получение списка аналоговых трубок


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-device-v1-GetCmsPhoneListRequest-filter"></a> [filter](#keyapis-device-v1-GetCmsPhoneListRequest-filter) | Фильтр |    [keyapis.device.v1.CmsPhoneFilter](#keyapis-device-v1-CmsPhoneFilter) | <nil>|
| <a id="keyapis-device-v1-GetCmsPhoneListRequest-paging"></a> [paging](#keyapis-device-v1-GetCmsPhoneListRequest-paging) | Стандартный постраничный вывод |  optional  [keyapis.device.v1.CmsPhonePaging](#keyapis-device-v1-CmsPhonePaging) | <nil>|






<a name="keyapis-device-v1-GetCmsPhoneListResponse"></a>


### [GetCmsPhoneListResponse](#keyapis-device-v1-GetCmsPhoneListResponse)
 Ответ на получение списка аналоговых трубок


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






<a name="keyapis-device-v1-GetCmsPhoneListResponse-Error"></a>


### [GetCmsPhoneListResponse.Error](#keyapis-device-v1-GetCmsPhoneListResponse-Error)
 Ошибка запроса получения списка аналоговых трубок


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






<a name="keyapis-device-v1-GetCmsPhoneRequest"></a>


### [GetCmsPhoneRequest](#keyapis-device-v1-GetCmsPhoneRequest)
 Запрос получения аналоговой трубки


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-device-v1-GetCmsPhoneRequest-id"></a> [id](#keyapis-device-v1-GetCmsPhoneRequest-id) | Идентификатор |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-device-v1-GetCmsPhoneResponse"></a>


### [GetCmsPhoneResponse](#keyapis-device-v1-GetCmsPhoneResponse)
 Ответ на запрос получения аналоговой трубки


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-device-v1-GetCmsPhoneResponse-data"></a> [data](#keyapis-device-v1-GetCmsPhoneResponse-data) | Аналоговая трубка |  optional  [keyapis.device.v1.CmsPhone](#keyapis-device-v1-CmsPhone) | <nil>|
| <a id="keyapis-device-v1-GetCmsPhoneResponse-error"></a> [error](#keyapis-device-v1-GetCmsPhoneResponse-error) | Ошибка |  optional  [keyapis.device.v1.GetCmsPhoneResponse.Error](#keyapis-device-v1-GetCmsPhoneResponse-Error) | <nil>|






<a name="keyapis-device-v1-GetCmsPhoneResponse-Error"></a>


### [GetCmsPhoneResponse.Error](#keyapis-device-v1-GetCmsPhoneResponse-Error)
 Ошибка запроса получения баннера


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






<a name="keyapis-device-v1-PostCmsPhoneRefreshRequest"></a>


### [PostCmsPhoneRefreshRequest](#keyapis-device-v1-PostCmsPhoneRefreshRequest)
 Запрос на принудительное обновление статуса аналоговой трубки


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-device-v1-PostCmsPhoneRefreshRequest-ids"></a> [ids](#keyapis-device-v1-PostCmsPhoneRefreshRequest-ids) | Идентификатор |  repeated  [int32](#scalar-types) | REQUIRED|






<a name="keyapis-device-v1-PostCmsPhoneRefreshResponse"></a>


### [PostCmsPhoneRefreshResponse](#keyapis-device-v1-PostCmsPhoneRefreshResponse)
 Ответ на запрос на принудительное обновление статуса аналоговой трубки





 <!-- end messages -->



<a name="keyapis-device-v1-CmsPhone-StatusType"></a>

### [CmsPhone.StatusType](#keyapis-device-v1-CmsPhone-StatusType)
 Справочник статусов аналоговой трубки.
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-device-v1-CmsPhone-StatusType-STATUS_TYPE_UNKNOWN"></a> [STATUS_TYPE_UNKNOWN](#keyapis-device-v1-CmsPhone-StatusType-STATUS_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-device-v1-CmsPhone-StatusType-PENDING_ACTIVE"></a> [PENDING_ACTIVE](#keyapis-device-v1-CmsPhone-StatusType-PENDING_ACTIVE) | Ожидает активации |
| 2 | <a id="keyapis-device-v1-CmsPhone-StatusType-ACTIVE"></a> [ACTIVE](#keyapis-device-v1-CmsPhone-StatusType-ACTIVE) | Активна |
| 3 | <a id="keyapis-device-v1-CmsPhone-StatusType-PENDING_BLOCKED"></a> [PENDING_BLOCKED](#keyapis-device-v1-CmsPhone-StatusType-PENDING_BLOCKED) | Ожидает блокировки |
| 4 | <a id="keyapis-device-v1-CmsPhone-StatusType-BLOCKED"></a> [BLOCKED](#keyapis-device-v1-CmsPhone-StatusType-BLOCKED) | Заблокирована |




<a name="keyapis-device-v1-CmsPhonePaging-DirectionType"></a>

### [CmsPhonePaging.DirectionType](#keyapis-device-v1-CmsPhonePaging-DirectionType)
 Справочник типов направлений сортировки;
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-device-v1-CmsPhonePaging-DirectionType-DIRECTION_TYPE_UNKNOWN"></a> [DIRECTION_TYPE_UNKNOWN](#keyapis-device-v1-CmsPhonePaging-DirectionType-DIRECTION_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-device-v1-CmsPhonePaging-DirectionType-DESC"></a> [DESC](#keyapis-device-v1-CmsPhonePaging-DirectionType-DESC) | От большего к меньшему |
| 2 | <a id="keyapis-device-v1-CmsPhonePaging-DirectionType-ASC"></a> [ASC](#keyapis-device-v1-CmsPhonePaging-DirectionType-ASC) | От меньшего к большему |




<a name="keyapis-device-v1-CmsPhonePaging-OrderByType"></a>

### [CmsPhonePaging.OrderByType](#keyapis-device-v1-CmsPhonePaging-OrderByType)
 Справочник типов значений сортировки.
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-device-v1-CmsPhonePaging-OrderByType-ORDER_BY_TYPE_UNKNOWN"></a> [ORDER_BY_TYPE_UNKNOWN](#keyapis-device-v1-CmsPhonePaging-OrderByType-ORDER_BY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-device-v1-CmsPhonePaging-OrderByType-ID"></a> [ID](#keyapis-device-v1-CmsPhonePaging-OrderByType-ID) | По идентификатору |
| 2 | <a id="keyapis-device-v1-CmsPhonePaging-OrderByType-STATUS"></a> [STATUS](#keyapis-device-v1-CmsPhonePaging-OrderByType-STATUS) | По статусу доступности |
| 3 | <a id="keyapis-device-v1-CmsPhonePaging-OrderByType-CHANGED_AT"></a> [CHANGED_AT](#keyapis-device-v1-CmsPhonePaging-OrderByType-CHANGED_AT) | Дата последнего изменения |
| 4 | <a id="keyapis-device-v1-CmsPhonePaging-OrderByType-CREATED_AT"></a> [CREATED_AT](#keyapis-device-v1-CmsPhonePaging-OrderByType-CREATED_AT) | Дата создания |


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