# 알림 메시지 관리
## 알림메시지 등록, 수정
> \## 기능설명\
> \* 알림 메세지 정보를 등록, 수정합니다.\
> \---\
> \## 상세설명\
> \* baseNotiMethodCd 는 한 번 등록 후 수정이 불가능합니다.\
> \* 등록 시 필수 파라미터\
> \* 사이트번호, 메세지구분코드, 적용시작일자, 적용종료일자, 기본알림방법코드, 템플릿명, 제목, 메세지, 사용여부\
> \* 기본알림방법코드(baseNotiMethodCd)에 따른 추가 필수 파라미터\
> \* baseNotiMethodCd : 30(카카오톡) : kakaoTmplId\
> \* baseNotiMethodCd : 50(알림함) : mbrNotiTypCd\
> \* 알림메세지 내에 버튼링크 및 버튼URL 이 존재하면 버튼 정보를 함께 저장합니다.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"NoticeMessageInfoRequest":{"type":"object","description":"알림 메세지 등록, 수정 요청 DTO","properties":{"siteNo":{"type":"string","description":"사이트번호","minLength":1},"notiMsgSeq":{"type":"string","description":"알림메세지순번"},"msgGbCd":{"type":"string","description":"메세지구분코드(CH008)","minLength":1},"aplyStrDt":{"type":"string","format":"date","description":"적용시작일자","minLength":1},"aplyEndDt":{"type":"string","format":"date","description":"적용종료일자","minLength":1},"baseNotiMethodCd":{"type":"string","description":"기본알림방법코드(CH009)","minLength":1},"tmplNm":{"type":"string","description":"템플릿명","minLength":1},"ttl":{"type":"string","description":"제목","minLength":1},"msg":{"type":"string","description":"메시지","minLength":1},"useYn":{"type":"string","description":"사용여부","enum":["Y","N"],"minLength":1},"sndNo":{"type":"string","description":"발송번호","minLength":1},"sndmnNm":{"type":"string","description":"발송자명","minLength":1},"tmplId":{"type":"string","description":"템플릿ID"},"kakaoTmplId":{"type":"string","description":"카카오템플릿ID"},"mbrNotiTypCd":{"type":"string","description":"회원알림유형코드(ME051)"},"searchDateType":{"type":"string","description":"조회기간구분"},"dateSelect":{"type":"string","description":"조회기간버튼"},"btnList":{"type":"array","description":"템플릿 버튼 리스트","items":{"$ref":"#/components/schemas/CcNotiMsgBtnInfo"}},"notAvailableUpdate":{"type":"boolean"}},"required":["aplyEndDt","aplyStrDt","baseNotiMethodCd","msg","msgGbCd","siteNo","sndNo","sndmnNm","tmplNm","ttl","useYn"]},"CcNotiMsgBtnInfo":{"type":"object","properties":{"notiMsgSeq":{"type":"string"},"notiMsgBtnSeq":{"type":"string"},"btnNm":{"type":"string"},"btnUrl":{"type":"string"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/system/noticeMessageMgmt/saveNoticeMessageInfo":{"post":{"tags":["알림 메시지 관리"],"summary":"알림메시지 등록, 수정","description":"## 기능설명\n* 알림 메세지 정보를 등록, 수정합니다.\n---\n## 상세설명\n* baseNotiMethodCd 는 한 번 등록 후 수정이 불가능합니다.\n* 등록 시 필수 파라미터\n * 사이트번호, 메세지구분코드, 적용시작일자, 적용종료일자, 기본알림방법코드, 템플릿명, 제목, 메세지, 사용여부\n* 기본알림방법코드(baseNotiMethodCd)에 따른 추가 필수 파라미터\n * baseNotiMethodCd : 30(카카오톡) : kakaoTmplId\n * baseNotiMethodCd : 50(알림함) : mbrNotiTypCd\n* 알림메세지 내에 버튼링크 및 버튼URL 이 존재하면 버튼 정보를 함께 저장합니다.\n","operationId":"saveNoticeMessageInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoticeMessageInfoRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## 템플릿ID 중복체크
> \## 기능설명\
> \* 넘어온 템플릿ID 에 대한 중복 체크를 진행합니다.\
> \---\
> \## 상세설명\
> \* 템플릿ID는 필수입니다.\
> \* 수정 시 동일 알림메세지순번은 중복체크 범위에서 제외해야하기 때문에 수정 시 알림메세지순번은 필수입니다.\
> \* 기존에 존재하는 템플릿ID일 시 해당 ID로는 신규 알림메시지를 등록할 수 없습니다.\
> \* 중복된 템플릿ID 가 존재하면 true를 반환하고, 존재하지 않으면 false를 반환합니다.\
> \---\
> \## 수정번호\
> \* \`\`\`Release v2.00\_240425\`\`\`: 멀티 사이트 확장에 따라, 사이트가 다른 경우 템플릿ID 중복 가능하도록 수정
````json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"NoticeMessageInfoRequest":{"type":"object","description":"알림 메세지 등록, 수정 요청 DTO","properties":{"siteNo":{"type":"string","description":"사이트번호","minLength":1},"notiMsgSeq":{"type":"string","description":"알림메세지순번"},"msgGbCd":{"type":"string","description":"메세지구분코드(CH008)","minLength":1},"aplyStrDt":{"type":"string","format":"date","description":"적용시작일자","minLength":1},"aplyEndDt":{"type":"string","format":"date","description":"적용종료일자","minLength":1},"baseNotiMethodCd":{"type":"string","description":"기본알림방법코드(CH009)","minLength":1},"tmplNm":{"type":"string","description":"템플릿명","minLength":1},"ttl":{"type":"string","description":"제목","minLength":1},"msg":{"type":"string","description":"메시지","minLength":1},"useYn":{"type":"string","description":"사용여부","enum":["Y","N"],"minLength":1},"sndNo":{"type":"string","description":"발송번호","minLength":1},"sndmnNm":{"type":"string","description":"발송자명","minLength":1},"tmplId":{"type":"string","description":"템플릿ID"},"kakaoTmplId":{"type":"string","description":"카카오템플릿ID"},"mbrNotiTypCd":{"type":"string","description":"회원알림유형코드(ME051)"},"searchDateType":{"type":"string","description":"조회기간구분"},"dateSelect":{"type":"string","description":"조회기간버튼"},"btnList":{"type":"array","description":"템플릿 버튼 리스트","items":{"$ref":"#/components/schemas/CcNotiMsgBtnInfo"}},"notAvailableUpdate":{"type":"boolean"}},"required":["aplyEndDt","aplyStrDt","baseNotiMethodCd","msg","msgGbCd","siteNo","sndNo","sndmnNm","tmplNm","ttl","useYn"]},"CcNotiMsgBtnInfo":{"type":"object","properties":{"notiMsgSeq":{"type":"string"},"notiMsgBtnSeq":{"type":"string"},"btnNm":{"type":"string"},"btnUrl":{"type":"string"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/system/noticeMessageMgmt/checkDuplicatedTmpId":{"post":{"tags":["알림 메시지 관리"],"summary":"템플릿ID 중복체크","description":"## 기능설명\n* 넘어온 템플릿ID 에 대한 중복 체크를 진행합니다.\n---\n## 상세설명\n* 템플릿ID는 필수입니다.\n* 수정 시 동일 알림메세지순번은 중복체크 범위에서 제외해야하기 때문에 수정 시 알림메세지순번은 필수입니다.\n* 기존에 존재하는 템플릿ID일 시 해당 ID로는 신규 알림메시지를 등록할 수 없습니다.\n* 중복된 템플릿ID 가 존재하면 true를 반환하고, 존재하지 않으면 false를 반환합니다.\n---\n## 수정번호\n* ```Release v2.00_240425```: 멀티 사이트 확장에 따라, 사이트가 다른 경우 템플릿ID 중복 가능하도록 수정\n","operationId":"checkDuplicatedTmpId","parameters":[{"name":"tmplId","in":"query","description":"템플릿ID","required":true,"schema":{"type":"String"}},{"name":"notiMsgSeq","in":"query","description":"알림메세지순번","schema":{"type":"String"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoticeMessageInfoRequest"}}},"required":true},"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"type":"boolean"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````
## 알림메시지 목록 조회
> \## 기능설명\
> \* 화면에서 선택한 알림항목, 알림방법, 템플릿ID, 템플릿명 조건에 맞는 알림메세지 목록을 조회합니다.\
> \---\
> \## 상세설명\
> \* 화면에서 선택한 알림항목, 알림방법, 템플릿ID, 템플릿명 조건에 맞는 알림메세지 목록을 조회합니다.\
> \---\
> \## 수정번호\
> \* \`\`\`Release v2.00\_240425\`\`\`: 멀티 사이트 확장에 따른 사이트 번호(site\_no) 추가
````json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"NoticeMessageInfoRequest":{"type":"object","description":"알림 메세지 등록, 수정 요청 DTO","properties":{"siteNo":{"type":"string","description":"사이트번호","minLength":1},"notiMsgSeq":{"type":"string","description":"알림메세지순번"},"msgGbCd":{"type":"string","description":"메세지구분코드(CH008)","minLength":1},"aplyStrDt":{"type":"string","format":"date","description":"적용시작일자","minLength":1},"aplyEndDt":{"type":"string","format":"date","description":"적용종료일자","minLength":1},"baseNotiMethodCd":{"type":"string","description":"기본알림방법코드(CH009)","minLength":1},"tmplNm":{"type":"string","description":"템플릿명","minLength":1},"ttl":{"type":"string","description":"제목","minLength":1},"msg":{"type":"string","description":"메시지","minLength":1},"useYn":{"type":"string","description":"사용여부","enum":["Y","N"],"minLength":1},"sndNo":{"type":"string","description":"발송번호","minLength":1},"sndmnNm":{"type":"string","description":"발송자명","minLength":1},"tmplId":{"type":"string","description":"템플릿ID"},"kakaoTmplId":{"type":"string","description":"카카오템플릿ID"},"mbrNotiTypCd":{"type":"string","description":"회원알림유형코드(ME051)"},"searchDateType":{"type":"string","description":"조회기간구분"},"dateSelect":{"type":"string","description":"조회기간버튼"},"btnList":{"type":"array","description":"템플릿 버튼 리스트","items":{"$ref":"#/components/schemas/CcNotiMsgBtnInfo"}},"notAvailableUpdate":{"type":"boolean"}},"required":["aplyEndDt","aplyStrDt","baseNotiMethodCd","msg","msgGbCd","siteNo","sndNo","sndmnNm","tmplNm","ttl","useYn"]},"CcNotiMsgBtnInfo":{"type":"object","properties":{"notiMsgSeq":{"type":"string"},"notiMsgBtnSeq":{"type":"string"},"btnNm":{"type":"string"},"btnUrl":{"type":"string"}}},"RealGridListResponseNoticeMessageInfoResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/NoticeMessageInfoResponse"}}}},"NoticeMessageInfoResponse":{"type":"object","description":"알림메세지 조회 응답 DTO","properties":{"siteNo":{"type":"string","description":"사이트번호"},"notiMsgSeq":{"type":"string","description":"알림메세지순번"},"siteNm":{"type":"string","description":"사이트명"},"msgGbCd":{"type":"string","description":"메세지구분코드(CH008)"},"msgGbNm":{"type":"string","description":"메세지구분명"},"aplyStrDt":{"type":"string","description":"적용시작일자"},"aplyEndDt":{"type":"string","description":"적용종료일자"},"baseNotiMethodCd":{"type":"string","description":"기본알림방법코드(CH009)"},"baseNotiMethodNm":{"type":"string","description":"기본알림방법"},"ttl":{"type":"string","description":"제목"},"msg":{"type":"string","description":"메시지"},"useYn":{"type":"string","description":"사용여부","enum":["Y","N"]},"stateCd":{"type":"string","description":"상태코드"},"sndNo":{"type":"string","description":"발송번호"},"sndmnNm":{"type":"string","description":"발송자명"},"tmplNm":{"type":"string","description":"템플릿명"},"tmplId":{"type":"string","description":"템플릿ID"},"kakaoTmplId":{"type":"string","description":"카카오템플릿ID"},"mbrNotiTypCd":{"type":"string","description":"회원알림유형코드(ME051)"},"mbrNotiTypNm":{"type":"string","description":"회원알림유형"},"btnList":{"type":"array","description":"템플릿 버튼 리스트","items":{"$ref":"#/components/schemas/CcNotiMsgBtnInfo"}},"hasMultiLang":{"type":"boolean","description":"다국어 존재 여부"},"availableMl":{"type":"boolean"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/system/noticeMessageMgmt/getNoticeMessageList":{"get":{"tags":["알림 메시지 관리"],"summary":"알림메시지 목록 조회","description":"## 기능설명\n* 화면에서 선택한 알림항목, 알림방법, 템플릿ID, 템플릿명 조건에 맞는 알림메세지 목록을 조회합니다.\n---\n## 상세설명\n* 화면에서 선택한 알림항목, 알림방법, 템플릿ID, 템플릿명 조건에 맞는 알림메세지 목록을 조회합니다.\n---\n## 수정번호\n* ```Release v2.00_240425```: 멀티 사이트 확장에 따른 사이트 번호(site_no) 추가\n","operationId":"getNoticeMessageList","parameters":[{"name":"noticeMessageInfoRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/NoticeMessageInfoRequest"}},{"name":"msgGbCd","in":"query","description":"알림항목","schema":{"type":"String"}},{"name":"baseNotiMethodCd","in":"query","description":"알림방법","schema":{"type":"String"}},{"name":"tmplId","in":"query","description":"템플릿ID","schema":{"type":"String"}},{"name":"tmplNm","in":"query","description":"템플릿명","schema":{"type":"String"}},{"name":"siteNo","in":"query","description":"사이트번호","schema":{"type":"String"}},{"name":"pageIdx","in":"query","description":"현재 페이지","required":true,"schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"페이지 당 row","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseNoticeMessageInfoResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````
## 알림메시지 단건 조회
> \## 기능설명\
> \* 넘어온 알림메세지 순번에 대한 알림메세지 정보를 조회합니다.\
> \---\
> \## 상세설명\
> \* 넘어온 알림메세지 순번에 대한 알림메세지 정보를 조회합니다.\
> \* 쿠기값의 dataLangCd 기준으로 조회합니다.\
> \* 알림메세지 순번은 필수입니다.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"NoticeMessageInfoRequest":{"type":"object","description":"알림 메세지 등록, 수정 요청 DTO","properties":{"siteNo":{"type":"string","description":"사이트번호","minLength":1},"notiMsgSeq":{"type":"string","description":"알림메세지순번"},"msgGbCd":{"type":"string","description":"메세지구분코드(CH008)","minLength":1},"aplyStrDt":{"type":"string","format":"date","description":"적용시작일자","minLength":1},"aplyEndDt":{"type":"string","format":"date","description":"적용종료일자","minLength":1},"baseNotiMethodCd":{"type":"string","description":"기본알림방법코드(CH009)","minLength":1},"tmplNm":{"type":"string","description":"템플릿명","minLength":1},"ttl":{"type":"string","description":"제목","minLength":1},"msg":{"type":"string","description":"메시지","minLength":1},"useYn":{"type":"string","description":"사용여부","enum":["Y","N"],"minLength":1},"sndNo":{"type":"string","description":"발송번호","minLength":1},"sndmnNm":{"type":"string","description":"발송자명","minLength":1},"tmplId":{"type":"string","description":"템플릿ID"},"kakaoTmplId":{"type":"string","description":"카카오템플릿ID"},"mbrNotiTypCd":{"type":"string","description":"회원알림유형코드(ME051)"},"searchDateType":{"type":"string","description":"조회기간구분"},"dateSelect":{"type":"string","description":"조회기간버튼"},"btnList":{"type":"array","description":"템플릿 버튼 리스트","items":{"$ref":"#/components/schemas/CcNotiMsgBtnInfo"}},"notAvailableUpdate":{"type":"boolean"}},"required":["aplyEndDt","aplyStrDt","baseNotiMethodCd","msg","msgGbCd","siteNo","sndNo","sndmnNm","tmplNm","ttl","useYn"]},"CcNotiMsgBtnInfo":{"type":"object","properties":{"notiMsgSeq":{"type":"string"},"notiMsgBtnSeq":{"type":"string"},"btnNm":{"type":"string"},"btnUrl":{"type":"string"}}},"NoticeMessageInfoResponse":{"type":"object","description":"알림메세지 조회 응답 DTO","properties":{"siteNo":{"type":"string","description":"사이트번호"},"notiMsgSeq":{"type":"string","description":"알림메세지순번"},"siteNm":{"type":"string","description":"사이트명"},"msgGbCd":{"type":"string","description":"메세지구분코드(CH008)"},"msgGbNm":{"type":"string","description":"메세지구분명"},"aplyStrDt":{"type":"string","description":"적용시작일자"},"aplyEndDt":{"type":"string","description":"적용종료일자"},"baseNotiMethodCd":{"type":"string","description":"기본알림방법코드(CH009)"},"baseNotiMethodNm":{"type":"string","description":"기본알림방법"},"ttl":{"type":"string","description":"제목"},"msg":{"type":"string","description":"메시지"},"useYn":{"type":"string","description":"사용여부","enum":["Y","N"]},"stateCd":{"type":"string","description":"상태코드"},"sndNo":{"type":"string","description":"발송번호"},"sndmnNm":{"type":"string","description":"발송자명"},"tmplNm":{"type":"string","description":"템플릿명"},"tmplId":{"type":"string","description":"템플릿ID"},"kakaoTmplId":{"type":"string","description":"카카오템플릿ID"},"mbrNotiTypCd":{"type":"string","description":"회원알림유형코드(ME051)"},"mbrNotiTypNm":{"type":"string","description":"회원알림유형"},"btnList":{"type":"array","description":"템플릿 버튼 리스트","items":{"$ref":"#/components/schemas/CcNotiMsgBtnInfo"}},"hasMultiLang":{"type":"boolean","description":"다국어 존재 여부"},"availableMl":{"type":"boolean"}}},"Response":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v2/system/noticeMessageMgmt/getNoticeMessageInfo":{"get":{"tags":["알림 메시지 관리"],"summary":"알림메시지 단건 조회","description":"## 기능설명\n* 넘어온 알림메세지 순번에 대한 알림메세지 정보를 조회합니다.\n---\n## 상세설명\n* 넘어온 알림메세지 순번에 대한 알림메세지 정보를 조회합니다.\n* 쿠기값의 dataLangCd 기준으로 조회합니다.\n* 알림메세지 순번은 필수입니다.\n","operationId":"getNoticeMessageInfo","parameters":[{"name":"noticeMessageInfoRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/NoticeMessageInfoRequest"}},{"name":"notiMsgSeq","in":"query","description":"알림메세지순번","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/NoticeMessageInfoResponse"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://tech.x2bee.com/api/back-office-api/system-bo-api/undefined-8.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.