Перейти к содержанию

HTTP API

HTTP API позволяет получить программный доступ к большинству функций, доступных в личном кабинете: управление компьютерами, создание отложенных подключений.

Запросы

Все запросы должны выполняться по протоколу HTTPS (не HTTP) соответствующим методом для каждой команды по адресу https://api.pro32connect.ru/v1/

Ответы

Ответы с данными выдаются в JSON-формате в кодировке UTF-8 с ContentType: application/json. В каждом ответе данные оборачиваются в JSON-контейнер data

API-сервер может возвращать следующий HTTP-коды ответов:

HTTP-код ответа Описание
200 OK Запрос принят и обработан
400 Bad Request Запрос отклонен, неверные параметры, ошибка
402 Payment Required Запрос отклонен, превышен лимит запросов для тарифного плана
403 Forbidden Запрос отклонен, к данным нет доступа
404 Not Found Запрос отклонен, неизвестный URL запроса

Аутентификация

API является RESTful API — сервер не хранит состояние соединения с клиентом. Поэтому, при каждой отправке запроса клиент должен отправлять авторизационные данные. В качестве таких данных используется API-ключ. Добавляйте ключ в каждом запросе в GET-параметре ?apikey= или в HTTP-заголовке X-Api-Key

https://api.pro32connect.ru/v1/?apikey=YOUR_API_KEY

ℹ Ваш API-ключ находится в личном кабинете в разделе «Интеграции» на вкладке HTTP API

Методы

Это команды для управления компьютерами и подключениями. Мы разделили их на несколько групп:

Постоянный доступ

Список компьютеров

Вы можете получить полный список компьютеров используя метод agents/list

ℹ В контексте обращений к API компьютеры будут именоваться как «Агенты», потому что в техническом отношении управление компьютером осуществляется через программу агента

Запрос:

GET https://api.pro32connect.ru/v1/agents/list
 ?apikey=<string>

Параметры запроса:

Параметр Тип Значение
apikey string API-ключ для авторизации запроса
search string Поиск по имени агента, IP-адресу или названию группы
group_id string Фильтр по идентификатору группы

Ответ:

{
    "data":[ {
        "id":1001,
        "name":"Allesandro Paci",
        "group":"Accounting",
        "disabled":false,
        "limited":false,
        "link_time":1587837997,
        "last_time":1600374761,
        "geo":{
            "ip":"2.21.31.68",
            "country":"USA",
            "region":"California",
            "city":"Los Angeles"
        },
        "permanent_url":"https://go.pro32connect.ru/paci",
        "preview_url":"https://pro32connect.ru/preview/1245273f5448a704379da46f476564a592efb17c6a7695adde96247cd7874416GbBzRm6SRLMqrP0YoYFMxCopL6NTzvn8.png",
        "os":"win",
        "version":"1.9.4",
        "online":true,
        "installed":true,
        "favorite":false,
        "owner":"john.smith@gmail.com",
        "sessions":{
            "last":{
                "id":148505,
                "start_time":1600343858,
                "stop_time":1600343900,
                "client":{
                    "ip":"188.162.195.82",
                    "country":"Russian Federation",
                    "region":"Tatarstan",
                    "city":"Kazan",
                    "user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36"
                }
            },
            "total":121
        }
    }, ... ]
}

Данные ответа:

Название Тип Описание
id number Внутри-системный идентификатор
name string Название
group string Группа
disabled boolean
Агент заблокирован?

⚠ К заблокированным агентам подключится нельзя. Блокировка наступает в случае превышения лимита по количеству компьютеров в тарифного плана.
limited boolean
Агент лимитирован?

ℹ Агент становится лимитированным в случае превышения лимита тарифного плана по количестсву прикрепленных файлов. Через 10 дней после добавления лимитированный агент становится заблокированным.
link_time unixtime Дата и время добавления в личный кабинет
last_time unixtime Дата и время последнего состояния «в сети»
geo object Гео-расположение
geo.ip string IP-адрес
geo.country string Страна
geo.region string Регион
geo.city string Город
permanent_url string
Постоянный URL-адрес для подключения

