Content Library Item Downloadsession File Info

Content Library Item Downloadsession File Info
Content Library Item Downloadsession File Info

The Content Library Item Downloadsession File Info schema defines the downloaded file.

JSON Example
{
    "name": "string",
    "size": 0,
    "bytes_transferred": 0,
    "status": "string",
    "download_endpoint": {
        "uri": "string",
        "ssl_certificate_thumbprint": "string",
        "ssl_certificate": "string"
    },
    "checksum_info": {
        "algorithm": "string",
        "checksum": "string"
    },
    "error_message": {
        "id": "string",
        "default_message": "string",
        "args": [
            "string"
        ],
        "params": {
            "params": {
                "s": "string",
                "dt": "string",
                "i": 0,
                "d": "number",
                "l": "Vapi Std NestedLocalizableMessage Object",
                "format": "string",
                "precision": 0
            }
        },
        "localized": "string"
    }
}
string
name
Required

The name of the file.

integer As int64 As int64
size
Optional

The file size, in bytes.

This property may not be available immediately. It is guaranteed to be set when the client finishes downloading the file.

integer As int64 As int64
bytes_transferred
Required

The number of bytes that have been transferred by the server so far for making this file prepared for download. This value may stay at zero till the client starts downloading the file.

string
status
Required

The preparation status (PrepareStatus) of the file.

For more information see: Content Library Item Downloadsession File PrepareStatus.

download_endpoint
Optional

Endpoint at which the file is available for download. The value is valid only when the Content Library Item Downloadsession File Info.status is Content Library Item Downloadsession File PrepareStatus.PREPARED.

This property won't be set until the file status is Content Library Item Downloadsession File PrepareStatus.PREPARED.

checksum_info
Optional

The checksum information of the file. When the download is complete, you can retrieve the checksum from the GET /content/library/item/download-session/{downloadSessionId}/file?file_name operation to verify the checksum for the downloaded file.

The checksum is always calculated for the downloaded file, but this property won't be set until the download is complete.

error_message
Optional

Error message for a failed preparation when the prepare status is Content Library Item Downloadsession File PrepareStatus.ERROR.

This property won't be set unless there was an error with the file transfer.

Returned By