Protocol
Usecase types
Numeric operation identifiers used in the WebSocket protocol.
Usecase types
Every request includes a numeric type field (see Message format).
| Type | Name | Description |
|---|---|---|
| 0 | ping | Measure connection RTT and check that the session is alive. |
| 1 | initialize | Bind the session to an application using socket_api_key and client_id. |
| 2 | create_account | Create a new application account (login/password or email/password). |
| 3 | auth_by_license | Authorize the session using a license key. |
| 4 | auth_by_credentials | Authorize the session using login/password (optionally also activating a license). |
| 5 | link_license_to_account | Link a license key to the currently authorized account and activate it. |
| 6 | logout | Drop the current authorization state. |
| 7 | blacklist | Blacklist the current client id and optionally the current license/account. |
| 8 | transfer_file | Start a protected file stream. |
| 9 | stop_file_transfer | Stop an active file stream (optionally issuing a resume token). |
| 10 | resume_file_transfer | Resume a file stream using a resume token. |
| 11 | get_file_metadata | Get file size/checksum and transfer statistics. |
| 12 | get_online_users_count | Get currently connected sessions count for the application. |
| 13 | get_variable | Read an application variable (optionally requiring authorization). |
| 14 | set_session_value | Store a key/value inside the current session with TTL. |
| 15 | get_session_value | Read a key/value from the current session. |
| 16 | get_current_license | Read the currently authorized license (license auth only). |
| 17 | get_current_account | Read the currently authorized account (credentials auth only). |
| 18 | panel_event_subscribe | Reserved for panel event subscription (currently a no-op). |
You can find full request/response schemas in the API reference.