ℹ Поле может отсутствовать, если доступ для неавторизованных пользователей закрыт
onetime_url string
URL-адрес для одноразового подключения

⚠ Ссылка меняется каждые 45 секунд

ℹ Поле может отсутствовать, если подключения по одноразовым ссылкам запрещены в настройках агента
preview_url string URL-адрес для загрузки превью рабочего стола
os string Операционная система. Возможные значения: win, mac, linux и android
version string Версия программы агента
online boolean Текущее состояние «В сети»
installed boolean Агент установлен на компьютере?
favorite boolean Это избранный компьютер в списке в личном кабинете?
owner string Учетная запись владельца доступа к компьютеру внутри системы
sessions object Информация о подключениях
sessions.last object Последнее подключение
sessions.last.id number Внутри-системный идентификатор подключения
sessions.last.start_time unixtime Дата и время начала подключения
sessions.last.stop_time unixtime Дата и время конца подключения

ℹ Поле может отсутствовать, если подключение активно
sessions.last.client object Информация о клиенте (автор подключения)
sessions.last.client.ip string IP-адрес
sessions.last.client.country string Страна
sessions.last.client.region string Регион
sessions.last.client.city string Город
sessions.last.client.user_agent string Юзер-агент браузера клиента
sessions.total object Общее количество подключений

Информация о компьютере

Чтобы получить информацию о компьютере из раздела Постоянного Доступа, вам необходимо использовать метод agents/info

Запрос:

GET https://api.pro32connect.ru/v1/agents/info
  ?apikey=<string>
  &agent_id=<number>

Параметры запроса:

Параметр Тип Значение
apikey string API-ключ для авторизации запроса
agent_id number Внутрисистемный идентификатор агента

Ответ:

{
    "data": {
        "id": 1001,
        "name": "Allesandro Paci",
        "group": "Accounting",
        "disabled": false,
        "limited": false,
        "link_time": 1587837997,
        "last_time": 1600374761,
        "geo": {
            "ip": "2.21.31.68",
            "country": "USA",
            "region": "California",
            "city": "Los Angeles"
        },
        "permanent_url": "https://go.pro32connect.ru/paci",
        "onetime_url": "https://go.pro32connect.ru/am2-l2g",
        "preview_url": "https://pro32connect.ru/preview/1245273f5448a704379da46f476564a592efb17c6a7695adde96247cd7874416GbBzRm6SRLMqrP0YoYFMxCopL6NTzvn8.png",
        "os": "win",
        "version": "2.7.6",
        "online": true,
        "installed": true,
        "favorite": false,
        "owner": "john.smith@gmail.com",
        "hardware": {
            "BIOS": "ALASKA - 1072009 - F51 - American Megatrends - 5000E",
            "BIOSDate": "",
            "BIOSVersion": "20191218",
            "CPU": "AMD Ryzen 5 2600X Six-Core Processor",
            "CPUCores": 6,
            "CPUCoresLogical": 12,
            "CPUFamily": "AMD64 Family 23 Model 8 Stepping 2",
            "CPUSpeed": 3600,
            "ComputerDomain": "WORKGROUP",
            "ComputerIP": [
                "10.66.65.3",
                "fe80::35da:bb0:c661:fff9"
            ],
            "ComputerModel": "B450 AORUS ELITE",
            "ComputerName": "DESKTOP-AU0VQEE",
            "ComputerWorkgroup": "WORKGROUP",
            "HDD": [ {
                "Model": "INTEL SSDPEKNW512G8",
                "Size": 488382
            } ],
            "Locale": "0419",
            "LocaleCountry": "USA",
            "LocaleCurrency": "USD",
            "LocaleFormatDate": "MM-DD-YYYY",
            "LocaleFormatTime": "H:mm:ss",
            "LocaleOemPage": "437",
            "LocaleTimezone": -420,
            "LogicalDisks": [ {
                "Disk": "C:",
                "FileSystem": "NTFS",
                "FreeSpace": 13668,
                "Name": "",
                "Size": 487757
            } ],
            "Monitors": [ {
                "Name": "Universal PnP monitor",
                "ScreenHeight": 1080,
                "ScreenWidth": 1920
            } ],
            "NetAdapters": [ {
                "Addresses": "",
                "Cable": true,
                "DCHP": "",
                "DNS": "",
                "MACAddress": "18:C0:4D:44:F0:61",
                "Manufacturer": "Realtek",
                "Name": "Realtek Gaming GbE Family Controller",
                "Speed": 953,
                "WoL": true
            } ],
            "OSName": "Microsoft Windows 10 Pro",
            "OSVersion": "10.0.19044",
            "RAMBanks": [ {
                "Bank": "P0 CHANNEL A",
                "Capacity": 8192,
                "DataWidth": 64,
                "Locator": "DIMM 0",
                "Manufacturer": "Unknown",
                "PartNumber": "F4-3200C16-8GSXFB",
                "SerialNumber": "00000000"
            } ],
            "RAMPageFile": 51264,
            "RAMPhys": 32716,
            "RAMPhysAvail": 9380,
            "RAMVirt": 134217727,
            "RAMVirtAvail": 134213282,
            "SoundDevices": [ {
                "Name": "NVIDIA High Definition Audio"
            } ],
            "VideoCards": [ {
                "Integrated": true,
                "Name": "NVIDIA GeForce GT 710",
                "RAM": 1024
            } ],
            "VideoName": "NVIDIA GeForce GT 710",
            "VideoRAM": 1024
        },
        "sessions": {
            "last": {
                "id":148505,
                "start_time":1600343858,
                "stop_time":1600343900,
                "client":{
                    "ip":"188.162.195.82",
                    "country":"Russian Federation",
                    "region":"Tatarstan",
                    "city":"Kazan",
                    "user_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36"
                }
            },
            "total": 1
        }
    }
}

