SimTX API/Packets/KickRequest: Difference between revisions

Latest revision as of 16:58, 24 October 2026

API overviewQuick startHandshakeFramingAll messagesData typesStationsAccount serviceLimits and errorsv24 reference

KickRequest
Frame	`ClientFrame`, field 60
Member	`kick`
Direction	Client → server
Session	Moderation
Roles	`ROLE_MODERATION`.
Permission	`moderation.manage`
Answered by	KickResult or Error
Answers
Defined in	`control.proto`

KickRequest disconnects sessions from the server. The kicked receivers and transmitters get SessionStatus ENDED with the reason.

Definition[edit | edit source]

message KickRequest { int64 request_id = 1; string target = 2; string reason = 3; bool by_callsign = 4; }

Fields[edit | edit source]

#	Field	Type	Description
1	`request_id`	`int64`	Nonzero; echoed in the KickResult or Error.
2	`target`	`string`	A session id in text form, or a callsign.
3	`reason`	`string`	Reason shown to the kicked sessions in their SessionStatus `ENDED`. May be empty.
4	`by_callsign`	`bool`	True: kick every session with that callsign. False: kick the session with that id.

See also[edit | edit source]

SimTX API/Moderation session

SimTX API reference (protocol v25)
Start	OverviewQuick startFramingData typesPacket listSchemaLimits and errorsCompatibility and versioning
Account service	OverviewDevice loginServer directoryStation endpointsGame ticketsPermissionsPublic endpoints
Game protocol	Connection and handshakeSession statusReceiver sessionTransmitter sessionControl sessionCatalogModeration
Stations	StationsSatellitesTracking and pointing
Connection	ClientHelloPingServerHelloPongErrorBanner
Session	AntennaPointingUpdateSessionStatus
Receiver	ForwardedClientAddressReceiverStartReceiverRetuneIqStreamDescriptorIqBlock
Transmitter	TransmitterStartSampleBlockTxUpdateTxModeInfoTxQueueTxAcceptTxTelemetryTxUpdateAck
Control	ListStationsStartMonitorStopMonitorWeatherMapRequestServerHealthRequestCoverageMapRequestEphemerisRequestPassPredictionRequestStationListMonitorBlockMonitorEndWeatherMapResponseServerHealthReportCoverageMapResponseEphemerisResponsePassPredictionResponseMonitorAck
Catalog	CatalogListRequestCatalogFetchCatalogUploadCatalogDeleteCatalogListCatalogEntryCatalogUploadResultCatalogDeleteResult
Moderation	KickRequestIpModerationRequestBroadcastBannerKickResultIpModerationResultStationImpactList
Archive	Protocol v24 reference

@@ Line 1: / Line 1: @@
-#REDIRECT [[SimTX API v24/Packets/KickRequest]]
+{{SimTX API navigation}}
+{{SimTX packet
+| name = KickRequest
+| frame = ClientFrame
+| field = 60
+| member = kick
+| direction = c2s
+| session = [[SimTX API/Moderation session|Moderation]]
+| roles = <code>ROLE_MODERATION</code>.
+| permission = <code>moderation.manage</code>
+| reply = [[SimTX API/Packets/KickResult|KickResult]] or [[SimTX API/Packets/Error|Error]]
+| group = moderation
+| file = control.proto
+}}
+'''KickRequest''' disconnects sessions from the server. The kicked receivers and transmitters get [[SimTX API/Packets/SessionStatus|SessionStatus]] <code>ENDED</code> with the reason.
+== Definition ==
+<syntaxhighlight lang="protobuf">
+message KickRequest { int64 request_id = 1; string target = 2; string reason = 3; bool by_callsign = 4; }
+</syntaxhighlight>
+== Fields ==
+{| class="wikitable"
+! # !! Field !! Type !! Description
+|-
+| 1 || <code>request_id</code> || <code>int64</code> || Nonzero; echoed in the [[SimTX API/Packets/KickResult|KickResult]] or [[SimTX API/Packets/Error|Error]].
+|-
+| 2 || <code>target</code> || <code>string</code> || A session id in text form, or a callsign.
+|-
+| 3 || <code>reason</code> || <code>string</code> || Reason shown to the kicked sessions in their [[SimTX API/Packets/SessionStatus|SessionStatus]] <code>ENDED</code>. May be empty.
+|-
+| 4 || <code>by_callsign</code> || <code>bool</code> || True: kick every session with that callsign. False: kick the session with that id.
+|}
+== See also ==
+* [[SimTX API/Moderation session]]
+{{SimTX API navbox}}
+[[Category:SimTX API]]