POST /SendPlayerMessage

Endpunkt: POST /v1/pdapi/SendPlayerMessage

Auth: Bearer-Token

Berechtigung: REST.Messages.Send.PlayerChat
REST.Messages.Send.GlobalChat
REST.Messages.Send.GuildChat
REST.Messages.Send.Log.Normal
REST.Messages.Send.Log.Important
REST.Messages.Send.Log.VeryImportant

Zweck

Sendet eine Nachricht an einen oder mehrere Zielspieler.

Pfadparameter

Keine.

Query-Parameter

Keine.

Request-Body

JSON-Objekt mit SendType, Message und entweder UserID oder UserIDs. Gängige SendType-Werte sind PlayerChat, PlayerGlobalChat, PlayerGuildChat, PlayerLogNormal, PlayerLogImportant und PlayerLogVeryImportant.

Antwortschema

Schema der 200-Antwort

Feld	Typ	Beschreibung
`Success`	boolean	`true`, wenn die Nachricht gesendet wurde.
`SentCount`	integer	Anzahl der Zielspieler, die die Nachricht erhalten haben.

Fehlerantworten

Fehlerantworten verwenden dieses Format:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Für Menschen lesbare Nachricht",
        "Details": {}
    }
}

HTTP	Fehlercode	Wann es passiert
`401`	`INVALID_TOKEN`	Der `Authorization`-Header fehlt, ist fehlerhaft oder passt zu keinem konfigurierten Bearer-Token.
`403`	`MISSING_PERMISSION`	Das Token ist gültig, enthält aber nicht die Berechtigung für diesen Endpunkt.
`400`	`EMPTY_BODY`	Der Request-Body ist leer.
`400`	`INVALID_JSON`	Der Request-Body ist kein gültiges JSON.
`400`	`VALIDATION_FAILED`	`SendType`, `Message`, `UserID` oder `UserIDs` fehlt, ist leer, doppelt vorhanden oder hat den falschen Typ.
`400`	`PLAYER_NOT_FOUND`	One or more target user IDs or player UIDs could not be found.
`400`	`SEND_MESSAGE_FAILED`	Die Validierung war erfolgreich, aber der Server lehnte das Senden der Nachricht ab.
`400`	`REQUEST_FAILED`	Der Game-Thread-Callback hat eine Ausnahme ausgelöst.
`500`	`REQUEST_TIMEOUT`	Der interne Game-Thread-Callback wurde nicht innerhalb von 5 Sekunden abgeschlossen.

Beispiele

Spielerchat an einen Benutzer senden

POST /v1/pdapi/SendPlayerMessage

{
    "SendType": "PlayerChat",
    "UserID": "steam_76561198012345678",
    "Message": "Your shop order has arrived."
}

Wichtige Lognachricht an gemischte Ziele senden

POST /v1/pdapi/SendPlayerMessage

{
    "SendType": "PlayerLogImportant",
    "UserIDs": [
        "ps5_0f4b8c2d91aa34ef",
        "6d2e8b40-73ef-4f11-9bb8-2e91a36e2f09",
        "gdk_2533274812345678"
    ],
    "Message": "Das Event startet in 10 Minuten."
}

Szenarien

Sende direkte Neustartwarnungen an ausgewählte Spieler.
Sende Support-Antworten aus einem Admin-Panel.
Nutze UserID für ein Ziel und UserIDs für mehrere Ziele, nicht beides.