Данные ответа:

Название Тип Описание
id number Внутри-системный идентификатор
name string Название
group string Группа
disabled boolean
Агент заблокирован?

⚠ К заблокированным агентам подключится нельзя. Блокировка наступает в случае превышения лимита по количеству компьютеров в тарифного плана.
limited boolean
Агент лимитирован?

ℹ Агент становится лимитированным в случае превышения лимита тарифного плана по количестсву прикрепленных файлов. Через 10 дней после добавления лимитированный агент становится заблокированным.
link_time unixtime Дата и время добавления в личный кабинет
last_time unixtime Дата и время последнего состояния «в сети»
geo object Гео-расположение
geo.ip string IP-адрес
geo.country string Страна
geo.region string Регион
geo.city string Город
permanent_url string
Постоянный URL-адрес для подключения

ℹ Поле может отсутствовать, если доступ для неавторизованных пользователей закрыт
onetime_url string
URL-адрес для одноразового подключения

⚠ Ссылка меняется каждые 45 секунд

ℹ Поле может отсутствовать, если подключения по одноразовым ссылкам запрещены в настройках агента
preview_url string URL-адрес для загрузки превью рабочего стола
os string Операционная система. Возможные значения: win, mac, linux и android
version string Версия программы агента
online boolean Текущее состояние «В сети»
installed boolean Агент установлен на компьютере?
favorite boolean Это избранный компьютер в списке в личном кабинете?
owner string Учетная запись владельца доступа к компьютеру внутри системы
hardware object Информация о системе
hardware.BIOS string Информация о BIOS
hardware.BIOSDate string Дата обновления
hardware.BIOSVersion string Версия
hardware.CPU string Процессор
hardware.CPUCores number Количество ядер
hardware.CPUCoresLogical number Количество логических процессоров
hardware.CPUFamily string Семейство
hardware.CPUSpeed number Скорость
hardware.ComputerDomain string Домен
hardware.ComputerIP array IP-адрес
hardware.ComputerModel string Модель
hardware.ComputerName string Имя компьютера
hardware.ComputerWorkgroup string Рабочая группа
hardware.HDD array Жесткие диски
hardware.HDD[].Model string Модель
hardware.HDD[].Size number Размер
hardware.Locale string Локаль
hardware.LocaleCountry string Страна
hardware.LocaleCurrency string Валюта
hardware.LocaleFormatDate string Формат даты
hardware.LocaleFormatTime string Формат времени
hardware.LocaleOemPage string Кодировка страниц
hardware.LocaleTimezone number Таймзона
hardware.LogicalDisks array Логические диски
hardware.LogicalDisks[].Disk string Метка
hardware.LogicalDisks[].FileSystem string Тип файловой системы
hardware.LogicalDisks[].FreeSpace number Свободное место (МБ)
hardware.LogicalDisks[].Name string Название
hardware.LogicalDisks[].Size number Размер (МБ)
hardware.Monitors array Мониторы
hardware.Monitors[].Name string Название
hardware.Monitors[].ScreenHeight number Высота экрана
hardware.Monitors[].ScreenWidth number Ширина экрана
hardware.NetAdapters array Сетевые карты
hardware.NetAdapters[].Addresses string Адрес
hardware.NetAdapters[].Cable boolean Подключение в интернет по LAN-кабелю
hardware.NetAdapters[].DCHP string DCHP
hardware.NetAdapters[].DNS string DNS
hardware.NetAdapters[].MACAddress string MAC-адрес
hardware.NetAdapters[].Manufacturer string Производитель
hardware.NetAdapters[].Name string Название
hardware.NetAdapters[].Speed number Скорость
hardware.NetAdapters[].WoL boolean Включена настройка Wake-on-LAN
hardware.OSName string Название операционной системы
hardware.OSVersion string Версия операционной системы
hardware.RAMBanks array Память ОЗУ
hardware.RAMBanks[].Bank string Слот
hardware.RAMBanks[].Capacity number Емкость
hardware.RAMBanks[].Locator string Локатор
hardware.RAMBanks[].Manufacturer string Производитель
hardware.RAMBanks[].PartNumber string Партия
hardware.RAMBanks[].SerialNumber string Серия
hardware.SoundDevices array Звуковые карты
hardware.SoundDevices[].Name string Название
hardware.VideoCards array Видео-карта
hardware.VideoCards[].Integrated boolean Интегрированная
hardware.VideoCards[].Name string Название
hardware.VideoCards[].RAM number Память
sessions object Информация о подключениях
sessions.last object Последнее подключение
sessions.last.id number Внутри-системный идентификатор подключения
sessions.last.start_time unixtime Дата и время начала подключения
sessions.last.stop_time unixtime Дата и время конца подключения

