POST /Broadcast

Конечная точка: POST /v1/pdapi/Broadcast

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

Разрешение: REST.Messages.Broadcast

Цель

Транслирует сообщение чата на сервер.

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

Нет.

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

Нет.

Тело запроса

JSON object с обязательным Message string.

Схема ответа

200 response schema

Field	Type	Description
Success	boolean	true when the chat message was broadcast.

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

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

{
    "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	Message отсутствует, пуст или не является string.

Примеры

Трансляция предупреждения о перезапуске

POST /v1/pdapi/Broadcast

{
    "Message": "Restart in 15 minutes."
}

Сценарии

• Объявите плановое техническое обслуживание.
• Отправляйте автоматические сообщения о начале мероприятия.
• Используйте POST /Alert, если сообщение должно представлять собой предупреждение, а не обычный широковещательный чат.