POST /Alert
Конечная точка: POST /v1/pdapi/Alert
Аутентификация: Токен носителя
Разрешение: REST.Messages.Alert
Цель
Отправляет предупреждающее сообщение на сервер.
Параметры пути
Нет.
Параметры запроса
Нет.
Тело запроса
JSON object с Message string.
Схема ответа
200 response schema
| Field | Type | Description |
|---|---|---|
Success |
boolean | true when the alert was broadcast. |
Реакции на ошибки
Тела ошибок используют следующую форму:
| HTTP | Код ошибки | Когда это произойдет |
|---|---|---|
401 |
INVALID_TOKEN |
Заголовок Authorization отсутствует, имеет неправильный формат или не соответствует настроенному токену носителя. |
403 |
MISSING_PERMISSION |
Токен действителен, но не включает это разрешение конечной точки. |
400 |
INVALID_JSON |
Текст запроса был предоставлен, но его не удалось проанализировать как JSON. |
400 |
REQUEST_FAILED |
Обратный вызов игрового потока вызвал исключение, или произошел сбой общего преобразователя player/resource. |
500 |
REQUEST_TIMEOUT |
Обратный вызов внутреннего игрового потока не завершился в течение 5 секунд. |
400 |
VALIDATION_FAILED |
Message отсутствует, пуст или не является string. |
400 |
BROADCAST_ALERT_FAILED |
Серверу не удалось отправить предупреждающее сообщение. |
Примеры
Отправить оповещение о перезапуске
Отправить многострочное оповещение
Сценарии
- Отправлять высокоприоритетные предупреждения сервера.
- Используйте после трансляции, когда игрокам нужно последнее срочное уведомление.
- Делайте оповещения короткими, чтобы их можно было прочитать в игре.