ℹ Поле может отсутствовать, если подключение активно
sessions.last.client object Информация о клиенте (автор подключения)
sessions.last.client.ip string IP-адрес
sessions.last.client.country string Страна
sessions.last.client.region string Регион
sessions.last.client.city string Город
sessions.last.client.user_agent string Юзер-агент браузера клиента
sessions.total object Общее количество подключений

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

Чтобы изменить какое-то свойство устройства, привязанного к вашей учетной записи, вы можете использовать метод devices/update

ℹ В запросе необязательно перечислять все свойства. Изменяться будут только те, которые вы укажете. Список полей, доступных для обновления, смотрите в параметрах ниже.

Запрос:

POST https://api.pro32connect.ru/v1/agents/update
  ?apikey=<string>

  BODY: {
    "id": <number>,
    "permanent_url": {
      "enable": <boolean>,
      "url": <string>,
      "password": <string>
    }
  }

Параметры запроса:

Параметр Тип Значение
apikey string API-ключ для авторизации запроса
id number Внутрисистемный идентификатор агента
permanent_url object Постоянная ссылка для подключения
permanent_url.enable boolean Включить/выключить
permanent_url.url string Путь ссылки
permanent_url.password string Пароль для подключения (не меньше 8 символов, обязательно буквы и цифры)

Ответ:

{
    "status": 0,
    "data": { ... }
}

Данные ответа:

