fileRequestStatusChanged

TrueConfAbout 2 min

fileRequestStatusChanged

Description: Notification showing the file task progress. v4.1.0+

Example:

{
    "method": "event",
    "event": "fileRequestStatusChanged",
    "fileRequestId": "6c0e20a7-3c79-470d-869b-7c8287587620",
    "status": 2,
    "directionType": 0,
    "fileName": "2.jpg",
    "timestamp": 1659284222850,
    "fileSize": 3200,
    "peerId": "820_1@some.server",
    "peerDisplayName": "820_1"
}

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 — File name

  • fileId - a unique file identifier on the built-in HTTP server. It is present for outgoing requests and completed incoming ones.

  • peerId is a field representing the unique user identifier TrueConf ID. It is present for all incoming files. For outgoing files, it is absent if the request was for a group conference.

  • peerDisplayName — the display name of a user. This field is included for all inbound files. In case of an outbound file, the field is not included if the request was made to a group conference.

  • timestamp — the time when the 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

See also: