Jump to content

SimTX API v24/Packets/KickRequest: Difference between revisions

From SimTX Wiki
VisualWikitext
Clanker (talk | contribs)
660 edits
SimTX API documentation
 
Clanker (talk | contribs)
660 edits
Archive the v24 protocol reference: use the v24 templates, links and categories
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{SimTX API navigation}}
{{SimTX API v24 navigation}}
{{SimTX packet
{{SimTX packet v24
| name = KickRequest
| name = KickRequest
| id = 5
| id = 5
| hex = 0x05
| hex = 0x05
| direction = c2s
| direction = c2s
| session = [[SimTX API/Moderation session|Moderation]]
| session = [[SimTX API v24/Moderation session|Moderation]]
| size = Variable
| size = Variable
| permission = <code>moderation.manage</code>
| permission = <code>moderation.manage</code>
| reply = [[SimTX API/Packets/KickResult|KickResult]]
| reply = [[SimTX API v24/Packets/KickResult|KickResult]]
| group = moderation
| group = moderation
}}
}}
'''KickRequest''' disconnects stations from the server. It is only accepted on a [[SimTX API/Moderation session|moderation session]].
'''KickRequest''' disconnects stations from the server. It is only accepted on a [[SimTX API v24/Moderation session|moderation session]].


== Layout ==
== Layout ==
Line 21: Line 21:
| <code>target</code> || <code>UTF</code> || A station UUID, or a callsign.
| <code>target</code> || <code>UTF</code> || A station UUID, or a callsign.
|-
|-
| <code>reason</code> || <code>UTF</code> || Reason shown to the kicked transmitter in [[SimTX API/Packets/TxKick|TxKick]]. May be empty.
| <code>reason</code> || <code>UTF</code> || Reason shown to the kicked transmitter in [[SimTX API v24/Packets/TxKick|TxKick]]. May be empty.
|-
|-
| <code>byCallsign</code> || <code>bool</code> || True: kick every station with that callsign. False: kick the station with that UUID.
| <code>byCallsign</code> || <code>bool</code> || True: kick every station with that callsign. False: kick the station with that UUID.
|}
|}


{{SimTX API navbox}}
{{SimTX API v24 navbox}}
[[Category:SimTX API]]
[[Category:SimTX API v24]]

Latest revision as of 16:16, 24 October 2026

This page documents protocol v24, which current servers no longer accept. See SimTX API for v25.
v24 overviewQuick startAccount serviceHandshakeAll packetsData typesLimits and errorsCurrent reference (v25)
KickRequest
Packet ID 5(0x05)
Direction Client → server
Session Moderation
Body size Variable
Permission moderation.manage
Answered by KickResult
Answers

KickRequest disconnects stations from the server. It is only accepted on a moderation session.

Layout[edit | edit source]

Field Type Description
packetId u8 Always 5.
target UTF A station UUID, or a callsign.
reason UTF Reason shown to the kicked transmitter in TxKick. May be empty.
byCallsign bool True: kick every station with that callsign. False: kick the station with that UUID.
SimTX API v24 reference (protocol v24, archived)
Start OverviewQuick startData typesLimits and errorsPacket list
Account service OverviewDevice loginServer directoryGame ticketsPermissionsPublic endpoints
Game protocol Connection and handshakeReceiver sessionTransmitter sessionControl sessionCatalogModeration
Handshake HandshakeHandshakeResult
Receiver ReceiverSessionRequestReceiverRetuneForwardedClientAddressIqStreamDescriptorIqBlockTimedIqBlock
Transmitter TransmitterSessionRequestSampleBlockTxModeInfoTxUpdateTxQueueTxAcceptTxRejectTxKickTxTelemetryTxUpdateAck
Control ControlAckBannerListStationsStationListServerHealthRequestServerHealthReportCoverageMapRequestCoverageMapResponseWeatherMapRequestWeatherMapResponseStartMonitorStopMonitorMonitorBlockMonitorEnd
Catalog CatalogListRequestCatalogListCatalogFetchCatalogEntryCatalogUploadCatalogUploadResultCatalogDeleteCatalogDeleteResult
Moderation KickRequestKickResultIpModerationRequestIpModerationResultBroadcastBannerModerationErrorStationImpactList
Current Protocol v25 reference
Retrieved from "https://wiki.simtx.net/index.php?title=SimTX_API_v24/Packets/KickRequest&oldid=2187"