Название Тип Описание
number status Статус результата. Возможные значения:
  • 0 - Данные успешно сохранены
  • 1 - Некорректный запрос
  • 7 - Путь для постоянной ссылки занят
  • 8 - Изменение свойств запрещено
  • 21 - Невалидный пароль для постоянной ссылки
data object Измененные данные

Получить ссылку для подключения

Чтобы подключиться к компьютеру через API вам необходимо получить одноразовую ссылку, используя метод agents/connect

ℹ Полученная ссылка сгорает сразу же после первого использования. Вам нужно получать её каждый раз, когда вы хотите подключиться.

Запрос:

POST https://api.pro32connect.ru/v1/agents/connect
  ?apikey=<string>
  &agent_id=<number>

Параметры запроса:

Параметр Тип Значение
apikey string API-ключ для авторизации запроса
agent_id number Внутрисистемный идентификатор агента
device_id number Публичный идентификатор агента. Доступен в карточке агента в личном кабинете.

ℹ Используется, если параметр agent_id не указан.

Ответ:

{
    "data":{
        "url": "https://go.pro32connect.ru/john.smith/?connect=20177&amp;llt=66b4kj671pm3abpp5xh17elpnpze245382m9pxbrx313l2xp52hmxqe4e1dekpej&amp;s=c2c5ca25eb4fca787b74a97648e0856951e2b9c7aa02cbf83ac62c81e21a9bab"
    }
}

Данные ответа:

Название Тип Описание
url string URL-адрес для подключения

Выход из учетной записи

Чтобы открепить устройство от вашей учетной записи и удалить его из постоянного доступа, используйте метод agents/logout

⚠ Будьте внимательны! После открепления устройства вы потеряете возможность им управлять.

Запрос:

POST https://api.pro32connect.ru/v1/agents/logout
  ?apikey=<string>

  BODY: {
    "id": <number>
  }

Параметры запроса:

Параметр Тип Значение
apikey string API-ключ для авторизации запроса
id number Внутрисистемный идентификатор агента

Ответ:

{
    "status": 0
}

Данные ответа:

Название Тип Описание
number status Статус результата. Возможные значения:
  • 0 - Выход устройства выполнен успешно
  • 1 - Некорретный запрос
  • 6 - Устройство не найдено
  • 8 - Операция запрещена

Быстрая поддержка

Список открытых подключений

Чтобы получить список открытых подключений из раздела Быстрая поддержка воспользуйтесь методом support/list

Запрос:

GET https://api.pro32connect.ru/v1/support/list
  ?apikey=<string>

Параметры запроса:

Параметр Тип Значение
apikey string API-ключ для авторизации запроса

Ответ:

{
    "remain":100,
    "data":[ {
        "id":328,
        "status":0,
        "create_time":1600262268,
        "invite_code":"408080316",
        "invite_url":"https://go.pro32connect.ru/invite/408080316",
        "connect_url":"https://go.pro32connect.ru/turbo/nrhaStVwQSQ1J4DW0cL4wc1ADUeyug8BZjFaCgEqT4wuFXSPXQrGoRRBUxK1uFTU1Sr7bYlsviZ0djTophpmnIhpaZuMfGSKdSefcDzOWCgJuGeHGA5hFkcflhAXhBrx",
        "client_name":"Jacob Williams",
        "client_os":"",
        "client_preview_url":""
    } ]
}
Данные записи подключения:

Название Тип Описание
id number Внутри-системный идентификатор подключения
status number Статус подключения. Возможные значения:
  • 0 - Новое подключение, ожидается присоединение клиента
  • 1 - Клиент подключился, ожидается присоединение оператора
  • 2 - Активное подключение, все участники присоединились
  • 3 - Закрытое подключения
create_time unixtime Дата и время создания подключения
invite_code string Код для приглашения
invite_url string URL-адрес для приглашения
connect_url string URL-адрес для присоединения оператора к подключению
client_name string Имя клиента
client_os string Операционная система. Возможные значения: win, mac, linux и android

ℹ Поле заполняется после присоединения клиента
client_preview_url string Миниатюра изображения рабочего стола клиента

ℹ Поле заполняется после присоединения клиента

Дополнительные данные:

