API docs by Redocly

TrueConf WEB API (1.0)

Download OpenAPI specification:Download

TrueConf: support@trueconf.ru URL: https://www.trueconf.ru

_OAuth

Get system oauth client

Получение id клиентского приложения oauth по id которого потом авторизуемся.

Responses

Response samples

Content type
application/json
{
  • "client_id": "string",
  • "display_name": "string"
}

Get access/refresh tokens

Генерация пары токенов / продление access токена по refresh токену / повышение прав access токена в зависимости от типа авторизации.

Request Body schema: application/json
required
client_id
required
string <uuid>

Id клиентского приложения oauth по id которого потом авторизуемся

grant_type
required
string (- OGT_PASSWORD: авторизация по логину/паролю - OGT_IP: авторизация по IP-адресу (только для локального пользователя: IP=127.0.0.1) - OGT_CODE: авторизация по коду отображаемому на экране TCG (для планшетов) - OGT_PIN: повышение прав существующего токена до Администратора - OGT_REFRESH: обновление access токена по refresh токену - OGT_SSH_API: авторизация по логину/паролю для сторонних пользователей работающих через WEB API)
Default: "OGT_UNSPECIFIED"
Enum: "OGT_UNSPECIFIED" "OGT_PASSWORD" "OGT_IP" "OGT_CODE" "OGT_PIN" "OGT_REFRESH" "OGT_SSH_API"
client_secret
string or null

Пароль клиентского приложения (у нас его пока нет)

scopes
required
Array of strings

Запрашиваемые права (должно быть всегда ["all"])

username
string or null

Логин пользователя (используется только для grant_type = OGT_PASSWORD)

password
string or null

Пароль пользователя (используется только для grant_type = OGT_PASSWORD)

refresh_token
string or null

Refresh токен (используется только для grant_type = OGT_REFRESH при обновлении access токена по refresh токену)

access_token
string or null

Access токен (используется только для grant_type = OGT_PIN при повышении прав access токена)

pin
string or null

Пин код (используется только для grant_type = OGT_PIN при повышении прав access токена)

code
string or null

Код авторизации планшета (используется только для grant_type = OGT_CODE при авторизации планшета)

tablet_id
string or null <uuid>

Id планшета (используется только для grant_type = OGT_CODE при авторизации планшета)

Responses

Request samples

Content type
application/json
{
  • "client_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "grant_type": "OGT_UNSPECIFIED",
  • "client_secret": null,
  • "scopes": [
    ],
  • "username": "admin",
  • "password": "admin",
  • "refresh_token": "ABCDefgh",
  • "access_token": "ABCDefgh",
  • "pin": "0000",
  • "code": "123456",
  • "tablet_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc"
}

Response samples

Content type
application/json
{
  • "created_at": "2019-08-24T14:15:22Z",
  • "access_token": "string",
  • "expires_in": "2019-08-24T14:15:22Z",
  • "refresh_token": "string"
}

Address Book

Get Address Book Files From Usb Drive

Возвращает список доступных файлов с адресными книгами

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Clean Address Book

Очищает историю звонков, адреса, группы, контакты

