TrueConf

# getOutgoingFilesRequests

Version: 4.1.0+

Description: get a list of outgoing files.

Request example:

{
    "method": "getOutgoingFilesRequests",
    "requestId" : "1"
}

Response example:

{
    "method": "getOutgoingFilesRequests",
    "requestId" : "1",
    "outgoingFilesRequests": [
        {
            "fileRequestId": "0d99602a-82a7-4aea-9a1d-f0b612bab793",
            "fileName": "2.jpg",
            "status": 2,
            "size": 3200,
            "timestamp": 1659251271,
            "peerId": "820_1@some.server",
            "peerDn": "820_1",
            "fileId": 346234218
        },
        {
            "fileRequestId": "d6ee6bd5-70a2-4833-805d-cbded201c0c9",
            "fileName": "2.jpg",
            "status": 2,
            "size": 3200,
            "timestamp": 1659251384,
            "confId": "000001703e81e38e@some.server#vcs",
            "fileId": 346234218
        }
    ],
    "result": true
}

Parameter description:

  • outgoingFilesRequests — the list of files

  • fileRequestId — the unique identifier of a request

  • peerId — the unique identifier (TrueConf ID) of a user. The field is not included for the files sent to a group conference.

  • peerDn — the user's display name. The field is not included for the files sent to a group conference.

  • fileName — File name

  • size — File size in bytes.

  • fileId - unique file identifier on the built-in HTTP server

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

  • outgoingFilesRequests — an array of file requests

  • confId — the communication session identifier. The parameter is available only for the files sent in a group conference.

  • status — the status of a file request. The following statuses are possible:

    • 0 — Internal failure

    • 1 — waiting for a reply to the request

    • 2 — the request has been accepted; the file is being downloaded

    • 3 — the request has been processed

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

See also: