SimTX API/Moderation session - Revision history

Clanker: Remove development history and server internals

2026-10-24T17:14:25Z

Remove development history and server internals

← Older revision		Revision as of 17:14, 24 October 2026
Line 1:		Line 1:
	{{SimTX API navigation}}		{{SimTX API navigation}}
	A '''moderation session''' (<code>ROLE_MODERATION</code>) gives SimTX moderators tools to see who is on a server and to remove disruptive sessions~~. It is documented for completeness, so that every frame in the [[SimTX API/Packet list\|packet list]] is explained~~. '''Third-party software cannot use it''' without an account holding the <code>moderation.manage</code> [[SimTX API/Permissions\|permission]], and the account service will not issue a <code>moderation</code> [[SimTX API/Game tickets\|ticket]] otherwise.		A '''moderation session''' (<code>ROLE_MODERATION</code>) gives SimTX moderators tools to see who is on a server and to remove disruptive sessions. '''Third-party software cannot use it''' without an account holding the <code>moderation.manage</code> [[SimTX API/Permissions\|permission]], and the account service will not issue a <code>moderation</code> [[SimTX API/Game tickets\|ticket]] otherwise.

	== Permissions within the session ==		== Permissions within the session ==
	~~The server checks two grants for each~~ request:		Each request needs a permission:
	* ~~'''MODERATE''', from~~ <code>moderation.manage</code>: listing stations with addresses, kicking, IP bans and banners.		* <code>moderation.manage</code>: listing stations with addresses, kicking, IP bans and banners.
	* ~~'''MONITOR''', from~~ <code>monitor.any</code>: monitoring any transmitter.		* <code>monitor.any</code>: monitoring any transmitter.

	A request without the matching ~~grant~~ is answered with [[SimTX API/Packets/Error\|Error]] <code>FORBIDDEN</code> and the request's <code>request_id</code>; the session stays open.		A request without the matching permission is answered with [[SimTX API/Packets/Error\|Error]] <code>FORBIDDEN</code> and the request's <code>request_id</code>; the session stays open.

	== Requests ==		== Requests ==
	{\| class="wikitable"		{\| class="wikitable"
	! Request (C2S) !! Response (S2C) !! ~~Grant~~ !! Purpose		! Request (C2S) !! Response (S2C) !! Permission !! Purpose
	\|-		\|-
	\| [[SimTX API/Packets/ListStations\|ListStations]] (30) \|\| [[SimTX API/Packets/StationList\|StationList]] (30), then [[SimTX API/Packets/StationImpactList\|StationImpactList]] (63) \|\| ~~MODERATE~~ \|\| Stations including client addresses, followed by an interference analysis.		\| [[SimTX API/Packets/ListStations\|ListStations]] (30) \|\| [[SimTX API/Packets/StationList\|StationList]] (30), then [[SimTX API/Packets/StationImpactList\|StationImpactList]] (63) \|\| <code>moderation.manage</code> \|\| Stations including client addresses, followed by an interference analysis.
	\|-		\|-
	\| [[SimTX API/Packets/KickRequest\|KickRequest]] (60) \|\| [[SimTX API/Packets/KickResult\|KickResult]] (60) \|\| ~~MODERATE~~ \|\| Disconnect sessions by callsign or session id.		\| [[SimTX API/Packets/KickRequest\|KickRequest]] (60) \|\| [[SimTX API/Packets/KickResult\|KickResult]] (60) \|\| <code>moderation.manage</code> \|\| Disconnect sessions by callsign or session id.
	\|-		\|-
	\| [[SimTX API/Packets/IpModerationRequest\|IpModerationRequest]] (61) \|\| [[SimTX API/Packets/IpModerationResult\|IpModerationResult]] (61) \|\| ~~MODERATE~~ \|\| Ban or unban an address.		\| [[SimTX API/Packets/IpModerationRequest\|IpModerationRequest]] (61) \|\| [[SimTX API/Packets/IpModerationResult\|IpModerationResult]] (61) \|\| <code>moderation.manage</code> \|\| Ban or unban an address.
	\|-		\|-
	\| [[SimTX API/Packets/BroadcastBanner\|BroadcastBanner]] (62) \|\| None \|\| ~~MODERATE~~ \|\| Show, replace or clear the server notice.		\| [[SimTX API/Packets/BroadcastBanner\|BroadcastBanner]] (62) \|\| None \|\| <code>moderation.manage</code> \|\| Show, replace or clear the server notice.
	\|-		\|-
	\| [[SimTX API/Packets/StartMonitor\|StartMonitor]] (31), [[SimTX API/Packets/StopMonitor\|StopMonitor]] (32) \|\| [[SimTX API/Packets/MonitorAck\|MonitorAck]] (42), [[SimTX API/Packets/MonitorBlock\|MonitorBlock]] (31), [[SimTX API/Packets/MonitorEnd\|MonitorEnd]] (32) \|\| ~~MONITOR~~ \|\| Listen to any transmitter.		\| [[SimTX API/Packets/StartMonitor\|StartMonitor]] (31), [[SimTX API/Packets/StopMonitor\|StopMonitor]] (32) \|\| [[SimTX API/Packets/MonitorAck\|MonitorAck]] (42), [[SimTX API/Packets/MonitorBlock\|MonitorBlock]] (31), [[SimTX API/Packets/MonitorEnd\|MonitorEnd]] (32) \|\| <code>monitor.any</code> \|\| Listen to any transmitter.
	\|}		\|}

	Failures are reported with [[SimTX API/Packets/Error\|Error]] and the request's <code>request_id</code>~~; v24's ModerationError is gone. Through the public gateway, moderation requests are fanned out to every server node and the answers merged~~.		Failures are reported with [[SimTX API/Packets/Error\|Error]] and the request's <code>request_id</code>.

	== Effects of a kick ==		== Effects of a kick ==
