Протокол¶
Оглавление¶
Схема классов¶
deviceapis/device/v1/deviceapis_device_concierge_v1.proto¶
Сервис управления настройками Concierge
ConciergeSettingsService¶
Сервис управления настройками Concierge
| Название метода | Описание | Тип запроса | Тип ответа |
|---|---|---|---|
| EditConciergeSettings | Метод редактирования настроек Concierge | deviceapis.device.v1.EditConciergeSettingsRequest | deviceapis.device.v1.EditConciergeSettingsResponse |
| GetConciergeSettings | Метод получения настроек Concierge | deviceapis.device.v1.GetConciergeSettingsRequest | deviceapis.device.v1.GetConciergeSettingsResponse |
ConciergeSettings¶
Настройки Concierge
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| is_concierge_on | Флаг включения Concierge вызова | bool | REQUIRED |
| sip_invite | Параметр SIP Invite для Concierge вызова. Произвольная строка которая передается в SIP сервер. Диапазон: 1..128 | string | REQUIRED |
| sip_server | Параметр SIP Server для Concierge вызова. При пустом sip_server будет использован сервер SIP регистрации | string |
EditConciergeSettingsRequest¶
Запрос редактирования настроек Concierge
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Настройки Concierge | deviceapis.device.v1.ConciergeSettings | REQUIRED |
| update_mask | Маска полей обновления | google.protobuf.FieldMask |
EditConciergeSettingsResponse¶
Ответ на запрос редактирования настроек Concierge
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Настройки Concierge | optional deviceapis.device.v1.ConciergeSettings | |
| error | Ошибка | optional deviceapis.device.v1.EditConciergeSettingsResponse.Error |
EditConciergeSettingsResponse.Error¶
Ошибка запроса
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| validation | Ошибка валидации | optional deviceapis.device.v1.ValidationError |
GetConciergeSettingsRequest¶
Запрос получения настроек Concierge
GetConciergeSettingsResponse¶
Ответ на запрос получения настроек Concierge
| Поле | Описание | Тип | Признак |
|---|---|---|---|
| data | Настройки Concierge | optional deviceapis.device.v1.ConciergeSettings |
Скалярные типы значений¶
| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
|---|---|---|---|---|---|---|---|---|
| double | float | float64 | Float | double | double | double | float | |
| float | float | float32 | Float | float | float | float | float | |
| int32 | 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 | 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 | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| uint64 | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| sint32 | 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 | 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 | 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 | 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 | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| sfixed64 | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| bool | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| bytes | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |