/* Сервис реализует функционал управления SIP-трубками */ syntax = "proto3"; import "google/protobuf/timestamp.proto"; import "google/api/annotations.proto"; import "google/api/field_behavior.proto"; import "google/protobuf/descriptor.proto"; import "keyapis/device/v1/keyapis_device_device_v1.proto"; package keyapis.device.v1; option java_package = "ru.keyapis.device.v1"; option java_outer_classname = "KeyapisDeviceV1Proto"; option java_multiple_files = false; option java_string_check_utf8 = true; option go_package = "/keyapis_device_v1"; option cc_enable_arenas = true; option csharp_namespace = "Keyapis.Device.V1"; option objc_class_prefix = "KEYAPISDEVICEV1"; option php_namespace = "Keyapis\\Device\\V1"; option ruby_package = "Keyapis::Device::V1"; option optimize_for = LITE_RUNTIME; // Сервис управления SIP-трубками service SipPhoneService { // Метод получения SIP-трубки по идентификатору. // Метод доступен для: admin, service, bti, ltp_first rpc GetSipPhone(GetSipPhoneRequest) returns (GetSipPhoneResponse) { option (google.api.http) = { get: "/device/api/v1/sip_phone/{id}" }; } // Метод получения списка SIP-трубок. // Метод доступен для: admin, service, bti, ltp_first rpc GetSipPhoneList(GetSipPhoneListRequest) returns (stream GetSipPhoneListResponse) { option (google.api.http) = { get: "/device/api/v1/sip_phone/list" }; } // Метод получения количества SIP-трубок. // Метод доступен для: admin, service, bti, ltp_first rpc GetSipPhoneCount(GetSipPhoneCountRequest) returns (GetSipPhoneCountResponse) { option (google.api.http) = { get: "/device/api/v1/sip_phone/count" }; } // Метод получения списка SIP-трубок. // Метод доступен для: admin, service, bti, ltp_first rpc PostSipPhoneGetList(PostSipPhoneGetListRequest) returns (PostSipPhoneGetListResponse) { option (google.api.http) = { post: "/device/api/v1/sip_phone/get_list", body: "*" }; } // Метод получения количества SIP-трубок. // Метод доступен для: admin, service, bti, ltp_first rpc PostSipPhoneGetCount(PostSipPhoneGetCountRequest) returns (PostSipPhoneGetCountResponse) { option (google.api.http) = { post: "/device/api/v1/sip_phone/get_count", body: "*" }; } } // SIP-трубка. // # Описание модели message SipPhone { // Идентификатор трубки. // # Диапазон: 0..2147483647 int32 id = 1; // Идентификатор квартиры. // # Диапазон: 0..2147483647 int32 room_id = 2; // SIP номер. // # Диапазон: 1..200 string sip_number = 3; // Справочник статусов SIP-трубки. // # Тип: byte enum StatusType { // Значение не указано STATUS_TYPE_UNKNOWN = 0; // Активна ACTIVE = 1; // Заблокирована BLOCKED = 2; } // Статус SIP-трубки StatusType status_type = 4 [(google.api.field_behavior) = REQUIRED]; // Дата создания. // # Тип: DateTime google.protobuf.Timestamp created_at = 5 [(google.api.field_behavior) = OUTPUT_ONLY]; // Дата последнего изменения. // Заполняется и обновляется сервером. // Заполняется при создании и изменении. // Является версией объекта. // # Тип: DateTime google.protobuf.Timestamp changed_at = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; // Ошибка сохранения. // Эти проверки выполняются при работе с базой данных и сторонними сервисами message SavingError { // Конфликт версий. // Причины: // - В базе хранится другая версия строки, значения changed_at оличаются message Conflict {} // Причина ошибки oneof reason { // Конфликт версий Conflict conflict = 1; } } } // Фильтр для SIP-трубок message SipPhoneFilter { // Фильтр по SIP номерам repeated string sip_numbers = 1; // Фильтр по идентификаторам квартир repeated int32 room_ids = 2; } // Постраничный вывод message SipPhonePaging { // Справочник типов значений сортировки. // # Тип: byte enum OrderByType { // Значение не указано ORDER_BY_TYPE_UNKNOWN = 0; // По идентификатору ID = 1; // По статусу доступности STATUS = 2; // Дата последнего изменения CHANGED_AT = 3; // Дата создания CREATED_AT = 4; } // Тип значения сортировки. // Если значение не передано, то будет взято значение по умолчанию. // # По умолчанию: CHANGED_AT OrderByType order_by_type = 1; // Справочник типов направлений сортировки; // # Тип: byte enum DirectionType { // Значение не указано DIRECTION_TYPE_UNKNOWN = 0; // От большего к меньшему DESC = 1; // От меньшего к большему ASC = 2; } // Тип направления сортировки. // # По умолчанию: DESC DirectionType direction_type = 2; // Количество записей на страницу. // Если значение 0 (не передано), то будет взято значение по умолчанию. // # Диапазон: 0..100. // # По умолчанию: 20 int32 limit = 3; // Сдвиг. // # Диапазон: 0..2147483647 int32 offset = 4; } // Запрос на получение SIP-трубки message GetSipPhoneRequest { // Идентификатор трубки int32 id = 1 [(google.api.field_behavior) = REQUIRED]; } // Ответ на запрос SIP-трубки message GetSipPhoneResponse { // Ошибка запроса получения баннера message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Тип результата oneof type { // SIP-трубка SipPhone data = 1; // Ошибка Error error = 2; } } // Запрос на получение списка SIP-трубок message GetSipPhoneListRequest { // Фильтр SipPhoneFilter filter = 1; // Вариант разбиения на страницы oneof pagination { // Стандартный постраничный вывод SipPhonePaging paging = 2; } } // Ответ на запрос списка SIP-трубок message GetSipPhoneListResponse { // Ошибка запроса получения списка SIP-трубок message Error { // Ошибка валидации ValidationError validation_error = 1; } // Тип результата oneof type { // SIP-трубка SipPhone data = 1; // Ошибка Error error = 2; } } // Запрос на получение количества SIP-трубок message GetSipPhoneCountRequest { // Фильтр SipPhoneFilter filter = 1; } // Ответ на запрос количества SIP-трубок message GetSipPhoneCountResponse { // Ошибка запроса получения количества SIP-трубок message Error {} // Тип результата oneof type { // Всего трубок int32 data = 1; // Ошибка Error error = 2; } } // Запрос на получение списка SIP-трубок message PostSipPhoneGetListRequest { // Фильтр SipPhoneFilter filter = 1; // Вариант разбиения на страницы oneof pagination { // Стандартный постраничный вывод SipPhonePaging paging = 2; } } // Ответ на запрос списка SIP-трубок message PostSipPhoneGetListResponse { // Ошибка запроса получения списка SIP-трубок message Error { // Причина ошибки oneof reason { // Ошибка валидации ValidationError validation = 1; } } // Список SIP-трубок repeated SipPhone items = 1; // Ошибка Error error = 2; } // Запрос на получение количества SIP-трубок message PostSipPhoneGetCountRequest { // Фильтр SipPhoneFilter filter = 1; } // Ответ на запрос количества SIP-трубок message PostSipPhoneGetCountResponse { // Ошибка запроса получения количества SIP-трубок message Error {} // Тип результата oneof type { // Всего трубок int32 data = 1; // Ошибка Error error = 2; } }