Request Body schema: application/json
required
object (domainCleanAddressBookRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Export Address Book File To Usb Drive

Экспорт адресной книги с подключенного USB накопителя

Responses

Response samples

Content type
application/json
{ }

Import Address Book File From Usb Drive

Импорт адресной книги с подключенного USB накопителя

Request Body schema: application/json
required
file_name
required
string

Имя файла адресной книги для импорта

relative_path
string

Относительный путь к файлу на USB-накопителе

Responses

Request samples

Content type
application/json
{
  • "file_name": "contacts.csv",
  • "relative_path": "/usb_drive/contacts/"
}

Response samples

Content type
application/json
{ }

Addresses

Get address

Получение адреса по id

query Parameters
address_id
required
string <uuid>

Id адреса

Responses

Response samples

Content type
application/json
{
  • "address": {
    }
}

Get addresses

Получение списка адресов

query Parameters
page
string <int64>

Номер страницы со списком адресов

page_size
string <int64>

Число записей на странице

sort_order
string <int64>

Порядок сортировки записей

sort_field
string

Поле по которому сортируем записи. Допустимы значения 'created_at' и 'display_name'.

protocols
Array of strings

Список протоколов (протокол - компонент адреса) по которому фильтруем адреса.

port
string <int64>

Номер порта (компонент адреса) по которому фильтруем адреса.

username
string

Имя пользователя (компонент адреса) по которому фильтруем адреса.

password
string

Пароль (компонент адреса) по которому фильтруем адреса.

host
string

Хост или ip-адрес (компонент адреса) по которому фильтруем адреса.

path
string

Путь (компонент адреса) по которому фильтруем адреса.

parameters
string

Параметры (компоненты адреса) по которому фильтруем адреса.

query
string

Запрос (компонент адреса) по которому фильтруем адреса.

fragment
string

Фрагмент (компонент адреса) по которому фильтруем адреса.

display_name
string

Отображаемое имя адреса по которому фильтруем адреса.

contact_id
string <uuid>

Id контакта которому принадлежит адрес

addresses
Array of strings

Id адресов которые хотим прочитать

search
string

Фильтр поиска по отображаемому имени и uri.

uri
string

Собственно адрес (фильтр поиска).

is_binded
boolean

Фильтр поиска по признаку привязки адреса к контакту.

is_device
boolean

Фильтр поиска по признаку принадлежности адреса к устройству.

contact_display_name
string

Отображаемое имя контакта по которому принадлежат отбираемые адреса.

Responses

Response samples

Content type
application/json
{
  • "addresses": [
    ]
}

Audio Codecs

Get Audio Codec Settings

Получение списка используемых аудиокодеков

Responses

Response samples

Content type
application/json
{
  • "codecs": [
    ]
}

Set Audio Codec Settings

Изменение списка используемых аудиокодеков

query Parameters
codecs
required
Array of strings
Items Enum: "ACODEC_UNDEFINED" "ACODEC_OPUS" "ACODEC_AAC" "ACODEC_ILBC" "ACODEC_G711" "ACODEC_G719" "ACODEC_G722" "ACODEC_G723" "ACODEC_G7221" "ACODEC_G7221C" "ACODEC_G726" "ACODEC_G728" "ACODEC_G729"

Список аудиокодеков которые хотим включить

Responses

Response samples

Content type
application/json
{
  • "request_id": "1234567890"
}

Audio Devices

Get Audio Input Device

Получение параметров аудио устройства по id

query Parameters
device_id
required
string

Id аудио устройства

Responses

Response samples

Content type
application/json
{
  • "device": {
    }
}

Get Audio Output Device

Получение параметров 'выходного' аудио устройства (динамика)

query Parameters
device_id
required
string

Id аудио устройства

Responses

Response samples

Content type
application/json
{
  • "device": {
    }
}

Get Audio Input Devices

Получение параметров аудио устройств

Responses

Response samples

Content type
application/json
{
  • "devices": [
    ]
}

Update Audio Input Device

Изменение параметров аудио устройства

Request Body schema: application/json
required
device_id
required
string

Id аудио устройства

display_name
required
string

Отображаемое имя аудио устройства

aec_mode
required
string (- AECM_DISABLED: режим эхоподавления отключен - AECM_50HZ_FILTER: только фильтр 50Гц - AECM_HALF_DUPLEX: полудуплексный режим эхоподавления - AECM_FULL_DUPLEX: дуплексный режим эхоподавления - AECM_USER_DEFINED: пользовательский режим эхоподавления)
Default: "AECM_UNKNOWN"
Enum: "AECM_UNKNOWN" "AECM_DISABLED" "AECM_50HZ_FILTER" "AECM_HALF_DUPLEX" "AECM_FULL_DUPLEX" "AECM_USER_DEFINED"
noise_suppression
required
boolean

Флаг использования шумоподавления

auto_gain_control
required
boolean

Флаг использования автоматической регулировки усиления (АРУ)

Responses

Request samples

Content type
application/json
{
  • "device_id": "microphone-12345",
  • "display_name": "My Microphone",
  • "aec_mode": "AECM_UNKNOWN",
  • "noise_suppression": false,
  • "auto_gain_control": true
}

Response samples

Content type
application/json
{ }

Start Microphone Device

Запуск получения аудиоданных с существующего аудио устройства

Request Body schema: application/json
required
value
required
string

Id микрофона

Responses

Request samples

Content type
application/json
{
  • "value": "microphone-12345"
}

Response samples

Content type
application/json
{ }

Get Audio Output Devices

Получение параметров 'выходных' аудио устройств (динамиков)

Responses

Response samples

Content type
application/json
{
  • "devices": [
    ]
}

Update Audio Output Device

Изменение параметров 'выходного' аудио устройства (динамика)

Request Body schema: application/json
required
device_id
required
string

Id аудио устройства

display_name
required
string

Отображаемое имя аудио устройства

Responses

Request samples

Content type
application/json
{
  • "device_id": "microphone-12345",
  • "display_name": "My Microphone"
}

Response samples

Content type
application/json
{ }

Get Audio Test Mode

Получение режима тестирования аудио устройств (микрофонов или динамиков)

Responses

Response samples

Content type
application/json
{
  • "mode": "AUDIO_TEST_MODE_UNKNOWN",
  • "timeout": 60000
}

Set Audio Test Mode

Изменение режима тестирования аудио устройств (микрофонов или динамиков)

Request Body schema: application/json
required
mode
required
string (- AUDIO_TEST_MODE_SPEAKER: запустить тест динамика - AUDIO_TEST_MODE_MICROPHONE: запустить тест микрофона - AUDIO_TEST_MODE_DISABLE: остановить тест)
Default: "AUDIO_TEST_MODE_UNKNOWN"
Enum: "AUDIO_TEST_MODE_UNKNOWN" "AUDIO_TEST_MODE_SPEAKER" "AUDIO_TEST_MODE_MICROPHONE" "AUDIO_TEST_MODE_DISABLE"
timeout
integer or null <int64> ((not implemented) timeout in milliseconds, default is 300`000 milliseconds and will be set if the value is missing)
Default: "300000"

Время тестирования аудио устройства в миллисекундах (пока не реализовано)

Responses

Request samples

Content type
application/json
{
  • "mode": "AUDIO_TEST_MODE_UNKNOWN",
  • "timeout": 60000
}

Response samples

Content type
application/json
{ }

Calendar

Get Call History

Возвращает запланированные конференции из разных источников

query Parameters
page
string <int64>

Номер страницы

page_size
string <int64>

Количество конференций на странице

sort_order
string <int64>

Порядок сортировки (1 для возрастания, -1 для убывания)

sort_field
string

Поле сортировки

date_from
string <date-time>

Начальная дата выборки конференций

date_to
string <date-time>

Конечная дата выборки конференций

provider_types
Array of strings
Items Enum: "PT_UNKNOWN" "PT_MCU" "PT_TCS" "PT_MAIL" "PT_MDNS" "PT_LDAP" "PT_NDI"

Список типов провайдеров для фильтрации

  • PT_MCU: тип провайдера: MCU сервер
  • PT_TCS: тип провайдера: ТКС сервер
  • PT_MAIL: тип провайдера: Почтовый сервер
  • PT_MDNS: тип провайдера: MDNS
  • PT_LDAP: тип провайдера: LDAP сервер
  • PT_NDI: тип провайдера: NDI
provider_ids
Array of strings

Список идентификаторов провайдеров

display_name
string

Отображаемое имя конференции для фильтрации

search
string

Строка поиска по конференциям.

Responses

Response samples

Content type
application/json
{
  • "conferences": [
    ]
}

Sync Scheduled Conferences

Синхронизирует запланированные конференции, обновляя локальные данные на основе источников

Request Body schema: application/json
required
provider_id
required
string

Идентификатор провайдера

provider_type
required
string (- PT_MCU: тип провайдера: MCU сервер - PT_TCS: тип провайдера: ТКС сервер - PT_MAIL: тип провайдера: Почтовый сервер - PT_MDNS: тип провайдера: MDNS - PT_LDAP: тип провайдера: LDAP сервер - PT_NDI: тип провайдера: NDI)
Default: "PT_UNKNOWN"
Enum: "PT_UNKNOWN" "PT_MCU" "PT_TCS" "PT_MAIL" "PT_MDNS" "PT_LDAP" "PT_NDI"

Responses

Request samples

Content type
application/json
{
  • "provider_id": "provider-001",
  • "provider_type": "PT_UNKNOWN"
}

Response samples

Content type
application/json
{ }

Call History

Get Call History

Получает список записей истории звонков

query Parameters
page
string <int64>

Номер страницы для пагинации

page_size
string <int64>

Количество записей на страницу

sort_order
string <int64>

Порядок сортировки (например, 1 для возрастания)

sort_field
string

Поле, по которому производится сортировка

date_from
string <date-time>

Начальная дата выборки

date_to
string <date-time>

Конечная дата выборки

contact_ids
Array of strings

Список идентификаторов контактов для фильтрации

type
string
Default: "CHT_UNKNOWN"
Enum: "CHT_UNKNOWN" "CHT_INCOMING" "CHT_OUTGOING" "CHT_MISSED"

Тип звонка для фильтрации

  • CHT_INCOMING: входящий звонок
  • CHT_OUTGOING: исходящий звонок
  • CHT_MISSED: пропущенный звонок
search
string

Строка поиска по записям истории звонков

Responses

Response samples

Content type
application/json
{
  • "entries": [
    ]
}

Clean Call History

Очищает всю историю звонков

Request Body schema: application/json
required
object (domainCleanCallHistoryRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Get Call History Entry

Получает детальную информацию по записи истории звонков

query Parameters
abonent_id
required
string

Идентификатор абонента

Responses

Response samples

Content type
application/json
{
  • "entry": {
    }
}

Delete Call History Entry

Удаляет выбранную запись истории звонков

Request Body schema: application/json
required
abonent_id
required
string

Идентификатор абонента для удаления записи

Responses

Request samples

Content type
application/json
{
  • "abonent_id": "string"
}

Response samples

Content type
application/json
{ }

Export Call History File To Usb Drive

Экспортирует историю звонков на USB-накопитель

Request Body schema: application/json
required
object (domainExportCallHistoryFileToUsbDriveRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Call Info

Get Abonents

Получает список абонентов

query Parameters
state
string
Default: "CS_UNKNOWN"
Enum: "CS_UNKNOWN" "CS_PROGRESS" "CS_ESTABLISHED" "CS_INACTIVE"

Фильтр по состоянию звонка

  • CS_PROGRESS: состояние звонка: устанавливается соединение
  • CS_ESTABLISHED: состояние звонка: соединение установилось
  • CS_INACTIVE: состояние звонка: соединение разорвано

Responses

Response samples

Content type
application/json
{
  • "abonents": [
    ]
}

Get Active Conference

Возвращает активную конференцию

Responses

Response samples

Content type
application/json
{
  • "started_at": "2025-03-13T15:30:00Z"
}

Get Engine Abonent

Получает информацию о подключенном абоненте

query Parameters
connection_id
required
string <uuid>

UUID4 идентификатор соединения для получения информации об абоненте

Responses

Response samples

Content type
application/json
{
  • "status": {
    },
  • "audio": {
    },
  • "video": {
    },
  • "content": {
    }
}

Get Engine Abonents

Получает информацию о подключенных абонентах

Responses

Response samples

Content type
application/json
{
  • "abonents": [
    ]
}

Calls

HangUp Abonent

Отбивание звонка

Request Body schema: application/json
required
connection_id
required
string <uuid>

Id звонка который хотим отбить

Responses

Request samples

Content type
application/json
{
  • "connection_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc"
}

Response samples

Content type
application/json
{ }

HangUp All Abonent

Отбивание всех звонков

Responses

Response samples

Content type
application/json
{ }

Accept Abonent

Принятие звонка

Request Body schema: application/json
required
connection_id
required
string <uuid>

Id звонка который хотим принять

Responses

Request samples

Content type
application/json
{
  • "connection_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc"
}

Response samples

Content type
application/json
{ }

Dial Out Call String

Звонок на адрес

Request Body schema: application/json
required
address_id
required
string <uuid>

Id адреса на который хотим позвонить

display_name
string or null

Отображаемое имя адреса на который хотим позвонить

object (domainContactAddressPayload)

Responses

Request samples

Content type
application/json
{
  • "address_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "display_name": "Peregovorka",
  • "payload": {
    }
}

Response samples

Content type
application/json
{ }

Dial Out Contact

Звонок на контакт

Request Body schema: application/json
required
contact_id
required
string <uuid>

Id контакта на который хотим позвонить

display_name
string or null

Отображаемое имя контакта на который хотим позвонить

priority_address_id
string or null <uuid>

Id приоритетного адреса контакта (на него хотим позвонить в первую очередь)

object (domainContactPayload)

Responses

Request samples

Content type
application/json
{
  • "contact_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "display_name": "Ivanov",
  • "priority_address_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "payload": {
    }
}

Response samples

Content type
application/json
{ }

Send DTMF Message

Отправка DTMF сообщения удаленному абоненту

Request Body schema: application/json
required
connection_id
required
string <uuid> (uuid4 connection identifier)

Id звонка на который хотим послать DTMF сообщение

message
required
string (- DTMFM_0: DTMF код символа: 0 - DTMFM_1: DTMF код символа: 1 - DTMFM_2: DTMF код символа: 2 - DTMFM_3: DTMF код символа: 3 - DTMFM_4: DTMF код символа: 4 - DTMFM_5: DTMF код символа: 5 - DTMFM_6: DTMF код символа: 6 - DTMFM_7: DTMF код символа: 7 - DTMFM_8: DTMF код символа: 8 - DTMFM_9: DTMF код символа: 9 - DTMFM_ASTERISK: DTMF код символа: * - DTMFM_POUND: DTMF код символа: #)
Default: "DTMFM_UNSPECIFIED"
Enum: "DTMFM_UNSPECIFIED" "DTMFM_0" "DTMFM_1" "DTMFM_2" "DTMFM_3" "DTMFM_4" "DTMFM_5" "DTMFM_6" "DTMFM_7" "DTMFM_8" "DTMFM_9" "DTMFM_ASTERISK" "DTMFM_POUND"

Responses

Request samples

Content type
application/json
{
  • "connection_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "message": "DTMFM_UNSPECIFIED"
}

Response samples

Content type
application/json
{ }

Dial Out Provider Contact

Звонок на контакт провайдера

Request Body schema: application/json
required
contact_id
required
string <uuid>

Id контакта провайдера на который хотим позвонить

display_name
string or null

Отображаемое имя контакта провайдера на который хотим позвонить

Responses

Request samples

Content type
application/json
{
  • "contact_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "display_name": "Ivanov"
}

Response samples

Content type
application/json
{ }

Get Call Settings

Получение настроек звонков

Responses

Response samples

Content type
application/json
{
  • "use_sip": true,
  • "use_h323": true,
  • "protocol_priority": "PP_UNKNOWN",
  • "far_end_camera_control": true,
  • "autosend_presentation": true
}

Set Call Settings

Изменение настроек звонков

Request Body schema: application/json
required
use_sip
required
boolean

Использовать SIP протокол

use_h323
required
boolean

Использовать H323 протокол

protocol_priority
required
string (- PP_SIP_FIRST: приоритет использования протоколов: сначала SIP - PP_H323_FIRST: приоритет использования протоколов: сначала H323)
Default: "PP_UNKNOWN"
Enum: "PP_UNKNOWN" "PP_SIP_FIRST" "PP_H323_FIRST"
far_end_camera_control
required
boolean

Флаг разрешающий удаленное управление камерой

autosend_presentation
required
boolean

Флаг автоматической отправки презентации

Responses

Request samples

Content type
application/json
{
  • "use_sip": true,
  • "use_h323": true,
  • "protocol_priority": "PP_UNKNOWN",
  • "far_end_camera_control": true,
  • "autosend_presentation": true
}

Response samples

Content type
application/json
{ }

Get Call Accept Settings

Получение настроек приема звонков

Responses

Response samples

Content type
application/json
{
  • "mute_microphone": true,
  • "mute_camera": true,
  • "spam_protection": true,
  • "autoreject_sip_calls": true,
  • "autoreject_while_recording": true
}

Set Call Accept Settings

Изменение настроек приема звонков

Request Body schema: application/json
required
mute_microphone
required
boolean

Флаг мьюта микрофона при принятии звонка

mute_camera
required
boolean

Флаг мьюта камеры при принятии звонка

spam_protection
required
boolean

Флаг защиты от спама

autoreject_sip_calls
required
boolean

Автоматически отклонять SIP звонки

autoreject_while_recording
required
boolean

Автоматически отклонять звонки при видеозаписи

Responses

Request samples

Content type
application/json
{
  • "mute_microphone": true,
  • "mute_camera": true,
  • "spam_protection": true,
  • "autoreject_sip_calls": true,
  • "autoreject_while_recording": true
}

Response samples

Content type
application/json
{ }

Get H323 Settings

Получение настроек H323

Responses

Response samples

Content type
application/json
{
  • "is_h323_enabled": true,
  • "h235_mode": "H235_UNKNOWN",
  • "gatekeeper_mode": "GTK_UNKNOWN",
  • "use_gatekeeper_as_proxy": true,
  • "e164_number": "1234",
  • "h323_name": "Ivanov",
  • "gatekeeper_address": "1.2.3.4",
  • "auth": {
    }
}

Set H323 Settings

Изменение настроек H323

Request Body schema: application/json
required
is_h323_enabled
required
boolean

Флаг того что регистрация на гейткипере включена

h235_mode
required
string (- H235_DISABLED: encrypted calls are prohibited - H235_ENABLED: both encrypted and unencrypted calls are allowed - H235_REQUIRED: unencrypted calls are prohibited)
Default: "H235_UNKNOWN"
Enum: "H235_UNKNOWN" "H235_DISABLED" "H235_ENABLED" "H235_REQUIRED"
gatekeeper_mode
required
string (- GTK_DISABLED: point to point calls only - GTK_MANUAL: gatekeeper address is explicitly provided)
Default: "GTK_UNKNOWN"
Enum: "GTK_UNKNOWN" "GTK_DISABLED" "GTK_MANUAL"
use_gatekeeper_as_proxy
required
boolean

Флаг использования гейткипера как прокси

e164_number
required
string

Дополнительный номер абонента

h323_name
required
string

Имя абонента

gatekeeper_address
required
string

Адрес гейткипера

object (domainAuthenticationSet)

Responses

Request samples

Content type
application/json
{
  • "is_h323_enabled": true,
  • "h235_mode": "H235_UNKNOWN",
  • "gatekeeper_mode": "GTK_UNKNOWN",
  • "use_gatekeeper_as_proxy": true,
  • "e164_number": "1234",
  • "h323_name": "Ivanov",
  • "gatekeeper_address": "1.2.3.4",
  • "auth": {
    }
}

Response samples

Content type
application/json
{ }

Get H323 Registration Status

Получение статуса регистрации на гейткипере

Responses

Response samples

Content type
application/json
{
  • "status": {
    }
}

Get Call MCU Settings

Получение настроек режима MCU

Responses

Response samples

Content type
application/json
{
  • "allow_multiple_calls": true,
  • "allow_incoming_presentations": true,
  • "show_loudness_indicators": true,
  • "mixing_mode": "VM_UNKNOWN"
}

Set Call MCU Settings

Изменение настроек режима MCU

Request Body schema: application/json
required
allow_multiple_calls
required
boolean

Флаг разрешающий принимать несколько звонков сразу (режим MCU)

allow_incoming_presentations
required
boolean

Флаг разрешающий принимать входящую презентацию

show_loudness_indicators
required
boolean

Флаг показа уровня громкости

mixing_mode
required
string (- VM_VIDEO_LESSON: режим "Видеоурок" - VM_ALL_ON_SCREEN: режим "Все на экране" - VM_VOICE_ACTIVATION: режим "Голосовая активность" (VAD))
Default: "VM_UNKNOWN"
Enum: "VM_UNKNOWN" "VM_VIDEO_LESSON" "VM_ALL_ON_SCREEN" "VM_VOICE_ACTIVATION"

Responses

Request samples

Content type
application/json
{
  • "allow_multiple_calls": true,
  • "allow_incoming_presentations": true,
  • "show_loudness_indicators": true,
  • "mixing_mode": "VM_UNKNOWN"
}

Response samples

Content type
application/json
{ }

Get RTP Settings

Получение настроек RTP

Responses

Response samples

Content type
application/json
{
  • "mtu": 1500,
  • "dscp_audio": 0,
  • "dscp_video": 0,
  • "dscp_misc": 0
}

Set RTP Settings

Изменение настроек RTP

Request Body schema: application/json
required
mtu
required
integer <int64>

Максимальный размер одного пакета в байтах, который может быть передан без фрагментации

dscp_audio
required
integer <int64>

Пометка IP-пакетов, пересылающих аудио информацию

dscp_video
required
integer <int64>

Пометка IP-пакетов, пересылающих видео информацию

dscp_misc
required
integer <int64>

Пометка IP-пакетов, пересылающих прочую информацию

Responses

Request samples

Content type
application/json
{
  • "mtu": 1500,
  • "dscp_audio": 0,
  • "dscp_video": 0,
  • "dscp_misc": 0
}

Response samples

Content type
application/json
{ }

Get SIP Settings

Получение настроек SIP

Responses

Response samples

Content type
application/json
{
  • "is_enabled": true,
  • "bfcp_transport": "BFCP_UNKNOWN",
  • "srtp_encoding": "SRTP_UNKNOWN",
  • "is_registration_enabled": true,
  • "sip_transport": "SIP_TRANS_UNKNOWN",
  • "use_server_as_proxy": true,
  • "server_address": "1.2.3.4",
  • "auth": {
    }
}

Set SIP Settings

Изменение настроек SIP

Request Body schema: application/json
required
is_enabled
required
boolean

Флаг того что регистрация на SIP сервере включена

bfcp_transport
required
string (- BFCP_UDP: использовать UDP в качестве транспортного протокола для BFCP - BFCP_TCP: использовать TCP в качестве транспортного протокола для BFCP)
Default: "BFCP_UNKNOWN"
Enum: "BFCP_UNKNOWN" "BFCP_UDP" "BFCP_TCP"
srtp_encoding
required
string (- SRTP_DISABLED: encrypted calls are prohibited - SRTP_ENABLED: both encrypted and unencrypted calls are allowed - SRTP_MANDATORY: unencrypted calls are prohibited)
Default: "SRTP_UNKNOWN"
Enum: "SRTP_UNKNOWN" "SRTP_DISABLED" "SRTP_ENABLED" "SRTP_MANDATORY"
is_registration_enabled
required
boolean

Флаг того что регистрация разрешена

sip_transport
required
string (- SIP_TRANS_UDP: использовать UDP в качестве транспортного протокола для SIP - SIP_TRANS_TCP: использовать TCP в качестве транспортного протокола для SIP - SIP_TRANS_TLS: использовать TLS в качестве транспортного протокола для SIP - SIP_TRANS_DEFAULT: использовать транспортный протокол по умолчанию)
Default: "SIP_TRANS_UNKNOWN"
Enum: "SIP_TRANS_UNKNOWN" "SIP_TRANS_UDP" "SIP_TRANS_TCP" "SIP_TRANS_TLS" "SIP_TRANS_DEFAULT"
use_server_as_proxy
required
boolean

Флаг использования SIP сервера как прокси

server_address
required
string

Адрес SIP сервера

object (domainAuthenticationSet)

Responses

Request samples

Content type
application/json
{
  • "is_enabled": true,
  • "bfcp_transport": "BFCP_UNKNOWN",
  • "srtp_encoding": "SRTP_UNKNOWN",
  • "is_registration_enabled": true,
  • "sip_transport": "SIP_TRANS_UNKNOWN",
  • "use_server_as_proxy": true,
  • "server_address": "1.2.3.4",
  • "auth": {
    }
}

Response samples

Content type
application/json
{ }

Get SIP Registration Status

Получение статуса регистрации на SIP сервере

Responses

Response samples

Content type
application/json
{
  • "status": {
    }
}

Send Text To Conference

Отправка сообщения в конференцию для отображения на экране

Request Body schema: application/json
required
text
required
string

Текст отсылаемый в конференцию для отображения на экране.

Responses

Request samples

Content type
application/json
{
  • "text": "Hello World!"
}

Response samples

Content type
application/json
{ }

Dial Out URI

Звонок на адрес

Request Body schema: application/json
required
uri
required
string

Адрес на который хотим позвонить

display_name
string or null

Отображаемое имя адреса на который хотим позвонить

object (domainContactAddressPayload)

Responses

Request samples

Content type
application/json
{
  • "uri": "sip:host.ru:5060",
  • "display_name": "Peregovorka",
  • "payload": {
    }
}

Response samples

Content type
application/json
{ }

Camera Positions

Get Camera Position

Получение параметров позиции камеры

query Parameters
position_id
required
string

Id позиции камеры.

Responses

Response samples

Content type
application/json
{
  • "camera_position": {
    }
}

Get Camera Positions

Получение списка позиций камер

query Parameters
page
string <int64>

Номер страницы со списком сущностей

page_size
string <int64>

Число записей на странице

sort_order
string <int64>

Порядок сортировки записей

sort_field
string

Поле по которому сортируем записи. Допустимы значения 'created_at' и 'display_name'.

display_name
string

Фильтр по отображаемому имени.

is_active
boolean

Фильтр по флагу активности.

camera_positions
Array of strings

Фильтр по id позиций камеры, которые хотим включить в результат поиска.

exclude_positions
Array of strings

Фильтр по id позиций камеры, которые хотим исключить из результата поиска.

button_ids
Array of strings
Items Enum: "BTN_UNKNOWN" "BTN_0" "BTN_1" "BTN_2" "BTN_3" "BTN_4" "BTN_5" "BTN_6" "BTN_7" "BTN_8" "BTN_9" "BTN_UNBOUND"

Фильтр по id кнопок, которые хотим включить в результат поиска.

  • BTN_0: кнопка "0"
  • BTN_1: кнопка "1"
  • BTN_2: кнопка "2"
  • BTN_3: кнопка "3"
  • BTN_4: кнопка "4"
  • BTN_5: кнопка "5"
  • BTN_6: кнопка "6"
  • BTN_7: кнопка "7"
  • BTN_8: кнопка "8"
  • BTN_9: кнопка "9"
  • BTN_UNBOUND: кнопка не назначена
exclude_button_ids
Array of strings
Items Enum: "BTN_UNKNOWN" "BTN_0" "BTN_1" "BTN_2" "BTN_3" "BTN_4" "BTN_5" "BTN_6" "BTN_7" "BTN_8" "BTN_9" "BTN_UNBOUND"

Фильтр по id кнопок, которые хотим исключить из результата поиска.

  • BTN_0: кнопка "0"
  • BTN_1: кнопка "1"
  • BTN_2: кнопка "2"
  • BTN_3: кнопка "3"
  • BTN_4: кнопка "4"
  • BTN_5: кнопка "5"
  • BTN_6: кнопка "6"
  • BTN_7: кнопка "7"
  • BTN_8: кнопка "8"
  • BTN_9: кнопка "9"
  • BTN_UNBOUND: кнопка не назначена

Responses

Response samples

Content type
application/json
{
  • "camera_positions": [
    ]
}

Delete Camera Position

Удаление позиции камеры

Request Body schema: application/json
required
position_id
required
string

Id позиции камеры.

Responses

Request samples

Content type
application/json
{
  • "position_id": [
    ]
}

Response samples

Content type
application/json
{ }

Create Camera Position

Создание позиции камеры

Request Body schema: application/json
required
display_name
string or null

Отображаемое имя позиции камеры.

button_id
string (- BTN_0: кнопка "0" - BTN_1: кнопка "1" - BTN_2: кнопка "2" - BTN_3: кнопка "3" - BTN_4: кнопка "4" - BTN_5: кнопка "5" - BTN_6: кнопка "6" - BTN_7: кнопка "7" - BTN_8: кнопка "8" - BTN_9: кнопка "9" - BTN_UNBOUND: кнопка не назначена)
Default: "BTN_UNKNOWN"
Enum: "BTN_UNKNOWN" "BTN_0" "BTN_1" "BTN_2" "BTN_3" "BTN_4" "BTN_5" "BTN_6" "BTN_7" "BTN_8" "BTN_9" "BTN_UNBOUND"
take_screenshot
required
boolean

Флаг 'сделать скриншот'.

Responses

Request samples

Content type
application/json
{
  • "display_name": "May Camera Position",
  • "button_id": "BTN_UNKNOWN",
  • "take_screenshot": true
}

Response samples

Content type
application/json
{
  • "position_id": "position-id",
  • "created_at": 12345678
}

Update Camera Position

Изменение позиции камеры

Request Body schema: application/json
required
position_id
required
string

Id позиции камеры.

display_name
string or null

Отображаемое имя позиции камеры.

button_id
string (- BTN_0: кнопка "0" - BTN_1: кнопка "1" - BTN_2: кнопка "2" - BTN_3: кнопка "3" - BTN_4: кнопка "4" - BTN_5: кнопка "5" - BTN_6: кнопка "6" - BTN_7: кнопка "7" - BTN_8: кнопка "8" - BTN_9: кнопка "9" - BTN_UNBOUND: кнопка не назначена)
Default: "BTN_UNKNOWN"
Enum: "BTN_UNKNOWN" "BTN_0" "BTN_1" "BTN_2" "BTN_3" "BTN_4" "BTN_5" "BTN_6" "BTN_7" "BTN_8" "BTN_9" "BTN_UNBOUND"
screenshot_action
required
string (- CPSA_TAKE: сделать скриншот - CPSA_REMOVE: удалить скриншот)
Default: "CPSA_UNKNOWN"
Enum: "CPSA_UNKNOWN" "CPSA_TAKE" "CPSA_REMOVE"

Responses

Request samples

Content type
application/json
{
  • "position_id": [
    ],
  • "display_name": "May Camera Position",
  • "button_id": "BTN_UNKNOWN",
  • "screenshot_action": "CPSA_UNKNOWN"
}

Response samples

Content type
application/json
{ }

Apply Camera Position

Применение позиции камеры

Request Body schema: application/json
required
position_id
required
string

Id позиции камеры.

Responses

Request samples

Content type
application/json
{
  • "position_id": [
    ]
}

Response samples

Content type
application/json
{ }

Configurations

Get Config Call

Получение настроек звонков

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Update Config Call

Изменение настроек звонков

Request Body schema: application/json
required
object (domainConfigCallPayload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{ }

Get Language

Получение настроек языка

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Update Language

Изменение настроек языка

Request Body schema: application/json
required
object (domainLanguagePayload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{ }

Get Pin Config

Получение настроек пин кода

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Update Pin Config

Изменение настроек пин кода

Request Body schema: application/json
required
object (domainPinConfigPayload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{ }

Get Port Range Settings

Получение настроек сетевых портов

Responses

Response samples

Content type
application/json
{
  • "rtp": {
    },
  • "h245": {
    },
  • "bfcp": {
    }
}

Set Port Range Settings

Изменение настроек сетевых портов

Request Body schema: application/json
required
required
object (domainValueRange)
required
object (domainValueRange)
required
object (domainValueRange)

Responses

Request samples

Content type
application/json
{
  • "rtp": {
    },
  • "h245": {
    },
  • "bfcp": {
    }
}

Response samples

Content type
application/json
{ }

Get Config Tablets

Получение настроек планшетов

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Update Config Tablets

Изменение настроек планшетов

Request Body schema: application/json
required
object (domainConfigTabletsPayload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{ }

Get Configuration Files From USB Drive

Получение списка файлов конфигурации на флешке

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Export Configuration File To USB Drive

Экспорт файла конфигурации на флешку

Responses

Response samples

Content type
application/json
{ }

Import Configuration File From USB Drive

Импорт файла конфигурации с флешки

query Parameters
file_name
required
string

Имя файла.

relative_path
required
string

Путь к файлу на флешке.

Responses

Response samples

Content type
application/json
{ }

Reset Configuration

Сброс файла конфигурации до заводских настроек

Responses

Response samples

Content type
application/json
{ }

Get Public Api Config

Получение настроек публичного API

Responses

Response samples

Content type
application/json
{
  • "crt": {
    },
  • "key": {
    },
  • "has_password": true,
  • "port": 443,
  • "enabled": true,
  • "autogenerated": true
}

Switch Public API Config

Изменение настроек публичного API

Request Body schema: application/json
required
enabled
required
boolean <uuid>

Responses

Request samples

Content type
application/json
{
  • "enabled": "77e6ef13-ba8a-473d-9380-f538fa76d7fc"
}

Response samples

Content type
application/json
{ }

Set Public API Port Config

Изменение настроек порта публичного API

Request Body schema: application/json
required
port
required
integer <int32>

Номер порта на котором должно работать публичное API

Responses

Request samples

Content type
application/json
{
  • "port": 1000
}

Response samples

Content type
application/json
{ }

Contacts

Get Contacts

Получение списка контактов

query Parameters
page
string <int64>
page_size
string <int64>
sort_order
string <int64>
sort_field
string
group_id
string <uuid>
exclude_groups
Array of strings <uuid> [ items <uuid > ]
contact_ids
Array of strings <uuid> [ items <uuid > ]
search
string
favored
boolean

Responses

Response samples

Content type
application/json
{
  • "contacts": [
    ]
}

Create Contact

Создание контакта

Request Body schema: application/json
required
display_name
required
string
description
string or null
object (domainContactPayload)

Responses

Request samples

Content type
application/json
{
  • "display_name": "Alice",
  • "description": "My user",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "contact_id": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

Delete contact address

Удаление адреса у контакта

query Parameters
contact_id
required
string <uuid>
address_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{ }

Create contact address

Добавление адреса в контакт

Request Body schema: application/json
required
contact_id
required
string <uuid>
uri
required
string

Собственно адрес

display_name
string or null

Отображаемое имя адреса

object (domainContactAddressPayload)

Responses

Request samples

Content type
application/json
{
  • "contact_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "uri": "sip:user@host.ru:5060",
  • "display_name": "Talking Room",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "address_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc"
}

Update contact address

Изменение адреса у контакта

Request Body schema: application/json
required
contact_id
required
string <uuid>
address_id
required
string <uuid>
uri
string or null

Собственно адрес

display_name
string or null

Отображаемое имя адреса

object (domainContactAddressPayload)

Responses

Request samples

Content type
application/json
{
  • "contact_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "address_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "uri": "sip:user@host.ru:5060",
  • "display_name": "Talking Room",
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "address_id": "string"
}

Get Contact

Получение контакта по id

path Parameters
contact_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Delete Contact

Удаление контакта

path Parameters
contact_id
required
string <uuid>

Responses

Response samples

Content type
application/json
{ }

Update Contact

Изменение контакта

path Parameters
contact_id
required
string <uuid>
Request Body schema: application/json
required
display_name
string or null
description
string or null
object (domainContactPayload)

Responses

Request samples

Content type
application/json
{
  • "display_name": "Alice",
  • "description": "My user",
  • "payload": {
    }
}

Response samples

Content type
application/json
{ }

Controls

Set Camera Control

Установка параметров камеры

Request Body schema: application/json
required
device_id
required
string

Id устройства камеры

control_id
required
integer <int64>

Id параметра камеры

value
required
integer <int32>

Устанавливаемое значение

Responses

Request samples

Content type
application/json
{
  • "device_id": "123",
  • "control_id": "123",
  • "value": "123"
}

Response samples

Content type
application/json
{ }

Set Camera Smart Crop

Установка обрезания изображения камеры

Request Body schema: application/json
required
value
required
boolean

Значение которое хотим установить

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
{ }

Set Camera Mark Face

Установка поиска/пометки лиц на изображении с камеры

Request Body schema: application/json
required
value
required
boolean

Значение которое хотим установить

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
{ }

Set Mute Camera

Мьют камеры

Request Body schema: application/json
required
value
required
boolean

Значение которое хотим установить

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
{
  • "request_id": 1234
}

Start Camera Device

Запуск устройства камеры

Request Body schema: application/json
required
device_id
required
string

Id устройства камеры

Responses

Request samples

Content type
application/json
{
  • "device_id": "123"
}

Response samples

Content type
application/json
{ }

Get Conference Controls

Получение параметров управления конференцией

Responses

Response samples

Content type
application/json
{
  • "layout": "VL_UNSPECIFIED",
  • "selfview": {
    },
  • "camera": {
    },
  • "microphone": {
    },
  • "speaker": {
    }
}

Set Microphone Gain

Установка громкости (усиления) микрофона

Request Body schema: application/json
required
value
required
number <double>

Величина громкости (усиления) микрофона

Responses

Request samples

Content type
application/json
{
  • "value": 123
}

Response samples

Content type
application/json
{ }

Microphone Volume Adjust

Регулировка громкости микрофона

Request Body schema: application/json
required
step
required
string (- SA_UP: увеличение громкости - SA_DOWN: уменьшение громкости)
Default: "SA_UNSPECIFIED"
Enum: "SA_UNSPECIFIED" "SA_UP" "SA_DOWN"

Responses

Request samples

Content type
application/json
{
  • "step": "SA_UNSPECIFIED"
}

Response samples

Content type
application/json
{ }

Set Mute Microphone

Мьют микрофона

Request Body schema: application/json
required
value
required
boolean

Значение которое хотим установить

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
{
  • "request_id": 1234
}

Get Microphone Status

Получение статуса микрофона

Responses

Response samples

Content type
application/json
{
  • "status": {
    }
}

Set Mute Speaker

Мьют динамика

Request Body schema: application/json
required
value
required
boolean

Значение которое хотим установить

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
{
  • "request_id": 1234
}

Start Speaker Device

Запуск устройства динамика

Request Body schema: application/json
required
device_id
required
string

Id устройства динамика

Responses

Request samples

Content type
application/json
{
  • "device_id": "123"
}

Response samples

Content type
application/json
{ }

Get Speaker Status

Получение статуса динамика

Responses

Response samples

Content type
application/json
{
  • "status": {
    }
}

Set Speaker Volume

Установка громкости динамика

Request Body schema: application/json
required
value
required
number <double>

Величина громкости динамика

Responses

Request samples

Content type
application/json
{
  • "value": 123
}

Response samples

Content type
application/json
{ }

Speaker Volume Adjust

Регулировка громкости динамика

Request Body schema: application/json
required
value
required
string (- SA_UP: увеличение громкости - SA_DOWN: уменьшение громкости)
Default: "SA_UNSPECIFIED"
Enum: "SA_UNSPECIFIED" "SA_UP" "SA_DOWN"

Responses

Request samples

Content type
application/json
{
  • "value": "SA_UNSPECIFIED"
}

Response samples

Content type
application/json
{ }

Get Render Resolution Settings

Получение настроек разрешения рендеринга

Responses

Response samples

Content type
application/json
{
  • "type": "RRT_UNKNOWN"
}

Set Render Resolution Settings

Изменение настроек разрешения рендеринга

Request Body schema: application/json
required
type
string (- RRT_AUTO: автоматический выбор разрешения - RRT_1080p: разрешение: 1920x1080 - RRT_4K: разрешение: 4k)
Default: "RRT_UNKNOWN"
Enum: "RRT_UNKNOWN" "RRT_AUTO" "RRT_1080p" "RRT_4K"

Responses

Request samples

Content type
application/json
{
  • "type": "RRT_UNKNOWN"
}

Response samples

Content type
application/json
{ }

Diagnostic

Log browser event

Логирование событий браузера в отдельном файле

query Parameters
string_to_log
required
string

Строка для логирования событий браузера

error_type
required
string
Default: "LSET_UNKNOWN"
Enum: "LSET_UNKNOWN" "LSET_LOG" "LSET_WARN" "LSET_ERROR" "LSET_INFO"

Тип сообщения

  • LSET_LOG: тип сообщения: "Журнал"
  • LSET_WARN: тип сообщения: "Предупреждение"
  • LSET_ERROR: тип сообщения: "Ошибка"
  • LSET_INFO: тип сообщения: "Информация"
client_type
required
string
Default: "LSCT_UNKNOWN"
Enum: "LSCT_UNKNOWN" "LSCT_LOCAL" "LSCT_REMOTE" "LSCT_TABLET"

Тип клиента

  • LSCT_LOCAL: Тип клиента браузера: "Локальный клиент"
  • LSCT_REMOTE: Тип клиента браузера: "Удаленный клиент"
  • LSCT_TABLET: Тип клиента браузера: "Планшет"

Responses

Response samples

Content type
application/json
{ }

Disk

Get Disk Stats Stream

Возвращает потоковую статистику использования дискового пространства

path Parameters
period
required
string <uint64>

Период измерения диска в секундах (от 1 до 60)

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Favored

Remove Favored Contact

Удаляет контакт из списка избранных

Request Body schema: application/json
required
contact_id
required
string

Идентификатор контакта, который необходимо удалить из избранного

Responses

Request samples

Content type
application/json
{
  • "contact_id": "contact-1234"
}

Response samples

Content type
application/json
{ }

Add Favored Contact

Добавляет контакт в список избранных

Request Body schema: application/json
required
contact_id
required
string

Идентификатор контакта, который необходимо добавить в избранное.

Responses

Request samples

Content type
application/json
{
  • "contact_id": "contact-1234"
}

Response samples

Content type
application/json
{ }

Set Favorite Address to Contact

Устанавливает избранный адрес для контакта

Request Body schema: application/json
required
contact_id
required
string

Идентификатор контакта, для которого устанавливается избранный адрес

address_id
required
string

Идентификатор адреса, который будет установлен как избранный

Responses

Request samples

Content type
application/json
{
  • "contact_id": "contact-1234",
  • "address_id": "address-5678"
}

Response samples

Content type
application/json
{ }

FECC

Call FECC Action Stream

Осуществляет потоковую передачу команд FECC для управления функциональностью камеры или устройств в режиме реального времени через web-сокеты.

Request Body schema: application/json
required

(streaming inputs)

connection_id
required
string

Идентификатор соединения для FECC управления

direction
string (- VIDPTZD_PAN_LEFT: поворот налево - VIDPTZD_PAN_RIGHT: поворот направо - VIDPTZD_TILT_UP: поворот вверх - VIDPTZD_TILT_DOWN: поворот вниз - VIDPTZD_ZOOM_IN: увеличение масштаба - VIDPTZD_ZOOM_OUT: уменьшение масштаба - VIDPTZD_STOP: остановка)
Default: "VIDPTZD_UNSPECIFIED"
Enum: "VIDPTZD_UNSPECIFIED" "VIDPTZD_PAN_LEFT" "VIDPTZD_PAN_RIGHT" "VIDPTZD_TILT_UP" "VIDPTZD_TILT_DOWN" "VIDPTZD_ZOOM_IN" "VIDPTZD_ZOOM_OUT" "VIDPTZD_STOP"

Responses

Request samples

Content type
application/json
{
  • "connection_id": "conn-789",
  • "direction": "VIDPTZD_UNSPECIFIED"
}

Response samples

Content type
application/json
{ }

Firmwares

Get Firmware Files From USB Drive

Получение списка файлов прошивки на флешке

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Install Firmware File From USB Drive

Установка файла прошивки с флешки

Request Body schema: application/json
required
file_name
required
string

Имя файла с прошивкой

relative_path
required
string

Путь к файлу с прошивкой

Responses

Request samples

Content type
application/json
{
  • "file_name": "file.firmware",
  • "relative_path": "/path"
}

Response samples

Content type
application/json
{ }

Update Firmware Online

Обновление до последней версии взятой с удаленного репозитория

Request Body schema: application/json
required
object (domainUpdateFirmwareOnlineRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Get Update Remaining Time

Получение оставшегося времени установки/обновления

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get waiting for update status

Получение статуса ожидания действия при обновлении прошивок и файлов конфигурации

Responses

Response samples

Content type
application/json
{
  • "update_firmware": "WUS_UNKNOWN",
  • "update_configurations": "WUS_UNKNOWN"
}

Choose Update Action

Выбор действия для установки

Request Body schema: application/json
required
action
required
string (- CUA_UPDATE: действие: обновить прошивку - CUA_DELAY: действие: ожидание таймера установки - CUA_REJECT: действие: отклонить обновление прошивки)
Default: "CUA_UNKNOWN"
Enum: "CUA_UNKNOWN" "CUA_UPDATE" "CUA_DELAY" "CUA_REJECT"

Responses

Request samples

Content type
application/json
{
  • "action": "CUA_UNKNOWN"
}

Response samples

Content type
application/json
{ }

Get Firmware Last Version

Получение последней версии прошивки на удаленном репозитории

Responses

Response samples

Content type
application/json
{
  • "version": "1.1.4"
}

Groups

Remove Contact From Group

Удаление контакта из группы

Request Body schema: application/json
required
contact_id
required
string <uuid>

Id контакта удаляемого из группы

group_id
required
string <uuid>

Id группы из которой удаляем контакт

Responses

Request samples

Content type
application/json
{
  • "contact_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "group_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc"
}

Response samples

Content type
application/json
{ }

Add Contact To Group

Добавление контакта в группу

Request Body schema: application/json
required
contact_id
required
string <uuid>

Id контакта добавляемого в группу

group_id
required
string <uuid>

Id группы в которую добавляем контакт

Responses

Request samples

Content type
application/json
{
  • "contact_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "group_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc"
}

Response samples

Content type
application/json
{ }

Get Group

Получение информации о группе

query Parameters
group_id
required
string <uuid>

Id группы по которой хотим получить данные

Responses

Response samples

Content type
application/json
{
  • "group": {
    }
}

Get Groups

Получение списка групп

query Parameters
page
string <int64>

Номер страницы

page_size
string <int64>

Число записей на странице

sort_order
string <int64>

Порядок сортировки записей на странице

sort_field
string

Поле по которому сортируем. Допустимые значения - 'created_at', 'display_name'

display_name
string

Фильтр по отображаемому имени группы

contact_id
string <uuid>

Id контакта (в составе группы) по которому хотим получить информацию

exclude_contacts
Array of strings <uuid> [ items <uuid > ]

Id контактов (в составе группы) по которым не хотим получить информацию

Responses

Response samples

Content type
application/json
{
  • "groups": [
    ]
}

Delete Group

Удаление группы

Request Body schema: application/json
required
group_id
required
string <uuid>

Id группы которую удаляем

Responses

Request samples

Content type
application/json
{
  • "group_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc"
}

Response samples

Content type
application/json
{ }

Create Group

Создание группы

Request Body schema: application/json
required
display_name
required
string

Отображаемое имя группы

Responses

Request samples

Content type
application/json
{
  • "display_name": "Department 1"
}

Response samples

Content type
application/json
{
  • "group_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "created_at": 12345678
}

Update Group

Изменение группы

Request Body schema: application/json
required
group_id
required
string <uuid>

Id группы которую редактируем

display_name
string or null

Отображаемое имя группы

Responses

Request samples

Content type
application/json
{
  • "group_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "display_name": "Department 1"
}

Response samples

Content type
application/json
{ }

LDAP

Create LDAP Server

Создает новый LDAP сервер

Request Body schema: application/json
required
name
string or null

Имя LDAP сервера (опционально)

type
required
string

Тип LDAP сервера

sync_interval
required
string (- SI_10MIN: интервал синхронизации с ТКС сервером: 10 минут - SI_30MIN: интервал синхронизации с ТКС сервером: 30 минут - SI_1HOUR: интервал синхронизации с ТКС сервером: 1 час - SI_1DAY: интервал синхронизации с ТКС сервером: 1 день)
Default: "SI_UNKNOWN"
Enum: "SI_UNKNOWN" "SI_10MIN" "SI_30MIN" "SI_1HOUR" "SI_1DAY"
sync_enabled
boolean or null

Флаг включения синхронизации с LDAP сервером

object (domainLdapServerSchemaUser)
object (domainLdapServerSchemaGroup)
required
object (domainLdapServerPayloadCreate)

Responses

Request samples

Content type
application/json
{
  • "name": "Corporate LDAP",
  • "type": "string",
  • "sync_interval": "SI_UNKNOWN",
  • "sync_enabled": true,
  • "schema_user": {
    },
  • "schema_group": {
    },
  • "payload": {
    }
}

Response samples

Content type
application/json
{
  • "server": {
    }
}

Get LDAP Server

Получает информацию об LDAP сервере по его идентификатору

path Parameters
server_id
required
string

Идентификатор LDAP сервера

Responses

Response samples

Content type
application/json
{
  • "server": {
    }
}

Delete LDAP Server

Удаляет LDAP сервер по заданному идентификатору

path Parameters
server_id
required
string

Идентификатор LDAP сервера, который необходимо удалить

Responses

Response samples

Content type
application/json
{ }

Update LDAP Server

Обновляет информацию об LDAP сервере

path Parameters
server_id
required
string

Идентификатор LDAP сервера для обновления

Request Body schema: application/json
required
name
string or null

Новое имя LDAP сервера (если обновляется)

type
string or null

Новый тип LDAP сервера (если обновляется)

sync_interval
string (- SI_10MIN: интервал синхронизации с ТКС сервером: 10 минут - SI_30MIN: интервал синхронизации с ТКС сервером: 30 минут - SI_1HOUR: интервал синхронизации с ТКС сервером: 1 час - SI_1DAY: интервал синхронизации с ТКС сервером: 1 день)
Default: "SI_UNKNOWN"
Enum: "SI_UNKNOWN" "SI_10MIN" "SI_30MIN" "SI_1HOUR" "SI_1DAY"
sync_enabled
boolean or null

Флаг включения синхронизации (если обновляется)

object (domainLdapServerSchemaUser)
object (domainLdapServerSchemaGroup)
object (domainLdapServerPayloadUpdate)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "sync_interval": "SI_UNKNOWN",
  • "sync_enabled": false,
  • "schema_user": {
    },
  • "schema_group": {
    },
  • "payload": {
    }
}

Response samples

Content type
application/json
{ }

Get LDAP Servers

Получает список всех LDAP серверов

query Parameters
page
string <int64>

Номер страницы для пагинации

page_size
string <int64>

Количество LDAP серверов на странице

sort_order
string <int64>

Порядок сортировки (1 для возрастания, -1 для убывания)

sort_field
string

Поле для сортировки

Responses

Response samples

Content type
application/json
{
  • "servers": [
    ]
}

Licenses

Get License Info

Получение параметров лицензии

Responses

Response samples

Content type
application/json
{
  • "serial": "77e6ef13",
  • "max_calls": 4,
  • "max_screens": 4,
  • "recording": true,
  • "encryption": true,
  • "video_limits": {
    },
  • "branding": true,
  • "bitrates": [
    ],
  • "audio_codecs": [
    ],
  • "video_codecs": [
    ],
  • "duration": {
    },
  • "license_type": "LICENSE_UNKNOWN"
}

Export Hardware Config To USB Drive

Экспорт аппаратной конфигурации на флешку

Responses

Response samples

Content type
application/json
{ }

Import License File From USB Drive

Импорт лицензии с флешки

query Parameters
file_name
required
string

Имя файла

relative_path
required
string

Путь к файлу

Responses

Response samples

Content type
application/json
{ }

Export Reg-Offline File To USB Drive

Экспорт файла для оффлайн регистрации на флешку

query Parameters
serial
string

Серийный номер лицензии

Responses

Response samples

Content type
application/json
{ }

Online Registration

Онлайн регистрация (получение лицензии по сети с сервера лицензий)

query Parameters
serial
string

Серийный номер лицензии

Responses

Response samples

Content type
application/json
{ }

Get License Files From USB Drive

Получение списка файлов лицензий на флешке

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Logs

Export Log Files To USB Drive

Экспортирует файлы логов на подключенный USB-накопитель для последующего анализа или архивации

Request Body schema: application/json
required
object (domainExportLogFilesToUsbDriveRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Mail

Create Mail Server

Создает новый почтовый сервер с заданными параметрами

Request Body schema: application/json
required
display_name
string or null

Отображаемое имя сервера (опционально)

protocol_type
required
string (- PRT_POP3: почтовый протокол POP3 - PRT_IMAP: почтовый протокол IMAP)
Default: "PRT_UNKNOWN"
Enum: "PRT_UNKNOWN" "PRT_POP3" "PRT_IMAP"
address
required
string

Адрес почтового сервера

grant_type
required
string (- GRT_PASSWORD: авторизация на почтовом сервере по паролю)
Default: "GRT_UNKNOWN"
Enum: "GRT_UNKNOWN" "GRT_PASSWORD"
client_id
required
string

Идентификатор клиента

client_secret
required
string

Секрет клиента

sync_interval
required
string (- SIE_1MIN: интервал синхронизации с почтовым сервером: 1 минута - SIE_10MIN: интервал синхронизации с почтовым сервером: 10 минут - SIE_30MIN: интервал синхронизации с почтовым сервером: 30 минут - SIE_1HOUR: интервал синхронизации с почтовым сервером: 1 час - SIE_1DAY: интервал синхронизации с почтовым сервером: 1 день)
Default: "SIE_UNKNOWN"
Enum: "SIE_UNKNOWN" "SIE_1MIN" "SIE_10MIN" "SIE_30MIN" "SIE_1HOUR" "SIE_1DAY"
sync_enabled
boolean

Флаг, указывающий, включена ли синхронизация

Responses

Request samples

Content type
application/json
{
  • "display_name": "Mail Server 1",
  • "protocol_type": "PRT_UNKNOWN",
  • "address": "smtp.example.com",
  • "grant_type": "GRT_UNKNOWN",
  • "client_id": "client-id-123",
  • "client_secret": "secret-key-abc",
  • "sync_interval": "SIE_UNKNOWN",
  • "sync_enabled": true
}

Response samples

Content type
application/json
{
  • "server_id": "server-001",
  • "created_at": "2019-08-24T14:15:22Z"
}

Get Mail Server

Получает информацию о почтовом сервере по идентификатору

path Parameters
server_id
required
string

Идентификатор почтового сервера

Responses

Response samples

Content type
application/json
{
  • "server": {
    }
}

Delete Mail Server

Удаляет почтовый сервер по заданному идентификатору

path Parameters
server_id
required
string

Идентификатор сервера, который необходимо удалить

Responses

Response samples

Content type
application/json
{ }

Update Mail Server

Обновляет параметры существующего почтового сервера

path Parameters
server_id
required
string

Идентификатор сервера для обновления

Request Body schema: application/json
required
protocol_type
string (- PRT_POP3: почтовый протокол POP3 - PRT_IMAP: почтовый протокол IMAP)
Default: "PRT_UNKNOWN"
Enum: "PRT_UNKNOWN" "PRT_POP3" "PRT_IMAP"
address
string or null

Новый адрес сервера (если обновляется)

display_name
string or null

Новое отображаемое имя (если обновляется)

grant_type
string (- GRT_PASSWORD: авторизация на почтовом сервере по паролю)
Default: "GRT_UNKNOWN"
Enum: "GRT_UNKNOWN" "GRT_PASSWORD"
sync_interval
string (- SIE_1MIN: интервал синхронизации с почтовым сервером: 1 минута - SIE_10MIN: интервал синхронизации с почтовым сервером: 10 минут - SIE_30MIN: интервал синхронизации с почтовым сервером: 30 минут - SIE_1HOUR: интервал синхронизации с почтовым сервером: 1 час - SIE_1DAY: интервал синхронизации с почтовым сервером: 1 день)
Default: "SIE_UNKNOWN"
Enum: "SIE_UNKNOWN" "SIE_1MIN" "SIE_10MIN" "SIE_30MIN" "SIE_1HOUR" "SIE_1DAY"
sync_enabled
boolean or null

Флаг включения синхронизации (если обновляется)

client_id
string or null

Новый идентификатор клиента (если обновляется)

client_secret
string or null

Новый секрет клиента (если обновляется)

Responses

Request samples

Content type
application/json
{
  • "protocol_type": "PRT_UNKNOWN",
  • "address": "string",
  • "display_name": "string",
  • "grant_type": "GRT_UNKNOWN",
  • "sync_interval": "SIE_UNKNOWN",
  • "sync_enabled": false,
  • "client_id": "string",
  • "client_secret": "string"
}

Response samples

Content type
application/json
{ }

Get Mail Servers

Получает список всех почтовых серверов

query Parameters
page
string <int64>

Номер страницы для пагинации

page_size
string <int64>

Количество серверов на странице

sort_order
string <int64>

Порядок сортировки (1 - по возрастанию, -1 - по убыванию)

sort_field
string

Поле для сортировки

protocol_types
Array of strings
Items Enum: "PRT_UNKNOWN" "PRT_POP3" "PRT_IMAP"

Список типов протоколов для фильтрации

  • PRT_POP3: почтовый протокол POP3
  • PRT_IMAP: почтовый протокол IMAP
address
string

Фильтр по адресу сервера

display_name
string

Фильтр по отображаемому имени сервера

search
string

Строка поиска

include_server_ids
Array of strings

Список идентификаторов серверов для включения

exclude_server_ids
Array of strings

Список идентификаторов серверов для исключения

Responses

Response samples

Content type
application/json
{
  • "servers": [
    ]
}

Manager

Echo

Эхо метод сервера

Responses

Response samples

Content type
application/json
{ }

MCU

Create MCU Server

Создает новый MCU сервер с указанными параметрами

Request Body schema: application/json
required
display_name
string or null

Отображаемое имя MCU сервера (опционально)

address
required
string

Сетевой адрес MCU сервера

client_id
required
string

Идентификатор клиента для подключения к MCU серверу

client_secret
required
string

Секрет клиента для аутентификации

sync_enabled
boolean

Флаг включения синхронизации с MCU сервером

Responses

Request samples

Content type
application/json
{
  • "display_name": "New MCU Server",
  • "address": "192.168.1.101:8080",
  • "client_id": "mcu-client-002",
  • "client_secret": "secret-mcu-xyz",
  • "sync_enabled": true
}

Response samples

Content type
application/json
{
  • "server": {
    }
}

Get MCU Server

Получает информацию о MCU сервере по идентификатору

path Parameters
node_id
required
string

Уникальный идентификатор MCU сервера

Responses

Response samples

Content type
application/json
{
  • "server": {
    }
}

Delete MCU Server

Удаляет MCU сервер по заданному идентификатору

path Parameters
node_id
required
string

Идентификатор MCU сервера для удаления

Responses

Response samples

Content type
application/json
{ }

Update MCU Server

Обновляет информацию о существующем MCU сервере

path Parameters
node_id
required
string

Идентификатор MCU сервера для обновления

Request Body schema: application/json
required
display_name
string or null

Новое отображаемое имя (если обновляется)

address
string or null

Новый адрес MCU сервера (если обновляется)

client_id
string or null

Новый идентификатор клиента (если обновляется)

client_secret
string or null

Новый секрет клиента (если обновляется)

sync_enabled
boolean or null

Флаг включения синхронизации (если обновляется)

Responses

Request samples

Content type
application/json
{
  • "display_name": "string",
  • "address": "string",
  • "client_id": "string",
  • "client_secret": "string",
  • "sync_enabled": false
}

Response samples

Content type
application/json
{ }

Get MCU Servers

Получает список всех MCU серверов

query Parameters
page
string <int64>

Номер страницы для пагинации

page_size
string <int64>

Количество серверов на странице

sort_order
string <int64>

Порядок сортировки (1 для возрастания, -1 для убывания)

sort_field
string

Поле, по которому производится сортировка

Responses

Response samples

Content type
application/json
{
  • "servers": [
    ]
}

Memory

Get Memory Stats Stream

Возвращает потоковую статистику использования оперативной памяти

path Parameters
period
required
string <uint64>

Период измерения памяти в секундах (от 1 до 60)

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

NAT

Get H323 NAT Settings

Получение настроек NAT для H323 протокола

Responses

Response samples

Content type
application/json
{
  • "h460_18_signalling": true,
  • "h460_19_media": true
}

Set H323 NAT Settings

Изменение настроек NAT для H323 протокола

Request Body schema: application/json
required
h460_18_signalling
required
boolean

Флаг пропуска сигнализации H.323 трансляторами адресов NAT и межсетевыми экранами.

h460_19_media
required
boolean

Флаг пропуска мультимедийных потоков H.323 преобразователями адресов NAT и межсетевыми экранами.

Responses

Request samples

Content type
application/json
{
  • "h460_18_signalling": true,
  • "h460_19_media": true
}

Response samples

Content type
application/json
{ }

Get Public IP

Получение внешнего IP адреса

Responses

Response samples

Content type
application/json
{
  • "public_ip": "1.2.3.4"
}

Set Public IP

Изменение внешнего IP адреса

Request Body schema: application/json
required
public_ip
required
string

Публичный IP адрес терминала

Responses

Request samples

Content type
application/json
{
  • "public_ip": "1.2.3.4"
}

Response samples

Content type
application/json
{ }

Get SIP NAT Settings

Получение настроек NAT для SIP протокола

Responses

Response samples

Content type
application/json
{
  • "use_ice": true,
  • "use_turn": true
}

Set SIP NAT Settings

Изменение настроек NAT для SIP протокола

Request Body schema: application/json
required
use_ice
required
boolean

Флаг использования протокола ICE.

use_turn
required
boolean

Флаг использования протокола TURN.

Responses

Request samples

Content type
application/json
{
  • "use_ice": true,
  • "use_turn": true
}

Response samples

Content type
application/json
{ }

Get Turn Server Settings

Получение настроек TURN сервера

Responses

Response samples

Content type
application/json
{
  • "is_enabled": true,
  • "server_address": "1.2.3.4",
  • "auth": {
    }
}

Set Turn Server Settings

Изменение настроек TURN сервера

Request Body schema: application/json
required
is_enabled
required
boolean

Флаг того что используется TURN сервер.

server_address
required
string

Адрес TURN сервера.

required
object (domainAuthenticationSet)

Responses

Request samples

Content type
application/json
{
  • "is_enabled": true,
  • "server_address": "1.2.3.4",
  • "auth": {
    }
}

Response samples

Content type
application/json
{ }

Network Interfaces

Get Network Interface

Получение настроек выбранного сетевого интерфейса

query Parameters
id
required
string

Идентификатор интерфейса параметры которого хотим получить

Responses

Response samples

Content type
application/json
{
  • "iface": {
    }
}

Get Network Interfaces

Получение настроек всех сетевых интерфейсов

Responses

Response samples

Content type
application/json
{
  • "interfaces": [
    ]
}

Update IEEE 8021q Settings

Изменение настроек IEEE 802.1Q (стандарт, который описывает процедуру тегирования трафика для передачи информации о принадлежности к VLAN)

Request Body schema: application/json
required
id
required
string

Идентификатор интерфейса параметры которого хотим изменить

required
object (domainNetworkInterfaceIeee8021qConfig)

Responses

Request samples

Content type
application/json
{
  • "id": "eth0",
  • "config": {
    }
}

Response samples

Content type
application/json
{ }

Update IEEE 8021x Settings

Изменение настроек IEEE 802.1X (протокол контроля доступа и аутентификации)

Request Body schema: application/json
required
id
required
string

Идентификатор интерфейса параметры которого хотим изменить

required
object (domainNetworkInterfaceIeee8021xConfigSet)

Responses

Request samples

Content type
application/json
{
  • "id": "eth0",
  • "config": {
    }
}

Response samples

Content type
application/json
{ }

Update TCP IPv4

Изменение настроек ipv4 выбранного сетевого интерфейса

Request Body schema: application/json
required
id
required
string

Идентификатор интерфейса параметры которого хотим изменить

required
object (domainNetworkInterfaceIPv4Config)

Responses

Request samples

Content type
application/json
{
  • "id": "eth0",
  • "config": {
    }
}

Response samples

Content type
application/json
{ }

Update TCP IPv6

Изменение настроек ipv6 выбранного сетевого интерфейса

Request Body schema: application/json
required
id
required
string

Идентификатор интерфейса параметры которого хотим изменить

object (domainNetworkInterfaceIPv6Config)

Responses

Request samples

Content type
application/json
{
  • "id": "eth0",
  • "config": {
    }
}

Response samples

Content type
application/json
{ }

Update Phys Settings

Изменение физических настроек выбранного сетевого интерфейса

Request Body schema: application/json
required
id
required
string

Идентификатор интерфейса параметры которого хотим изменить

required
object (domainNetworkInterfacePhysConfig)

Responses

Request samples

Content type
application/json
{
  • "id": "eth0",
  • "config": {
    }
}

Response samples

Content type
application/json
{ }

Network Utils

Ping

Пинги указанного адреса по ICMP/SIP/H323 протоколам

query Parameters
host
required
string

Адрес который хотим пропинговать

Responses

Response samples

Content type
application/json
{
  • "ip": {
    },
  • "sip": {
    },
  • "h323": {
    },
  • "avg_ping_time": 12345678,
  • "start_time": 12345678
}

Get Tcpdump Files

Получение списка записей сетевого трафика

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Stop Tcpdump

Останов записи сетевого трафика

Responses

Response samples

Content type
application/json
{ }

Start Tcpdump

Старт записи сетевого трафика

Responses

Response samples

Content type
application/json
{ }

Remove Tcpdump Files

Удаление файла с записью сетевого трафика

query Parameters
file_name
required
string

Файл с сетевым трафиком который хотим удалить

Responses

Response samples

Content type
application/json
{ }

Get Tcpdump Status

Получение статуса записи сетевого трафика

Responses

Response samples

Content type
application/json
{
  • "enabled": true
}

Traceroute

Получение трассировки указанного адреса

query Parameters
address
required
string

Адрес к которому хотим проложить маршрут утилитой traceroute

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Power

Get Sleep Settings

Получение настроек сна.

Responses

Response samples

Content type
application/json
{
  • "disable_displays": true,
  • "sleep_timeout": 60,
  • "screensaver_timeout": 60
}

Set Sleep Settings

Изменение настроек сна.

Request Body schema: application/json
required
disable_displays
required
boolean

Флаг выключения дисплея

sleep_timeout
required
integer <int64>

Время через которое терминал 'засыпает' (в секундах).

screensaver_timeout
required
integer <int64>

Время через которое включается хранитель экрана (в секундах).

Responses

Request samples

Content type
application/json
{
  • "disable_displays": true,
  • "sleep_timeout": 60,
  • "screensaver_timeout": 60
}

Response samples

Content type
application/json
{ }

Reboot Server

Перезагрузка ОС терминала (аппаратная).

Responses

Response samples

Content type
application/json
{ }

Restart Services

Перезагрузка сервисов терминала.

Responses

Response samples

Content type
application/json
{ }

Shutdown Server

Выключение терминала.

Responses

Response samples

Content type
application/json
{ }

Set Sleep Mode

Включение режима сна.

Request Body schema: application/json
required
value
required
boolean

Флаг включения режима сна.

Responses

Request samples

Content type
application/json
{
  • "value": true
}

Response samples

Content type
application/json
{ }

Prevent Sleep Mode

Предотвращение включения режима сна.

Responses

Response samples

Content type
application/json
{
  • "result": { }
}

Presentation

Add Presentation To Call

Добавляет презентацию к активному звонку

Request Body schema: application/json
required
object (domainAddPresentationToCallRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Remove Presentation From Call

Удаляет презентацию из активного звонка

Responses

Response samples

Content type
application/json
{ }

Get Presentation Controls

Получает элементы управления презентацией для указанной сессии

Responses

Response samples

Content type
application/json
{
  • "preview": true,
  • "outgoing": true,
  • "incoming": false,
  • "on_screen": true,
  • "connected": true,
  • "device_id": "device-123",
  • "connection_id": "conn-456"
}

Start Presentation Device

Запускает устройство презентации для отображения содержимого

Request Body schema: application/json
required
device_id
required
string

Идентификатор презентационного устройства

Responses

Request samples

Content type
application/json
{
  • "device_id": "device-789"
}

Response samples

Content type
application/json
{ }

Create Presentation Directory

Создает директорию для хранения файлов презентаций

Request Body schema: application/json
required
dir_name
required
string

Имя создаваемой директории

relative_path
string

Относительный путь, где будет создана директория

Responses

Request samples

Content type
application/json
{
  • "dir_name": "NewDirectory",
  • "relative_path": "/presentations/"
}

Response samples

Content type
application/json
{ }

Remove Presentation Directory

Удаляет директорию презентаций по заданному идентификатору

path Parameters
dir_name
required
string

Имя директории для удаления

Request Body schema: application/json
required
relative_path
string

Относительный путь к директории

Responses

Request samples

Content type
application/json
{
  • "relative_path": "/presentations/"
}

Response samples

Content type
application/json
{ }

Start Presentation File

Запускает показ выбранного файла презентации

Request Body schema: application/json
required
file_name
required
string

Имя файла презентации для запуска

relative_path
string

Относительный путь к файлу презентации

Responses

Request samples

Content type
application/json
{
  • "file_name": "presentation1.pptx",
  • "relative_path": "/presentations/"
}

Response samples

Content type
application/json
{ }

Remove Presentation File

Удаляет указанный файл презентации

path Parameters
file_name
required
string

Имя файла для удаления

Request Body schema: application/json
required
relative_path
string

Относительный путь к файлу

Responses

Request samples

Content type
application/json
{
  • "relative_path": "/presentations/"
}

Response samples

Content type
application/json
{ }

Get Presentation Files

Получает список файлов презентаций, доступных для текущего пользователя

Responses

Response samples

Content type
application/json
{
  • "Presentations": [
    ]
}

Remove Presentation Files

Удаляет несколько файлов презентаций, указанных в запросе

Request Body schema: application/json
required
object (domainRemovePresentationFilesRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Copy Presentation From Mount Device

Копирует файл презентации с монтированного устройства на сервер

Request Body schema: application/json
required
from_file_name
required
string

Имя исходного файла для копирования

from_relative_path
string

Относительный путь исходного файла

to_relative_path
string

Относительный путь для копирования файла

Responses

Request samples

Content type
application/json
{
  • "from_file_name": "presentation1.pptx",
  • "from_relative_path": "/mount/presentations/",
  • "to_relative_path": "/presentations/"
}

Response samples

Content type
application/json
{ }

Get Mounted Presentation Files

Получает список файлов презентаций, смонтированных с внешнего устройства

Responses

Response samples

Content type
application/json
{
  • "presentations": [
    ]
}

Start Mounted Presentation File

Запускает презентационный файл, смонтированный с внешнего устройства

Request Body schema: application/json
required
file_name
required
string

Имя файла презентации для запуска с монтированного устройства

relative_path
string

Относительный путь к файлу презентации

Responses

Request samples

Content type
application/json
{
  • "file_name": "presentation2.pptx",
  • "relative_path": "/mount/presentations/"
}

Response samples

Content type
application/json
{ }

Stop Presentation

Останавливает текущую презентацию

Request Body schema: application/json
required
object (domainStopPresentationRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Previews

StartVideoPreviewFile

Запуск генерации превью в движке

Request Body schema: application/json
required
content_type
required
string (- VC_CONTENT_OFF: нет контента - VC_CONNECTION: участник - VC_SELFVIEW: своя камера - VC_PRESENTATION: презентация - VC_PRIMARY_DISPLAY: основной дисплей - VC_CONFERENCE: раскладка конференции - VC_AUTO: автовыбор)
Default: "VC_UNKNOWN"
Enum: "VC_UNKNOWN" "VC_CONTENT_OFF" "VC_CONNECTION" "VC_SELFVIEW" "VC_PRESENTATION" "VC_PRIMARY_DISPLAY" "VC_CONFERENCE" "VC_AUTO"
connection_id
string or null

Id соединения, превью которого хотим получить (нужен если получаем превью конкретного звонка)

Responses

Request samples

Content type
application/json
{
  • "content_type": "VC_UNKNOWN",
  • "connection_id": "12345678"
}

Response samples

Content type
application/json
{ }

Provider Contacts

Get Provider Contact

Получение контакта провайдера

query Parameters
contact_id
required
string <uuid>

Id контакта провайдера

Responses

Response samples

Content type
application/json
{
  • "contact": {
    }
}

Get Provider Contacts

Получение списка контактов провайдера

query Parameters
page
string <int64>

Номер страницы

page_size
string <int64>

Число записей на странице

sort_order
string <int64>

Порядок сортировки записей на странице

sort_field
string

Поле по которому сортируем. Допустимые значения - 'display_name'.

provider_id
string <uuid>

Id провайдера по контактам которого хотим получить информацию

provider_type
string
Default: "PT_UNKNOWN"
Enum: "PT_UNKNOWN" "PT_MCU" "PT_TCS" "PT_MAIL" "PT_MDNS" "PT_LDAP" "PT_NDI"

Тип провайдера по контактам которого хотим получить информацию

  • PT_MCU: тип провайдера: MCU сервер
  • PT_TCS: тип провайдера: ТКС сервер
  • PT_MAIL: тип провайдера: Почтовый сервер
  • PT_MDNS: тип провайдера: MDNS
  • PT_LDAP: тип провайдера: LDAP сервер
  • PT_NDI: тип провайдера: NDI
display_name
string

Фильтр по отображаемому имени контакта

search
string

Фильтр по отображаемому имени и адресам контакта

group_id
string <uuid>

Фильтр по id группы по контактам которой хотим получить информацию

exclude_groups
Array of strings <uuid> [ items <uuid > ]

Список id групп по контактам которых не хотим получить информацию

Responses

Response samples

Content type
application/json
{
  • "contacts": [
    ]
}

Sync Provider Contacts

Синхронизация контактов провайдера

Request Body schema: application/json
required
provider_id
required
string <uuid>

Id провайдера данные которого хотим синхронизировать

provider_type
required
string (- PT_MCU: тип провайдера: MCU сервер - PT_TCS: тип провайдера: ТКС сервер - PT_MAIL: тип провайдера: Почтовый сервер - PT_MDNS: тип провайдера: MDNS - PT_LDAP: тип провайдера: LDAP сервер - PT_NDI: тип провайдера: NDI)
Default: "PT_UNKNOWN"
Enum: "PT_UNKNOWN" "PT_MCU" "PT_TCS" "PT_MAIL" "PT_MDNS" "PT_LDAP" "PT_NDI"

Responses

Request samples

Content type
application/json
{
  • "provider_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "provider_type": "PT_UNKNOWN"
}

Response samples

Content type
application/json
{ }

Provider Groups

Get Provider Group

Получение указанной группы провайдера

query Parameters
group_id
required
string <uuid>

Id группы провайдера

Responses

Response samples

Content type
application/json
{
  • "group": {
    }
}

Get Provider Groups

Получение списка групп провайдера

query Parameters
page
string <int64>

Номер страницы

page_size
string <int64>

Число записей на странице

sort_order
string <int64>

Порядок сортировки записей на странице

sort_field
string

Поле по которому сортируем. Допустимые значения - 'display_name'.

provider_id
string <uuid>

Id провайдера по группам которого хотим получить информацию

provider_type
string
Default: "PT_UNKNOWN"
Enum: "PT_UNKNOWN" "PT_MCU" "PT_TCS" "PT_MAIL" "PT_MDNS" "PT_LDAP" "PT_NDI"

Фильтр по типу провайдера

  • PT_MCU: тип провайдера: MCU сервер
  • PT_TCS: тип провайдера: ТКС сервер
  • PT_MAIL: тип провайдера: Почтовый сервер
  • PT_MDNS: тип провайдера: MDNS
  • PT_LDAP: тип провайдера: LDAP сервер
  • PT_NDI: тип провайдера: NDI
display_name
string

Фильтр по отображаемому имени группы

contact_id
string <uuid>

Фильтр по id контакта провайдера

exclude_contacts
Array of strings <uuid> [ items <uuid > ]

Id контактов по которым не хотим получать информацию

Responses

Response samples

Content type
application/json
{
  • "groups": [
    ]
}

Providers

Get Providers

Получение списка провайдеров

query Parameters
page
string <int64>

Номер страницы

page_size
string <int64>

Число записей на странице

sort_order
string <int64>

Порядок сортировки записей на странице

sort_field
string

Поле по которому сортируем. Допустимые значения - 'provider_type'.

provider_ids
Array of strings <uuid> [ items <uuid > ]

Id провайдеров по которым хотим получить информацию

provider_types
Array of strings
Items Enum: "PT_UNKNOWN" "PT_MCU" "PT_TCS" "PT_MAIL" "PT_MDNS" "PT_LDAP" "PT_NDI"

Типы провайдеров по которым хотим получить информацию

  • PT_MCU: тип провайдера: MCU сервер
  • PT_TCS: тип провайдера: ТКС сервер
  • PT_MAIL: тип провайдера: Почтовый сервер
  • PT_MDNS: тип провайдера: MDNS
  • PT_LDAP: тип провайдера: LDAP сервер
  • PT_NDI: тип провайдера: NDI
entities
Array of strings
Items Enum: "PE_UNKNOWN" "PE_CONTACTS" "PE_CONFERENCES"

Сущности провайдеров по которым хотим получить информацию

  • PE_CONTACTS: тип сущностей поставляемых провайдером: контакты
  • PE_CONFERENCES: тип сущностей поставляемых провайдером: конференции
sync_enabled
boolean

Фильтр по полю синхронизации провайдера

Responses

Response samples

Content type
application/json
{
  • "providers": [
    ]
}

PTZ

Get Video Input Device PTZ Coordinates

Получает текущие координаты (панорамирование, наклон, зум) видео входного устройства по его идентификатору

path Parameters
id
required
string

Идентификатор видео входного устройства

Responses

Response samples

Content type
application/json
{
  • "pan": {
    },
  • "tilt": {
    },
  • "zoom": {
    }
}

Set Video Input Device PTZ Coordinates

Устанавливает новые координаты PTZ для видео входного устройства по заданному идентификатору

path Parameters
id
required
string

Идентификатор видео устройства

Request Body schema: application/json
required
pan
number or null <double>

Новое значение панорамирования

tilt
number or null <double>

Новое значение наклона

zoom
number or null <double>

Новое значение зума

Responses

Request samples

Content type
application/json
{
  • "pan": 100,
  • "tilt": 10,
  • "zoom": 2
}

Response samples

Content type
application/json
{ }

Video Input Device PTZ Stream

Стрим управления PTZ для видео входного устройства. Метод реализован через web-сокеты для получения обновлений в реальном времени.

Request Body schema: application/json
required

(streaming inputs)

id
required
string

Идентификатор видео устройства для управления PTZ

direction
string (- VIDPTZD_PAN_LEFT: поворот налево - VIDPTZD_PAN_RIGHT: поворот направо - VIDPTZD_TILT_UP: поворот вверх - VIDPTZD_TILT_DOWN: поворот вниз - VIDPTZD_ZOOM_IN: увеличение масштаба - VIDPTZD_ZOOM_OUT: уменьшение масштаба - VIDPTZD_STOP: остановка)
Default: "VIDPTZD_UNSPECIFIED"
Enum: "VIDPTZD_UNSPECIFIED" "VIDPTZD_PAN_LEFT" "VIDPTZD_PAN_RIGHT" "VIDPTZD_TILT_UP" "VIDPTZD_TILT_DOWN" "VIDPTZD_ZOOM_IN" "VIDPTZD_ZOOM_OUT" "VIDPTZD_STOP"

Responses

Request samples

Content type
application/json
{
  • "id": "device-123",
  • "direction": "VIDPTZD_UNSPECIFIED"
}

Response samples

Content type
application/json
{ }

Recording Controls

Get Recording Controls

Получение параметров управления записью

Responses

Response samples

Content type
application/json
{
  • "file": true,
  • "rtmp": true,
  • "ndi": true,
  • "sap": true,
  • "total": 1234,
  • "available": 1234,
  • "time_left": 1234,
  • "max_bitrate": 1234
}

Set File Recording

Изменение параметров управления записью в локальный файл

Request Body schema: application/json
required
is_recording
required
boolean

Флаг включения записи в локальный файл

Responses

Request samples

Content type
application/json
{
  • "is_recording": true
}

Response samples

Content type
application/json
{ }

Set NDI Recording

Изменение параметров управления ndi трансляцией

Request Body schema: application/json
required
is_recording
required
boolean

Флаг включения ndi-трансляции

Responses

Request samples

Content type
application/json
{
  • "is_recording": true
}

Response samples

Content type
application/json
{ }

Set RTMP Recording

Изменение параметров управления rtmp трансляцией

Request Body schema: application/json
required
is_recording
required
boolean

Флаг включения rtmp-трансляции

Responses

Request samples

Content type
application/json
{
  • "is_recording": true
}

Response samples

Content type
application/json
{ }

Set SAP Recording

Изменение параметров управления sap трансляцией

Request Body schema: application/json
required
is_recording
required
boolean

Флаг включения sap-трансляции

Responses

Request samples

Content type
application/json
{
  • "is_recording": true
}

Response samples

Content type
application/json
{ }

Recordings

Remove Video Recording File

Удаление выбранного файла видеозаписи

Request Body schema: application/json
required
file_name
required
string

Имя файла

Responses

Request samples

Content type
application/json
{
  • "file_name": "file.mp4"
}

Response samples

Content type
application/json
{ }

Video Recording File Info

Получение информации о файле записи конференции с заданным интервалом времени. Min = 150 мс.

query Parameters
file_name
required
string

Имя файла видеозаписи

refresh_period
integer <int64>

Период получения данных о файле видеозаписи конференции (в миллисекундах). Min (Default) = 200 мс. Max = 60000 мс

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get Video Recording Files

Получение списка файлов видеозаписей

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Remove Video Recording Files

Удаление всех файлов видеозаписей

Responses

Response samples

Content type
application/json
{ }

Export Video Recording File To Usb Drive

Экспорт файла видеозаписи на флешку

Request Body schema: application/json
required
file_name
required
string

Имя файла

Responses

Request samples

Content type
application/json
{
  • "file_name": "file.mp4"
}

Response samples

Content type
application/json
{ }

Get Video Recording Hls Files

Получение списка файлов записи конференции

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Get Video Recording Hls File

Получение информации о файле записи конференции

path Parameters
file_name
required
string

Имя файла видеозаписи

Responses

Response samples

Content type
application/json
{
  • "file": {
    }
}

Recordings Settings

Get File Recordings Settings

Получение настроек видеозаписи в локальный файл

Responses

Response samples

Content type
application/json
{
  • "auto_start": true,
  • "auto_stop": true,
  • "cyclic_recording": true,
  • "space_saving": true
}

Set File Recordings Settings

Изменение настроек видеозаписи в локальный файл

Request Body schema: application/json
required
auto_start
required
boolean

Флаг автоматического включения видеозаписи

auto_stop
required
boolean

Флаг автоматической остановки видеозаписи

cyclic_recording
required
boolean

Флаг циклической видеозаписи

space_saving
required
boolean

Флаг сохранения пространства на диске

Responses

Request samples

Content type
application/json
{
  • "auto_start": true,
  • "auto_stop": true,
  • "cyclic_recording": true,
  • "space_saving": true
}

Response samples

Content type
application/json
{ }

Get Video Layout Recordings Settings

Получение настроек раскладки видеозаписи

Responses

Response samples

Content type
application/json
{
  • "layout_mode": "RVLM_UNKNOWN",
  • "presentation_mode": "PRM_UNKWNOWN",
  • "frame_size": "FS_UNKNOWN",
  • "bitrate_kbps": 1024
}

Set Video Layout Recordings Settings

Изменение настроек раскладки видеозаписи

Request Body schema: application/json
required
layout_mode
required
string (- RVLM_INCOMING_VIDEO: режим раскладки: "входящее видео" - RVLM_OUTGOING_VIDEO: режим раскладки: "исходящее видео" - RVLM_ALL_ON_SCREEN: режим раскладки: "все на экране")
Default: "RVLM_UNKNOWN"
Enum: "RVLM_UNKNOWN" "RVLM_INCOMING_VIDEO" "RVLM_OUTGOING_VIDEO" "RVLM_ALL_ON_SCREEN"
presentation_mode
required
string (- PRM_DISABLED: режим презентации выключен - PRM_SELECTED: презентация в выделенном окне - PRM_EXCLUSIVE: презентация на весь экран)
Default: "PRM_UNKWNOWN"
Enum: "PRM_UNKWNOWN" "PRM_DISABLED" "PRM_SELECTED" "PRM_EXCLUSIVE"
frame_size
required
string (- FS_240: разрешение: 240p (426 x 240) - FS_360: разрешение: 360p (640 x 360) - FS_480: разрешение: 480p (854 x 480) - FS_720: разрешение: 720p (1280 x 720) - FS_1080: разрешение: 1080p (1920 x 1080))
Default: "FS_UNKNOWN"
Enum: "FS_UNKNOWN" "FS_240" "FS_360" "FS_480" "FS_720" "FS_1080"
bitrate_kbps
integer or null <int64>

Битрейт (килобит в секунду)

Responses

Request samples

Content type
application/json
{
  • "layout_mode": "RVLM_UNKNOWN",
  • "presentation_mode": "PRM_UNKWNOWN",
  • "frame_size": "FS_UNKNOWN",
  • "bitrate_kbps": 1024
}

Response samples

Content type
application/json
{ }

Get NDI Recordings Settings

Получение настроек ndi трансляции

Responses

Response samples

Content type
application/json
{
  • "auto_start": true,
  • "auto_stop": true,
  • "display_name": "My NDI recording"
}

Set NDI Recordings Settings

Изменение настроек ndi трансляции

Request Body schema: application/json
required
auto_start
required
boolean

Флаг автоматического включения трансляции

auto_stop
required
boolean

Флаг автоматической остановки трансляции

display_name
required
string

Отображаемое имя

Responses

Request samples

Content type
application/json
{
  • "auto_start": true,
  • "auto_stop": true,
  • "display_name": "My NDI recording"
}

Response samples

Content type
application/json
{ }

Get RTMP Recordings Settings

Получение настроек rtmp трансляции

Responses

Response samples

Content type
application/json
{
  • "auto_start": true,
  • "auto_stop": true,
  • "server_address": "rtmp:host.ru/path",
  • "app_name": "my app",
  • "secret_key": "0123456789ABCDEF",
  • "auth": {
    },
  • "low_latency": true
}

Set RTMP Recordings Settings

Изменение настроек rtmp трансляции

Request Body schema: application/json
required
auto_start
required
boolean

Флаг автоматического включения трансляции

auto_stop
required
boolean

Флаг автоматической остановки трансляции

server_address
required
string

Сетевой адрес трансляции

app_name
required
string (may be empty)

Имя приложения

secret_key
required
string (may be empty)

Секретный ключ

object (domainAuthenticationSet)
low_latency
required
boolean

Флаг низкой задержки. При низкой задержке качество видео хуже. При высокой лучше.

Responses

Request samples

Content type
application/json
{
  • "auto_start": true,
  • "auto_stop": true,
  • "server_address": "rtmp:host.ru/path",
  • "app_name": "my app",
  • "secret_key": "0123456789ABCDEF",
  • "auth": {
    },
  • "low_latency": true
}

Response samples

Content type
application/json
{ }

Get Sap Recordings Settings

Получение настроек sap трансляции

Responses

Response samples

Content type
application/json
{
  • "auto_start": true,
  • "auto_stop": true,
  • "address": {
    }
}

Set SAP Recordings Settings

Изменение настроек sap трансляции

Request Body schema: application/json
required
auto_start
required
boolean

Флаг автоматического включения трансляции

auto_stop
required
boolean

Флаг автоматической остановки трансляции

required
object (domainNetworkAddress)

Responses

Request samples

Content type
application/json
{
  • "auto_start": true,
  • "auto_stop": true,
  • "address": {
    }
}

Response samples

Content type
application/json
{ }

Get Video Recording State

Получение информации о возможности видеозаписи на диск

Responses

Response samples

Content type
application/json
{
  • "can_recording": "true"
}

RS232

Get RS232 Config

Получение настроек RS232 (включено/выключено)

Responses

Response samples

Content type
application/json
{
  • "enabled": true
}

Switch RS232

Изменение настроек RS232 (включение/выключение)

Request Body schema: application/json
required
enabled
required
boolean

Флаг того что используется RS232

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{ }

Generate RS232 Password

Генерация пароля через который осуществляется работа с пользователем rs232

Responses

Response samples

Content type
application/json
{
  • "password": "0123456789ABCDEF"
}

SSH

Get SSH API

Получение настроек SSH API (включено/выключено)

Responses

Response samples

Content type
application/json
{
  • "enabled": true
}

Switch SSH API

Изменение настроек SSH API (включение/выключение)

Request Body schema: application/json
required
enabled
required
boolean

Флаг того что используется SSH API

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{ }

Stream

Stream

Request Body schema: application/json
required

(streaming inputs)

request_id
string

Строковый идентификатор запроса. Переданный идентификатор будет возвращен в теле ответа(поле request_id).

Лучше всего использовать уникальные идентификаторы для корректной проверки соответствия "ответ-запрос". Например, можно использовать Uuid.

object (domainSubscribeRequest)

Позволяет подписаться на указанное событие.

object (domainUnsubscribeRequest)

Позволяет отписаться от указанного события.

Responses

Request samples

Content type
application/json
{
  • "request_id": "09ff02c5-61fb-4cdc-b280-935dd6bc8271",
  • "subscribe": {
    },
  • "unsubscribe": {
    }
}

Response samples

Content type
application/json
{
  • "result": {
    }
}

System

Set System Name

Устанавливает имя системы

Request Body schema: application/json
required
system_name
required
string

Новое имя системы

Responses

Request samples

Content type
application/json
{
  • "system_name": "New System Name"
}

Response samples

Content type
application/json
{ }

Get System Status

Возвращает информацию о системном статусе

Responses

Response samples

Content type
application/json
{
  • "firmware_version": "1.0.0",
  • "system_name": "TrueConf System",
  • "mac": "00:1A:2B:3C:4D:5E",
  • "ip_address": "192.168.1.10",
  • "h323_address": "string",
  • "h323_gatekeeper": "string",
  • "sip_address": "string",
  • "sip_server": "string",
  • "sleep": false,
  • "video_outputs_test": true,
  • "veng_version": "string",
  • "stack_version": "string",
  • "h323_aliases": [
    ]
}

System Stats

Get CPU Stats Stream

Возвращает потоковую статистику загрузки процессора

path Parameters
period
required
string <uint64>

Период измерения CPU в секундах (от 1 до 60)

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get Disk Stats Stream

Возвращает потоковую статистику использования дискового пространства

path Parameters
period
required
string <uint64>

Период измерения диска в секундах (от 1 до 60)

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get Memory Stats Stream

Возвращает потоковую статистику использования оперативной памяти

path Parameters
period
required
string <uint64>

Период измерения памяти в секундах (от 1 до 60)

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Get Network Stats Stream

Возвращает потоковую статистику сетевой активности

path Parameters
period
required
integer <int32>

Период измерения сети в секундах (от 1 до 60)

Responses

Response samples

Content type
application/json
{
  • "result": {
    }
}

Tablets

Tablet Unpairing

Отключение планшета с заданным id от TCG

Request Body schema: application/json
required
tablet_id
required
string <uuid>

id планшета от которого хотим отключиться

Responses

Request samples

Content type
application/json
{
  • "tablet_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc"
}

Response samples

Content type
application/json
{ }

Get Tablets

Получение списка планшетов

query Parameters
page
string <int64>

Номер страницы

page_size
string <int64>

Размер страницы

sort_order
string <int64>

Порядок сортировки

sort_field
string

Поле по которому сортируем. Допустимые значения: 'created_at', 'display_name', 'last_activity_at'.

blocked
boolean

Флаг того что планшет блокирован

authorized
boolean

Флаг того что планшет авторизован

Responses

Response samples

Content type
application/json
{
  • "tablets": [
    ]
}

Block Tablet

Блокирование планшета

Request Body schema: application/json
required
tablet_id
required
string <uuid>

id планшета которых хотим блокировать

Responses

Request samples

Content type
application/json
{
  • "tablet_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc"
}

Response samples

Content type
application/json
{ }

Get Last Paired Tablet

Получение последнего по времени подключившегося но не авторизовавшегося планшета

Responses

Response samples

Content type
application/json
{
  • "tablet_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "code": "012345",
  • "display_name": "My Tablet",
  • "created_at": 12345678
}

Tablets Unpairing

Отключение всех планшетов от TCG

Responses

Response samples

Content type
application/json
{ }

Tablet Pairing

Установление связи с планшетом

Request Body schema: application/json
required
display_name
required
string

Отображаемое имя планшета

serial_id
required
string

Серийный номер планшета

Responses

Request samples

Content type
application/json
{
  • "display_name": "My Tablet",
  • "serial_id": "ABCD1234"
}

Response samples

Content type
application/json
{
  • "tablet_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc"
}

Unblock Tablet

Разблокирование планшета

Request Body schema: application/json
required
tablet_id
required
string <uuid>

id планшета который хотим разблокировать

Responses

Request samples

Content type
application/json
{
  • "tablet_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc"
}

Response samples

Content type
application/json
{ }

TCS

Create TCS Server

Создает новый TCS сервер

Request Body schema: application/json
required
name
string or null

Отображаемое имя TCS сервера (опционально)

address
required
string

Сетевой адрес TCS сервера

client_id
required
string

Идентификатор клиента для TCS сервера

client_secret
required
string

Секрет клиента для аутентификации

sync_enabled
boolean

Флаг включения синхронизации с TCS сервером

sync_interval
required
string (- SI_10MIN: интервал синхронизации с ТКС сервером: 10 минут - SI_30MIN: интервал синхронизации с ТКС сервером: 30 минут - SI_1HOUR: интервал синхронизации с ТКС сервером: 1 час - SI_1DAY: интервал синхронизации с ТКС сервером: 1 день)
Default: "SI_UNKNOWN"
Enum: "SI_UNKNOWN" "SI_10MIN" "SI_30MIN" "SI_1HOUR" "SI_1DAY"

Responses

Request samples

Content type
application/json
{
  • "name": "New TCS Server",
  • "address": "192.168.1.151:9090",
  • "client_id": "tcs-client-002",
  • "client_secret": "secret-tcs-xyz",
  • "sync_enabled": true,
  • "sync_interval": "SI_UNKNOWN"
}

Response samples

Content type
application/json
{
  • "server": {
    }
}

Get TCS Server

Получает информацию о TCS сервере по идентификатору

path Parameters
node_id
required
string

Уникальный идентификатор TCS сервера

Responses

Response samples

Content type
application/json
{
  • "server": {
    }
}

Delete TCS Server

Удаляет TCS сервер по идентификатору

path Parameters
node_id
required
string

Идентификатор TCS сервера, который необходимо удалить

Responses

Response samples

Content type
application/json
{ }

Update TCS Server

Обновляет параметры TCS сервера

path Parameters
node_id
required
string

Идентификатор TCS сервера для обновления

Request Body schema: application/json
required
name
string or null

Новое имя TCS сервера (если обновляется)

address
string or null

Новый адрес TCS сервера (если обновляется)

client_id
string or null

Новый идентификатор клиента (если обновляется)

client_secret
string or null

Новый секрет клиента (если обновляется)

sync_enabled
boolean or null

Флаг включения синхронизации (если обновляется)

sync_interval
string (- SI_10MIN: интервал синхронизации с ТКС сервером: 10 минут - SI_30MIN: интервал синхронизации с ТКС сервером: 30 минут - SI_1HOUR: интервал синхронизации с ТКС сервером: 1 час - SI_1DAY: интервал синхронизации с ТКС сервером: 1 день)
Default: "SI_UNKNOWN"
Enum: "SI_UNKNOWN" "SI_10MIN" "SI_30MIN" "SI_1HOUR" "SI_1DAY"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "address": "string",
  • "client_id": "string",
  • "client_secret": "string",
  • "sync_enabled": false,
  • "sync_interval": "SI_UNKNOWN"
}

Response samples

Content type
application/json
{ }

Get TCS Servers

Получает список всех TCS серверов

query Parameters
page
string <int64>

Номер страницы для пагинации

page_size
string <int64>

Количество серверов на странице

sort_order
string <int64>

Порядок сортировки (1 для возрастания, -1 для убывания)

sort_field
string

Поле для сортировки

Responses

Response samples

Content type
application/json
{
  • "servers": [
    ]
}

Time

Update NTP Settings

Изменение настроек NTP

Request Body schema: application/json
required
use_ntp
required
boolean

Флаг использования NTP сервера

ntp_servers
required
Array of strings

Список используемых NTP серверов

poll_interval
required
string <int64> >= 16

Период опроса NTP серверов (в секундах)

Responses

Request samples

Content type
application/json
{
  • "use_ntp": true,
  • "ntp_servers": [
    ],
  • "poll_interval": 32
}

Response samples

Content type
application/json
{ }

Get System Time

Получение системного времени / временной зоны / параметров NTP

Responses

Response samples

Content type
application/json
{
  • "system_time": 1714215908,
  • "timezone": "Europe/Moscow",
  • "use_ntp": true,
  • "ntp_servers": [
    ],
  • "sync_ntp": true,
  • "poll_interval": 32
}

Update System Time

Изменение системного времени / временной зоны

Request Body schema: application/json
required
system_time
string or null <date-time>

Системное (локальное) время

timezone
required
string

Временная зона

Responses

Request samples

Content type
application/json
{
  • "system_time": 1714215908,
  • "timezone": "Europe/Moscow"
}

Response samples

Content type
application/json
{ }

Get Timezones

Получение списка всех временных зон

Responses

Response samples

Content type
application/json
{
  • "timezones": [
    ]
}

TLS

Get TLS Files From USB Drive

Получение сертификатов публичного API с флешки

query Parameters
tls_type
required
string
Default: "TFT_UNKNOWN"
Enum: "TFT_UNKNOWN" "TFT_CRT" "TFT_KEY"

Тип файла сертификата (сертификат или приватный ключ)

  • TFT_CRT: тип файла: сертификат
  • TFT_KEY: тип файла: приватный ключ

Responses

Response samples

Content type
application/json
{
  • "files": [
    ]
}

Remove TLS Files

Удаление сертификатов публичного API

Responses

Response samples

Content type
application/json
{ }

Import TLS Files From USB Drive

Импорт сертификатов публичного API

Request Body schema: application/json
required
required
object (domainTlsFileInfo)
required
object (domainTlsFileInfo)
key_password
required
string or null

Пароль приватного ключа

Responses

Request samples

Content type
application/json
{
  • "crt": {
    },
  • "key": {
    },
  • "key_password": "qwerty"
}

Response samples

Content type
application/json
{ }

UI

Get Video Output Device Image Test

Получает текущее тестовое изображение для видеовыходного устройства

Responses

Response samples

Content type
application/json
{
  • "enabled": true
}

Update Video Output Device Image Test

Обновляет тестовое изображение для видеовыходного устройства

Request Body schema: application/json
required
enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{ }

Close Video Stream View

Закрывает окно видеопотока в пользовательском интерфейсе

Request Body schema: application/json
required
object (domainUiCloseVideoStreamViewRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Open Video Stream View

Открывает окно видеопотока в пользовательском интерфейсе

Request Body schema: application/json
required
object (domainUiOpenVideoStreamViewRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

UI Conference Config

Get Conference Config

Получает глобальные настройки конфигурации конференций в UI.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Update Conference Config

Обновляет глобальные настройки конфигурации конференций в UI.

Request Body schema: application/json
required
object (domainUiConferenceConfigPayload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{ }

UI Power Config

Get Power Config

Получает глобальные настройки конфигурации питания в UI.

Responses

Response samples

Content type
application/json
{
  • "payload": {
    }
}

Update Power Config

Обновляет глобальные настройки конфигурации питания в UI.

Request Body schema: application/json
required
object (domainUiPowerConfigPayload)

Responses

Request samples

Content type
application/json
{
  • "payload": {
    }
}

Response samples

Content type
application/json
{ }

USB Drive

Get USB Drive Status

Возвращает статус подключенного USB устройства

Responses

Response samples

Content type
application/json
{
  • "name": "Test name"
}

Users

Get Users

Получение списка пользователей

query Parameters
page
string <int64>

Номер страницы выдаваемого списка

page_size
string <int64>

Число записей на странице

sort_order
string <int64>

Порядок сортировки

sort_field
string

Поле по которому сортируем. Может принимать значения 'created_at' и 'display_name'.

Responses

Response samples

Content type
application/json
{
  • "users": [
    ]
}

Get Credentials

Получение авторизационных данных заданного пользователя

query Parameters
user_id
required
string <uuid>

Id пользователя

Responses

Response samples

Content type
application/json
{
  • "login": "mylogin",
  • "has_password": true
}

Update Credentials

Изменение авторизационных данных заданного пользователя

Request Body schema: application/json
required
user_id
required
string <uuid>

Id пользователя

login
string or null

Логин пользователя

password
string or null

Пароль пользователя

Responses

Request samples

Content type
application/json
{
  • "user_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "login": "mylogin",
  • "password": "mypassword"
}

Response samples

Content type
application/json
{ }

Get Profile Credentials

Получение авторизационных данных пользователя от имени которого залогинились

Responses

Response samples

Content type
application/json
{
  • "login": "mylogin",
  • "has_password": true
}

Update Profile Credentials

Изменение авторизационных данных пользователя от имени которого залогинились

Request Body schema: application/json
required
login
string or null

Логин пользователя

password
string or null

Новый пароль пользователя

Responses

Request samples

Content type
application/json
{
  • "login": "mylogin",
  • "password": "my-new-password"
}

Response samples

Content type
application/json
{ }

Users profile

Get Profile

Получение профиля пользователя

Responses

Response samples

Content type
application/json
{
  • "display_name": "string",
  • "role": {
    }
}

Video Devices

Get Serial Devices

Получение списка серийных портов

Responses

Response samples

Content type
application/json
{
  • "devices": [
    ]
}

Get Video Stream Settings

Получение настроек видеопотоков

Responses

Response samples

Content type
application/json
{
  • "stream_settings": {
    }
}

Set Video Stream Settings

Изменение настроек видеопотоков

Request Body schema: application/json
required
required
object (domainVideoStreamSettings)

Responses

Request samples

Content type
application/json
{
  • "stream_settings": {
    }
}

Response samples

Content type
application/json
{ }

Get Camera Controls

Получение параметров управления (поворота) камерой

query Parameters
device_id
required
string

Id видеоустройства.

Responses

Response samples

Content type
application/json
{
  • "device_controls": [
    ]
}

Get Video Codec Settings

Получение списка видеокодеков

Responses

Response samples

Content type
application/json
{
  • "codecs": [
    ]
}

Set Video Codec Settings

Изменение списка видеокодеков

Request Body schema: application/json
required
codecs
required
Array of strings (- VCODEC_H261: ITU-T H.261 - VCODEC_H263: ITU-T H.263, H.263++ - VCODEC_H264BP: ITU-T H.264 Baseline profile - VCODEC_H264HP: ITU-T H.264 High profile - VCODEC_H264SVC: ITU-T H.264 SVC - VCODEC_H265: ITU-T H.265)
Items Enum: "VCODEC_UNDEFINED" "VCODEC_H261" "VCODEC_H263" "VCODEC_H264BP" "VCODEC_H264HP" "VCODEC_H264SVC" "VCODEC_H265"

Список видеокодеков.

Responses

Request samples

Content type
application/json
{
  • "codecs": [
    ]
}

Response samples

Content type
application/json
{
  • "request_id": 123456
}

Get Video Layout Settings

Получение настроек видео раскладок

Responses

Response samples

Content type
application/json
{
  • "layout_settings": {
    }
}

Set Video Layout Settings

Изменение настроек видео раскладок

Request Body schema: application/json
required
required
object (domainVideoLayoutSettings)

Responses

Request samples

Content type
application/json
{
  • "layout_settings": {
    }
}

Response samples

Content type
application/json
{ }

Video Input Devices

Get Video Input Device

Получение параметров выбранного 'входящего' видеоустройства (видеокамеры)

query Parameters
device_id
required
string <uuid>

Id видеоустройства параметры которого хотим получить.

Responses

Response samples

Content type
application/json
{
  • "device": {
    },
  • "modes": [
    ]
}

Get Video Input Devices

Получение параметров 'входящих' видеоустройств (видеокамер)

Responses

Response samples

Content type
application/json
{
  • "devices": [
    ]
}

Delete Video Input Device

Удаление выбранного 'входящего' видеоустройства (видеокамеры)

query Parameters
device_id
required
string <uuid>

Id видеоустройства.

Responses

Response samples

Content type
application/json
{ }

Create Video Input Device

Создание 'входящего' видеоустройства (видеокамеры) с использованием URI IP-камеры (VNC, RTSP, NDI)

Request Body schema: application/json
required
address_id
required
string <uuid>

Id адреса IP камеры (VNC, RTSP, NDI) из которого создаем 'видеокамеру'.

required
object (domainVideoInputDeviceSetConfig)

Responses

Request samples

Content type
application/json
{
  • "address_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "device_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc"
}

Update Video Input Device

Изменение выбранного 'входящего' видеоустройства (видеокамеры)

Request Body schema: application/json
required
device_id
required
string <uuid>

Id видеоустройства.

uri
string or null

uri видеоустройства.

object (domainVideoInputDeviceSetConfig)

Responses

Request samples

Content type
application/json
{
  • "device_id": "77e6ef13-ba8a-473d-9380-f538fa76d7fc",
  • "uri": "rtsp:host",
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "device_id": "string"
}

Video Layout

Set Video Layout

Устанавливает видеомакет конференции

Request Body schema: application/json
required
value
required
string (- VL_AUTO: автоматический выбор схемы раскладки - VL_EQUAL: равноправная раскладка - VL_TOP: большое окно и столбик маленьких окошек вверху - VL_LEFT: большое окно и столбик маленьких окошек слева - VL_BOTTOM: большое окно и столбик маленьких окошек внизу - VL_RIGHT: большое окно и столбик маленьких окошек справа)
Default: "VL_UNSPECIFIED"
Enum: "VL_UNSPECIFIED" "VL_AUTO" "VL_EQUAL" "VL_TOP" "VL_LEFT" "VL_BOTTOM" "VL_RIGHT"

Responses

Request samples

Content type
application/json
{
  • "value": "VL_UNSPECIFIED"
}

Response samples

Content type
application/json
{
  • "request_id": 1234
}

Set Selected Video Layout Slot

Выбирает конкретный слот в текущем видеомакете

Request Body schema: application/json
required
required
object (domainVideoLayoutSlot)

Responses

Request samples

Content type
application/json
{
  • "selected": {
    }
}

Response samples

Content type
application/json
{ }

Get Video Layout Status

Возвращает текущий статус видеомакета

Responses

Response samples

Content type
application/json
{
  • "status": {
    }
}

Set Video Layout Selfview

Изменяет режим отображения раскладок

Request Body schema: application/json
required
enabled
required
boolean

изменяет режим отображения раскладок

Responses

Request samples

Content type
application/json
{
  • "enabled": true
}

Response samples

Content type
application/json
{ }

Video Output Devices

Get Video Output Device

Получение параметров выбранного видеоустройства (монитора)

query Parameters
device_id
required
integer <int64>

Id видеоустройства.

Responses

Response samples

Content type
application/json
{
  • "device": {
    }
}

Get Video Output Devices

Получение списка видеоустройств (мониторов)

Responses

Response samples

Content type
application/json
{
  • "devices": [
    ]
}

Update Video Output Device

Изменение выбранного 'исходящего' видеоустройства (монитора)

Request Body schema: application/json
required
device_id
required
integer <int64>

Id видеоустройства.

required
object (domainVideoOutputDeviceConfig)

Responses

Request samples

Content type
application/json
{
  • "device_id": 123456,
  • "config": {
    }
}

Response samples

Content type
application/json
{ }

Set Video Output Device Calibration

Включение/выключение калибровки видеоустройства (монитора)

Request Body schema: application/json
required
status
required
string (- VODCS_INACTIVE: калибровка выключена - VODCS_IN_PROGRESS: калибровка включена)
Default: "VODCS_UNKNOWN"
Enum: "VODCS_UNKNOWN" "VODCS_INACTIVE" "VODCS_IN_PROGRESS"

Responses

Request samples

Content type
application/json
{
  • "status": "VODCS_UNKNOWN"
}

Response samples

Content type
application/json
{ }

Set Video Output Device Content Type

Установка типа содержимого видеоустройства (монитора)

Request Body schema: application/json
required
device_id
required
integer <int64>

Id видеоустройства.

content_type
required
string (- VC_CONTENT_OFF: нет контента - VC_CONNECTION: участник - VC_SELFVIEW: своя камера - VC_PRESENTATION: презентация - VC_PRIMARY_DISPLAY: основной дисплей - VC_CONFERENCE: раскладка конференции - VC_AUTO: автовыбор)
Default: "VC_UNKNOWN"
Enum: "VC_UNKNOWN" "VC_CONTENT_OFF" "VC_CONNECTION" "VC_SELFVIEW" "VC_PRESENTATION" "VC_PRIMARY_DISPLAY" "VC_CONFERENCE" "VC_AUTO"

Responses

Request samples

Content type
application/json
{
  • "device_id": 123456,
  • "content_type": "VC_UNKNOWN"
}

Response samples

Content type
application/json
{ }

Get Video Output Device Modes

Получение списка видеорежимов видеоустройства (монитора)

query Parameters
device_id
required
integer <int64>

Id видеоустройства.

Responses

Response samples

Content type
application/json
{
  • "modes": [
    ]
}

Set Primary Video Output Device

Установка первичного видеоустройства (монитора)

Request Body schema: application/json
required
device_id
required
integer <int64>

Id видеоустройства.

Responses

Request samples

Content type
application/json
{
  • "device_id": 123456
}

Response samples

Content type
application/json
{ }

Set Video Output Devices Test Mode

Включение/выключение теста видеоустройства (монитора)

Request Body schema: application/json
required
enable
required
boolean

Флаг включения/выключения теста видеоустройства.

timeout
integer or null <int64> (timeout in milliseconds, default is 30000 msec and will be set if the value is missing)

Длительность теста видеоустройства в миллисекундах. Значение по умолчанию (если поле не указано) 30000 мс.

Responses

Request samples

Content type
application/json
{
  • "enable": true,
  • "timeout": 123
}

Response samples

Content type
application/json
{ }