Название Тип Описание
remain number Количество оставшихся подключений в рамках тарифного плана

Создать подключение

Чтобы создать отложенное подключение для удаленной поддержки используйте метод support/create

Запрос:

POST https://api.pro32connect.ru/v1/support/create
  ?apikey=<string>
  &client_name=<string>

Параметры запроса:

Параметр Тип Значение
apikey string API-ключ для авторизации запроса
client_name string Имя клиента (видно только вам). Необязательный параметр.

Ответ:

{
    "data":{
        "id":328,
        "status":0,
        "create_time":1600262268,
        "invite_code":"408080316",
        "invite_url":"https://go.pro32connect.ru/invite/408080316",
        "connect_url":"https://go.pro32connect.ru/turbo/nrhaStVwQSQ1J4DW0cL4wc1ADUeyug8BZjFaCgEqT4wuFXSPXQrGoRRBUxK1uFTU1Sr7bYlsviZ0djTophpmnIhpaZuMfGSKdSefcDzOWCgJuGeHGA5hFkcflhAXhBrx",
        "client_name":"Jacob Williams",
        "client_os":"",
        "client_preview_url":""
    }
}

Данные ответа:

Название Тип Описание
id number Внутри-системный идентификатор подключения
status number Статус подключения. Возможные значения:
  • 0 - Новое подключение, ожидается присоединение клиента
  • 1 - Клиент подключился, ожидается присоединение оператора
  • 2 - Активное подключение, все участники присоединились
  • 3 - Закрытое подключения
create_time unixtime Дата и время создания подключения
invite_code string Код для приглашения
invite_url string URL-адрес для приглашения
connect_url string URL-адрес для присоединения оператора к подключению
client_name string Имя клиента
client_os string Операционная система. Возможные значения: win, mac, linux и android

ℹ Поле заполняется после присоединения клиента
client_preview_url string Миниатюра изображения рабочего стола клиента

ℹ Поле заполняется после присоединения клиента

Информация о подключении

Чтобы получить информацию о конкретном подключении воспользуйтесь методом support/info

Запрос:

GET https://api.pro32connect.ru/v1/support/info
  ?apikey=<string>
  &connection_id=<number>

Параметры запроса:

Параметр Тип Значение
apikey string API-ключ для авторизации запроса
connection_id number* Внутри-системный идентификатор подключения

Ответ:

{
    "data":{
        "id":328,
        "status":2,
        "create_time":1600262268,
        "invite_code":"408080316",
        "invite_url":"https://go.pro32connect.ru/invite/408080316",
        "connect_url":"https://go.pro32connect.ru/turbo/nrhaStVwQSQ1J4DW0cL4wc1ADUeyug8BZjFaCgEqT4wuFXSPXQrGoRRBUxK1uFTU1Sr7bYlsviZ0djTophpmnIhpaZuMfGSKdSefcDzOWCgJuGeHGA5hFkcflhAXhBrx",
        "client_name":"Jacob Williams",
        "client_os":"win",
        "client_preview_url":"https://pro32connect.ru/preview/f90d07668bccd418a5a8922f2ee455f1eb004c2bbeb5f9fe05ed6970c3389114Zl5PgknTWlU0fWBe4b9YoHNvRlD5Iwl5.png"
    }
}

Данные ответа:

Название Тип Описание
id number Внутри-системный идентификатор подключения
status number Статус подключения. Возможные значения:
  • 0 - Новое подключение, ожидается присоединение клиента
  • 1 - Клиент подключился, ожидается присоединение оператора
  • 2 - Активное подключение, все участники присоединились
  • 3 - Закрытое подключения
create_time unixtime Дата и время создания подключения
invite_code string Код для приглашения
invite_url string URL-адрес для приглашения
connect_url string URL-адрес для присоединения оператора к подключению
client_name string Имя клиента
client_os string Операционная система. Возможные значения: win, mac, linux и android

ℹ Поле заполняется после присоединения клиента
client_preview_url string Миниатюра изображения рабочего стола клиента

ℹ Поле заполняется после присоединения клиента

