콘텐츠로 이동

POST /Alert

엔드포인트: POST /v1/pdapi/Alert

인증: Bearer 토큰

필요 권한: REST.Messages.Alert

용도

서버에 알림 메시지를 전송합니다.

경로 매개변수

없습니다.

쿼리 매개변수

없습니다.

요청 본문

문자열 Message를 포함하는 JSON 객체입니다.

응답 스키마

200 응답 스키마

필드 자료형 설명
Success 불리언 알림을 전체 전송했으면 true입니다.

오류 응답

오류 응답 본문은 다음 형식을 사용합니다:

{
    "Error": {
        "Code": "ERROR_CODE",
        "Message": "사람이 읽을 수 있는 오류 메시지",
        "Details": {}
    }
}
HTTP 오류 코드 발생 조건
401 INVALID_TOKEN Authorization 헤더가 없거나 형식이 잘못되었거나, 설정된 Bearer 토큰과 일치하지 않습니다.
403 MISSING_PERMISSION 토큰은 유효하지만 이 엔드포인트에 필요한 권한이 없습니다.
400 INVALID_JSON 요청 본문이 있지만 JSON으로 해석할 수 없습니다.
400 REQUEST_FAILED 게임 스레드 콜백에서 예외가 발생했거나 공통 플레이어/리소스 확인 처리에 실패했습니다.
500 REQUEST_TIMEOUT 내부 게임 스레드 콜백이 5초 안에 완료되지 않았습니다.
400 VALIDATION_FAILED Message가 없거나 비어 있거나 문자열이 아닙니다.
400 BROADCAST_ALERT_FAILED 서버에서 알림 메시지를 전송하지 못했습니다.

예제

재시작 알림 전송

POST /v1/pdapi/Alert
{
    "Message": "지금 서버를 재시작합니다."
}

여러 줄 알림 전송

POST /v1/pdapi/Alert
{
    "Message": "5분 후 서버를 재시작합니다.\n거점으로 돌아가 주세요."
}

활용 사례

  • 중요한 서버 경고를 전송합니다.
  • 전체 공지 후 마지막 긴급 안내가 필요할 때 사용합니다.
  • 게임 내에서 읽기 쉽도록 알림을 짧게 작성하세요.