Reference
transfer_file
Stream a protected file over the WebSocket session.
transfer_file
Start streaming a protected file over the current WebSocket session.
- Type:
8 - Requires initialization: yes
- Requires authorization: yes
Example packets
transfer_file
Start streaming a protected file over the same WebSocket session.
Streaming behavior
transfer_file is a streaming operation. It can emit many response messages for a single request id.
Each chunk is delivered as:
- A JSON header (
TransferFileResponse) - A binary WebSocket frame with exactly
chunk_sizebytes
If chunk_size is 0, there is no binary frame for that message.
Full streaming rules:
Common terminal statuses
| Status | Meaning |
|---|---|
1 | ok (end of stream) |
3 | not_authorized |
300 | file_not_found |
304 | file_storage_quota_exceeded |
305 | file_invalid_name |
308 | file_transfer_stopped |
6 | internal_server_error |