Skip to content
FlySIPFlySIP Docs

Get the status of an upload

getUploadStatus reports the state of a binary upload started with getUploadToken. Poll it after you send the file; when the status is DONE or FAIL, download the report from url.

The method supports trusted mode with i_customer.

Parameters

Section titled “Parameters”
Name Type Required Description
token string yes Token returned by getUploadToken

Returns

Section titled “Returns”
Name Type Description
result string OK
status string State of the upload; see the table below
process_on string When processing of the file starts
expires_on string When the switch stops trying to process the file
status_changed_on string When status last changed
url string URL of the report. Returned only when the file has been processed
status Meaning
INIT_TOKEN Token issued, the file has not arrived yet
FILE_UPLOADED File received, waiting for process_on
PROCESSING The file is being processed
DONE Every row was processed without errors
FAIL The file could not be parsed, some rows failed, or processing took longer than one day

The report is a text summary of processed, added, updated and deleted rows when the upload succeeds. When rows fail, it is a spreadsheet of the failed rows with an error message for each, as in the panel’s upload report.

Example

Section titled “Example”
request
call("getUploadStatus", {"token": "5f0c2a9e7b1d4c38a6e2f1b0c9d8e7a6"})
response
{
    "result": "OK",
    "status": "DONE",
    "process_on": "20260116T02:00:00",
    "expires_on": "20260116T08:15:00",
    "status_changed_on": "20260116T02:03:41",
    "url": "https://panel.example.com/…",  # report download
}
Section titled “Related”