Перейти к содержанию

POST /kick/{player_identifier}

Конечная точка: POST /v1/pdapi/kick/<player_identifier>

Аутентификация: Токен носителя

Разрешение: REST.Punishments.Kick

Цель

Кикает онлайн-игрока без создания записи о бане.

Параметры пути

  • player_identifier: UserId, PlayerUID или другой поддерживаемый идентификатор игрока.

Параметры запроса

Нет.

Тело запроса

Необязательное поле JSON: Reason string.

Схема ответа

200 response schema

Field Type Description
Success boolean true when the player was kicked.
UserId string User ID that was kicked.

Реакции на ошибки

Тела ошибок используют следующую форму:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "Human-readable message",
        "Details": {}
    }
}
HTTP Код ошибки Когда это произойдет
401 INVALID_TOKEN Заголовок Authorization отсутствует, имеет неправильный формат или не соответствует настроенному токену носителя.
403 MISSING_PERMISSION Токен действителен, но не включает это разрешение конечной точки.
400 INVALID_JSON Текст запроса был предоставлен, но его не удалось проанализировать как JSON.
400 REQUEST_FAILED Обратный вызов игрового потока вызвал исключение, или произошел сбой общего преобразователя player/resource.
500 REQUEST_TIMEOUT Обратный вызов внутреннего игрового потока не завершился в течение 5 секунд.
400 VALIDATION_FAILED Необязательное поле запроса имеет неверный тип JSON.
404 PLAYER_NOT_FOUND Целевой игрок не в сети или не найден.

Примеры

Кикните игрока GDK по причине

POST /v1/pdapi/kick/gdk_2533274812345678

{
    "Reason": "AFK in event area"
}

Кикнуть игрока Steam по причине по умолчанию

POST /v1/pdapi/kick/steam_76561198087654321

{}

Сценарии

  • Удалите игрока перед техническим обслуживанием.
  • Ударьте застрявшего игрока, чтобы он мог восстановить соединение.
  • Вместо этого используйте POST /ban, когда игроку не следует разрешать вернуться.