Закрыть подключение

Чтобы закрыть подключение используйте метод support/close

Запрос:

POST https://api.pro32connect.ru/v1/support/close
  ?apikey=<string>
  &connection_id=<number>

Параметры запроса:

Параметр Тип Значение
apikey string API-ключ для авторизации запроса
connection_id number* Внутри-системный идентификатор подключения

Ответ:

Ответ придет с пустым содержимым. Для анализа выполнения команды используйте только HTTP-код ответа.

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

Получить список подключений

Чтобы получить список ваших подключений используйте метод history/list

Запрос:

GET https://api.pro32connect.ru/v1/history/list
  ?apikey=<string>
  &agent_id=<number>
  &support_id=<number>
  &date_from=<unixtime>
  &date_to=<unixtime>
  &video=<boolean>
  &offset=<number>
  &limit=<number>

Параметры запроса:

Параметр Тип Значение
apikey string API-ключ для авторизации запроса
agent_id string Фильтр по идентификатору агента
support_id number Фильтр по идентификатору подключения из Быстрой Поддержки
date_from unixtime Фильтр по дате и времени - начало периода
date_to unixtime Фильтр по дате и времени - конец периода
video boolean Фильтр по наличию видео-записи
offset number Отступ первой позиции в списке
limit number Количество позиций в списке. По умолчанию - 20, максимальное значение - 100

Ответ:

{
    "offset": 0,
    "limit": 10,
    "total": 15,
    "filter": {
        "date_from": 1608660281,
        "date_to": 1608660389,
        "agent_id": 1001,
        "support_id": 1002,
        "video": true
    },
    "data": [ {
        "id": 27233,
        "start": 1608660273,
        "stop": 1608660281,
        "support_id": 1002,
        "clients": [ {
            "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.88 Safari/537.36",
            "login": "john.smith@gmail.com",
            "geo": {
                "ip": "2.21.31.68",
                "country": "USA",
                "region": "California",
                "city": "Los Angeles"
            }
        } ],
        "agent": {
            "id": 1001,
            "name": "DESKTOP-SJBU5PO",
            "group": "Accounting",
            "geo": {
                "ip": "2.21.31.68",
                "country": "USA",
                "region": "California",
                "city": "Los Angeles"
            },
            "os": "win",
            "version": "2.1.5",
            "owner": "john.smith@gmail.com"
        },
        "video": {
            "url": "https://st1.pro32connect.ru/video/2/27233.mp4",
            "size": 428652
        }
    }, ... ]
}

Данные ответа:

Название Тип Описание
id number Внутри-системный идентификатор подключения
start unixtime Дата и время начала подключения
stop unixtime Дата и время конца подключения

ℹ Может быть пустым, если подключение не завершено
support_id number Идентификатор подключения из Быстрой Поддержки

ℹ Поле может быть пустым, если соединение было с устройством из Постоянного Доступа
clients array Список клиентов, которые присоединялись к подключению
clients[].user_agent string Юзер-агент
clients[].login string Логин пользователя

ℹ Может быть пустым, если подключение было анонимным
clients[].geo object Гео-расположение
clients[].geo.ip string IP-адрес
clients[].geo.country string Страна
clients[].geo.region string Регион
clients[].geo.city string Город
agent object Информация об агенте
agent.id number Внутрисистемный идентификатор агента
agent.name string Название
agent.group string Группа
agent.geo object Гео-расположение
agent.geo.ip string IP-адрес
agent.geo.country string Страна
agent.geo.region string Регион
agent.geo.city string Город
agent.os string Операционная система. Возможные значения: win, mac, android и linux
agent.version string Версия программы
agent.owner string Логин учетной записи владельца постоянного доступа
video object Информация о видео-записи

ℹ Может отсутствовать, если видео-записи подключения не было
video.url string Адрес для загрузки видео-файла записи

⚠ Чтобы загрузить видео-файл записи подключения необходимо добавить параметр ?apikey= со значением вашего API-ключа.
video.size number Размер видео-файла записи в байтах

Последнее обновление: 16 ноября 2023 г.