TrueConf

# getFileRequestInfo

Version: 4.1.0+

Description: get information about the current file request: an incoming file and its downloading or an outgoing file and its uploading on the server.

Request example:

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

Response example:

{
    "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
}

Parameter description:

  • fileRequestId — the identifier of a file request directed to the API

  • status— the status of the file request at the current moment. The following values are possible:

    • 0 — internal processing error (check logs for more details)

    • 1 — waiting for instructions (e.g. declining or accepting a file, etc.)

    • 2 — the processing has started, e.g., the file is now being downloaded or uploaded on the server, etc.

    • 3 — the processing is complete (the file has been downloaded or uploaded on the server, etc.)

  • directionType — the flag indicating the direction of a file request. The following values are possible:

    • 0 — an inbound file request

    • 1 — an outbound file request

  • fileName — Original file name.

  • fileId — the unique identifier of a file on the HTTP server. This field is included only for outbound requests.

  • peerId — the field which refers to the unique identifier (TrueConfID) of a user. This field is included for all inbound requests. In case of outbound requests, this field is not included only for a group conference.

  • peerDisplayName — the user’s display name. This field is included for all inbound requests. In case of outbound requests, it is unavailable for a group conference.

  • timestamp — the timestamp indicating when the file request was created

  • confId — the identifier of a group conference in which the file request was created. The field is empty if the request was created outside the conference.

  • fileSize — the physical size of a file measured in bytes

  • processedPercents — the percentage of processed file bytes. This field is included only if the request has started to be processed.

  • requestId - a unique request identifier. You can learn more about it here.

See also: