6.1 Health Check

1. 요청 가이드

API를 호출할 때 다음 가이드라인을 따르십시오:

기본 요청 구조

GET|POST|PUT|DELETE https://api.msghub.uplus.co.kr/{endpoint}
Authorization: Bearer {your_jwt_token}
Content-Type: application/json

요청 파라미터 엔드포인트에 따라 다음과 같은 방식으로 파라미터를 전달할 수 있습니다:

URL 경로 파라미터
쿼리 파라미터
요청 본문(JSON)

2. 헬스 체크 API

기능 설명 헬스체크(Health Check) API는 메시지허브 서비스와 네트워크가 정상적으로 운영되고 있는지를 주기적으로 확인하기 위한 기능입니다. 이 API를 통해 1분 간격으로 상태를 점검하며, 일정 시간 동안 헬스체크 요청이 감지되지 않거나 이상이 발생한 경우에는 사전에 지정된 수신자에게 알림 메시지가 자동 발송됩니다.

📌 참고사항

메세지허브 웹 > 관리자 콘솔 > (사이드바) 알람 > 알람 > 세션체크용 알람
세션체크용 알람을 설정하면 연결상태(Health Check)를 점검하며, 문제가 계속되는 경우 설정된 간격마다 알람을 수신할 수 있습니다.

⚠️ 헬스체크(Health Check) API 주의사항

헬스체크 API는 메시지허브 서비스 및 네트워크 상태를 실시간으로 확인하기 위한 기능입니다.
이 기능이 정상적으로 작동하기 위해서는 아래의 사항을 반드시 확인해 주세요.

✅ 호출 주기

고객 시스템에서는 1분 이내 간격으로 헬스체크 API를 지속적으로 호출해야 합니다.
호출 주기를 초과하거나 요청이 누락되면, 시스템은 비정상 상태로 판단합니다.

🚨 알림 발송 기준

최근 1분 이내에 헬스체크 요청이 감지되지 않거나,
API 응답이 실패하거나 비정상적인 상태로 판단되면,
사전에 등록된 알림 수신자에게 경고 메시지가 자동 발송됩니다.

1) 요청 (Request)

URL

PUT https://api.msghub.uplus.co.kr/client/v1/healthCheck

Method

PUT

2) 응답 (Response)

Response Body

{
  "code": "10000",
  "message": "성공"
}

3) 요청 예시 (Sample)

Curl

curl -X PUT "https://api.msghub.uplus.co.kr/client/v1/healthCheck" -H  "accept: */*" -H  "Authorization: Bearer eyJhbG....TI5fQ.e2fA......bI"

3. 결과 코드

결과 코드