5.4 모니터링용 API

목차

• 1. 헬스체크 API
• Appendix

베이스 URL

구분	접속 URL
상용	https://api.msghub.uplus.co.kr
검수	https://api.msghub-qa.uplus.co.kr

1. 헬스체크 API

agent의 연결상태를 주기적으로 확인합니다.

📌 주의사항

1. 연결상태 확인을 위해 1분 이하의 간격으로 헬스체크 API를 호출해주세요.
2. 1분마다 연결상태(Health Check)를 점검하며, 연결 상태의 문제가 계속되는 경우 사용자가 설정한 간격으로 알람이 발송됩니다.
3. 알람과 관련된 사항은 ‘메시지허브 홈페이지 > 관리자콘솔 > 알람 > 알람 > 세션체크용 알람’ 에서 설정하실 수 있습니다.

---

1) 요청 (Request)

URL

PUT https://api.msghub-qa.uplus.co.kr/client/v1/healthCheck HTTP/1.1

Headers

필드명	타입	필수 여부	설명
Authorization	String	●	사용자 인증 토큰

---

2) 응답 (Response)

Response Body

필드명	타입	설명
code	String	결과 코드
message	String	결과 메시지

---

3) 요청 예시 (Sample)

Curl

curl -X PUT "https://api.msghub-qa.uplus.co.kr/client/v1/healthCheck" \
  -H "accept: */*" \
  -H "Authorization: Bearer {token}" \'

Response

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

Appendix

결과 코드

• 결과 코드