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

На этой странице приведены описания методов API, предназначенных для работы с приглашениями из раздела Быстрая поддержка.

Список приглашений¶

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

Запрос:

HTTPcURL

GET /v1/support/list
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl "https://api.pro32connect.ru/v1/support/list" \
  -H "X-Api-Key: YOUR_API_KEY"

Параметры отсутствуют.

Ответ:

Пример ответа

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

{
    "remain":100,
    "data":[ {
        "id":328,
        "status":0,
        "create_time":1600262268,
        "invite_code":"408080316",
        "invite_url":"https://https://go.pro32connect.ru/invite/408080316",
        "connect_url":"https://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/info.

Запрос:

HTTPcURL

GET /v1/support/info
  ?connection_id=<number>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -G "https://api.pro32connect.ru/v1/support/info" \
  --data-urlencode "connection_id=<number>" \
  -H "X-Api-Key: YOUR_API_KEY" \

Параметр	Тип	Значение
`connection_id`	`number`	Внутренний ID приглашения в системе

Ответ:

Пример ответа

```json title="Данные ответа" { "data":{ "id":328, "status":2, "create_time":1600262268, "invite_code":"408080316", "invite_url":"https://https://go.pro32connect.ru/invite/408080316", "connect_url":"https://https://go.pro32connect.ru/turbo/nrhaStVwQSQ1J4DW0cL4wc1ADUeyug8BZjFaCgEqT4wuFXSPXQrGoRRBUxK1uFTU1Sr7bYlsviZ0djTophpmnIhpaZuMfGSKdSefcDzOWCgJuGeHGA5hFkcflhAXhBrx", "client_name":"Jacob Williams", "client_os":"win", "client_preview_url":"https://pro32connect.ru/preview/f90d07668bccd418a5a8_

Название	Тип	Значение
`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/create.

Запрос:

HTTPcURL

POST /v1/support/create
  ?client_name=<string>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -X POST -G "https://api.pro32connect.ru/v1/support/create" \
  --data-urlencode "client_name=<string>" \
  -H "X-Api-Key: YOUR_API_KEY"

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

Ответ:

Пример ответа

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

{
    "data":{
        "id":328,
        "status":0,
        "create_time":1600262268,
        "invite_code":"408080316",
        "invite_url":"https://https://go.pro32connect.ru/invite/408080316",
        "connect_url":"https://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/update.

Необязательные поля

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

Запрос:

HTTPcURL

POST /v1/agents/update
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

{
  "connection_id": <number>,
  "name": <string>
}

curl -X POST "https://api.pro32connect.ru/v1/agents/update" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{
    "connection_id": <number>,
    "name": <string>
  }'

Parameter	Type	Value
`connection_id`	`number`	Internal system invitation ID
`name`	`string`	Customer Name

Example Response

Response Data

{
    "status": 0,
}

Name	Type	Description
`number`	`status`	Result status. Possible values: `0` - Update completed successfully `4` - Internal server error

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

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

Срок действия ссылки

Ссылка становится недействительной сразу после первого использования. Необходимо получать новую ссылку каждый раз при подключении.

Запрос:

HTTPcURL

POST /v1/support/connect
  ?connection_id=<number>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -X POST "https://api.pro32connect.ru/v1/agents/connect?connection_id=<number>" \
  -H "X-Api-Key: YOUR_API_KEY"

Параметр	Тип	Значение
`connection_id`	`number`	Внутренний идентификатор приглашения в системе
`video`	`bool`	Ручное управление включением/отключением записи видео (необязательно)

Ответ:

Пример ответа

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

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

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

Добавьте кнопку подключения в вашу панель управления

Узнайте, как интегрировать ссылку для подключения в вашу систему, в руководстве Интеграция удалённого доступа в вашу систему.

Закрыть приглашение¶

Чтобы закрыть приглашение, используйте метод support/close.

Запрос:

HTTPcURL

POST /v1/support/close
  ?connection_id=<number>
Host: https://api.pro32connect.ru
X-Api-Key: YOUR_API_KEY

curl -X POST -G "https://api.pro32connect.ru/v1/support/close" \
  --data-urlencode "connection_id=<number>" \
  -H "X-Api-Key: YOUR_API_KEY"

Параметр	Тип	Значение
`connection_id`	`number`	Внутренний ID приглашения в системе

Ответ:

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