Line 30:		Line 30:

	== Effects of a ban ==		== Effects of a ban ==
	When an address is banned, the server ends its receiver and transmitter sessions. Its control sessions stay connected and receive a [[SimTX API/Packets/Banner\|Banner]] with level <code>BANNER_LEVEL_BAN_NOTICE</code> and the reason~~, so that the user's application can explain what happened~~. New game connections from the address are refused with <code>HELLO_STATUS_IP_BANNED</code>.		When an address is banned, the server ends its receiver and transmitter sessions. Its control sessions stay connected and receive a [[SimTX API/Packets/Banner\|Banner]] with level <code>BANNER_LEVEL_BAN_NOTICE</code> and the reason. New game connections from the address are refused with <code>HELLO_STATUS_IP_BANNED</code>.

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

Clanker: Protocol v25 reference

2026-10-24T16:39:17Z

Protocol v25 reference

← Older revision		Revision as of 16:39, 24 October 2026
Line 1:		Line 1:
	~~#REDIRECT~~ [[SimTX API v24/~~Moderation session~~]]		{{SimTX API navigation}}
			A '''moderation session''' (<code>ROLE_MODERATION</code>) gives SimTX moderators tools to see who is on a server and to remove disruptive sessions. It is documented for completeness, so that every frame in the [[SimTX API/Packet list\|packet list]] is explained. '''Third-party software cannot use it''' without an account holding the <code>moderation.manage</code> [[SimTX API/Permissions\|permission]], and the account service will not issue a <code>moderation</code> [[SimTX API/Game tickets\|ticket]] otherwise.

			== Permissions within the session ==
			The server checks two grants for each request:
			* '''MODERATE''', from <code>moderation.manage</code>: listing stations with addresses, kicking, IP bans and banners.
			* '''MONITOR''', from <code>monitor.any</code>: monitoring any transmitter.

			A request without the matching grant is answered with [[SimTX API/Packets/Error\|Error]] <code>FORBIDDEN</code> and the request's <code>request_id</code>; the session stays open.

			== Requests ==
			{\| class="wikitable"
			! Request (C2S) !! Response (S2C) !! Grant !! Purpose
			\|-
			\| [[SimTX API/Packets/ListStations\|ListStations]] (30) \|\| [[SimTX API/Packets/StationList\|StationList]] (30), then [[SimTX API/Packets/StationImpactList\|StationImpactList]] (63) \|\| MODERATE \|\| Stations including client addresses, followed by an interference analysis.
			\|-
			\| [[SimTX API/Packets/KickRequest\|KickRequest]] (60) \|\| [[SimTX API/Packets/KickResult\|KickResult]] (60) \|\| MODERATE \|\| Disconnect sessions by callsign or session id.
			\|-
			\| [[SimTX API/Packets/IpModerationRequest\|IpModerationRequest]] (61) \|\| [[SimTX API/Packets/IpModerationResult\|IpModerationResult]] (61) \|\| MODERATE \|\| Ban or unban an address.
			\|-
			\| [[SimTX API/Packets/BroadcastBanner\|BroadcastBanner]] (62) \|\| None \|\| MODERATE \|\| Show, replace or clear the server notice.
			\|-
			\| [[SimTX API/Packets/StartMonitor\|StartMonitor]] (31), [[SimTX API/Packets/StopMonitor\|StopMonitor]] (32) \|\| [[SimTX API/Packets/MonitorAck\|MonitorAck]] (42), [[SimTX API/Packets/MonitorBlock\|MonitorBlock]] (31), [[SimTX API/Packets/MonitorEnd\|MonitorEnd]] (32) \|\| MONITOR \|\| Listen to any transmitter.
			\|}

			Failures are reported with [[SimTX API/Packets/Error\|Error]] and the request's <code>request_id</code>; v24's ModerationError is gone. Through the public gateway, moderation requests are fanned out to every server node and the answers merged.

			== Effects of a kick ==
			Kicked receivers and transmitters get [[SimTX API/Packets/SessionStatus\|SessionStatus]] <code>ENDED</code> with the moderator's reason, and their connections close.

			== Effects of a ban ==
			When an address is banned, the server ends its receiver and transmitter sessions. Its control sessions stay connected and receive a [[SimTX API/Packets/Banner\|Banner]] with level <code>BANNER_LEVEL_BAN_NOTICE</code> and the reason, so that the user's application can explain what happened. New game connections from the address are refused with <code>HELLO_STATUS_IP_BANNED</code>.

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

Clanker: Clanker moved page SimTX API/Moderation session to SimTX API v24/Moderation session: Archive the v24 protocol reference

2026-10-24T16:12:53Z

Clanker moved page SimTX API/Moderation session to SimTX API v24/Moderation session: Archive the v24 protocol reference

New page

#REDIRECT [[SimTX API v24/Moderation session]]