Труконф

# getFileRequestInfo

Версия: 4.1.0+

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

Пример запроса:

{
   "method" : "getFileRequestInfo",
   "requestId" : "1",
   "fileRequestId": "f5bd76f9-f0b6-4f36-bbdf-c27c64d29b74"
}

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

{
    "method": "getFileRequestInfo",
    "requestId" : "1",
    "fileRequestId": "f5bd76f9-f0b6-4f36-bbdf-c27c64d29b74",
    "status": 1,
    "directionType": 0,
    "fileName": "4.png",
    "timestamp": 1659254393588,
    "fileSize": 2304,
    "peerId": "820_1@some.server",
    "peerDisplayName": "820_1",
    "result": true
}

Описание параметров:

  • fileRequestId - идентификатор файлового запроса в API

  • status - статус файлового запроса на текущий момент. Может быть:

    • 0 - ошибка обработки во внутренней логике (за деталями можно обратится в логи)

    • 1 - ожидает указаний действий (например отклонение файла, принятие и т.д.)

    • 2 - обработка стартовала, т.е. файл начали скачивать, отгружать на сервер и т.д.

    • 3 - обработка завершена (файл скачался, отгрузился на сервер и т.д.)

  • directionType - флаг, обозначающий направление файла. Может быть

    • 0 - входящий файловый запрос

    • 1 - исходящий файловый запрос

  • fileName - оригинальное имя файла

  • fileId - уникальный идентификатор файла на http сервере. Присутствует только для исходящих запросов

  • peerId - поле, обозначающее уникальный идентификатор пользователя TrueConf ID. Присутствует во всех входящих запросах. В исходящих отсутствует для групповой конференции

  • peerDisplayName - отображаемое имя пользователя. Присутствует во всех входящих запросах. В исходящих отсутствует для групповой конференции

  • timestamp - таймстамп создания файлового запроса

  • confId - идентификатор групповой конференции, в рамках которой был осуществлен файловый запрос. Поле отсутствует, если запрос был сделан не в рамках конференции

  • fileSize - физический размер файла в байтах

  • processedPercents - количество обработанных байт файла в процентах. Поле присутствует только если запрос начал обрабатываться

  • requestId - уникальный идентификатор запроса. Детальнее с ним можно ознакомиться здесь

См. также: