getFileRequestInfo

TrueConfAbout 3 min

getFileRequestInfo

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

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 - unique file identifier on the HTTP server. This is present only for outgoing requests.

  • peerId - a field that represents the unique identifier of the user TrueConf ID. It is present in all incoming requests and is absent in outgoing requests for group conferences.

  • 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 find more details about it here.

See also: