> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/system-bo-api/notification-message-management.md).
# Notification Message Management
## Register/Modify Notification Message
> \## Function Description\
> \* Registers or modifies notification message information.\
> \---\
> \## Detailed Description\
> \* baseNotiMethodCd cannot be modified once registered.\
> \* Required parameters when registering\
> \* Site No., Message Type Code, Application Start Date, Application End Date, Base Notification Method Code, Template Name, Title, Message, Usage Status\
> \* Additional required parameters depending on the base notification method code (baseNotiMethodCd)\
> \* baseNotiMethodCd : 30 (KakaoTalk) : kakaoTmplId\
> \* baseNotiMethodCd : 50 (Notification Box) : mbrNotiTypCd\
> \* If a button link and button URL exist within the notification message, the button information is saved together.
```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":"Register/Modify Notification Message Request DTO","properties":{"siteNo":{"type":"string","description":"Site No.","minLength":1},"notiMsgSeq":{"type":"string","description":"Notification Message Sequence No."},"msgGbCd":{"type":"string","description":"Message Type Code (CH008)","minLength":1},"aplyStrDt":{"type":"string","format":"date","description":"Application Start Date","minLength":1},"aplyEndDt":{"type":"string","format":"date","description":"Application End Date","minLength":1},"baseNotiMethodCd":{"type":"string","description":"Default Notification Method Code (CH009)","minLength":1},"tmplNm":{"type":"string","description":"Template Name","minLength":1},"ttl":{"type":"string","description":"Title","minLength":1},"msg":{"type":"string","description":"Message","minLength":1},"useYn":{"type":"string","description":"Usage Status","enum":["Y","N"],"minLength":1},"sndNo":{"type":"string","description":"Send No.","minLength":1},"sndmnNm":{"type":"string","description":"Sender Name","minLength":1},"tmplId":{"type":"string","description":"Template ID"},"kakaoTmplId":{"type":"string","description":"Kakao Template ID"},"mbrNotiTypCd":{"type":"string","description":"Member Notification Type Code (ME051)"},"searchDateType":{"type":"string","description":"Search Period Type"},"dateSelect":{"type":"string","description":"Search Period Button"},"btnList":{"type":"array","description":"Template Button List","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":["Notification Message Management"],"summary":"Register/Modify Notification Message","description":"## Function Description\n* Registers or modifies notification message information.\n---\n## Detailed Description\n* baseNotiMethodCd cannot be modified once registered.\n* Required parameters when registering\n * Site No., Message Type Code, Application Start Date, Application End Date, Base Notification Method Code, Template Name, Title, Message, Usage Status\n* Additional required parameters depending on the base notification method code (baseNotiMethodCd)\n * baseNotiMethodCd : 30 (KakaoTalk) : kakaoTmplId\n * baseNotiMethodCd : 50 (Notification Box) : mbrNotiTypCd\n* If a button link and button URL exist within the notification message, the button information is saved together.\n","operationId":"saveNoticeMessageInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoticeMessageInfoRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Check Duplicate Template ID
> \## Function Description\
> \* Performs a duplicate check for the given template ID.\
> \---\
> \## Detailed Description\
> \* Template ID is required.\
> \* When modifying, the same notification message sequence number must be excluded from the duplicate check scope, so the notification message sequence number is required when modifying.\
> \* If the template ID already exists, a new notification message cannot be registered with that ID.\
> \* Returns true if a duplicate template ID exists, and false if it does not.\
> \---\
> \## Revision History\
> \* \`\`\`Release v2.00\_240425\`\`\`: Modified to allow duplicate template IDs across different sites, due to multi-site expansion
````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":"Register/Modify Notification Message Request DTO","properties":{"siteNo":{"type":"string","description":"Site No.","minLength":1},"notiMsgSeq":{"type":"string","description":"Notification Message Sequence No."},"msgGbCd":{"type":"string","description":"Message Type Code (CH008)","minLength":1},"aplyStrDt":{"type":"string","format":"date","description":"Application Start Date","minLength":1},"aplyEndDt":{"type":"string","format":"date","description":"Application End Date","minLength":1},"baseNotiMethodCd":{"type":"string","description":"Default Notification Method Code (CH009)","minLength":1},"tmplNm":{"type":"string","description":"Template Name","minLength":1},"ttl":{"type":"string","description":"Title","minLength":1},"msg":{"type":"string","description":"Message","minLength":1},"useYn":{"type":"string","description":"Usage Status","enum":["Y","N"],"minLength":1},"sndNo":{"type":"string","description":"Send No.","minLength":1},"sndmnNm":{"type":"string","description":"Sender Name","minLength":1},"tmplId":{"type":"string","description":"Template ID"},"kakaoTmplId":{"type":"string","description":"Kakao Template ID"},"mbrNotiTypCd":{"type":"string","description":"Member Notification Type Code (ME051)"},"searchDateType":{"type":"string","description":"Search Period Type"},"dateSelect":{"type":"string","description":"Search Period Button"},"btnList":{"type":"array","description":"Template Button List","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":["Notification Message Management"],"summary":"Check Duplicate Template ID","description":"## Function Description\n* Performs a duplicate check for the given template ID.\n---\n## Detailed Description\n* Template ID is required.\n* When modifying, the same notification message sequence number must be excluded from the duplicate check scope, so the notification message sequence number is required when modifying.\n* If the template ID already exists, a new notification message cannot be registered with that ID.\n* Returns true if a duplicate template ID exists, and false if it does not.\n---\n## Revision History\n* ```Release v2.00_240425```: Modified to allow duplicate template IDs across different sites, due to multi-site expansion\n","operationId":"checkDuplicatedTmpId","parameters":[{"name":"tmplId","in":"query","description":"Template ID","required":true,"schema":{"type":"String"}},{"name":"notiMsgSeq","in":"query","description":"Notification Message Sequence No.","schema":{"type":"String"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoticeMessageInfoRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"boolean"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````
## Retrieve Notification Message List
> \## Function Description\
> \* Retrieves the notification message list matching the notification item, notification method, template ID, and template name conditions selected on the screen.\
> \---\
> \## Detailed Description\
> \* Retrieves the notification message list matching the notification item, notification method, template ID, and template name conditions selected on the screen.\
> \---\
> \## Revision History\
> \* \`\`\`Release v2.00\_240425\`\`\`: Added site number (site\_no) for multi-site expansion
````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":"Register/Modify Notification Message Request DTO","properties":{"siteNo":{"type":"string","description":"Site No.","minLength":1},"notiMsgSeq":{"type":"string","description":"Notification Message Sequence No."},"msgGbCd":{"type":"string","description":"Message Type Code (CH008)","minLength":1},"aplyStrDt":{"type":"string","format":"date","description":"Application Start Date","minLength":1},"aplyEndDt":{"type":"string","format":"date","description":"Application End Date","minLength":1},"baseNotiMethodCd":{"type":"string","description":"Default Notification Method Code (CH009)","minLength":1},"tmplNm":{"type":"string","description":"Template Name","minLength":1},"ttl":{"type":"string","description":"Title","minLength":1},"msg":{"type":"string","description":"Message","minLength":1},"useYn":{"type":"string","description":"Usage Status","enum":["Y","N"],"minLength":1},"sndNo":{"type":"string","description":"Send No.","minLength":1},"sndmnNm":{"type":"string","description":"Sender Name","minLength":1},"tmplId":{"type":"string","description":"Template ID"},"kakaoTmplId":{"type":"string","description":"Kakao Template ID"},"mbrNotiTypCd":{"type":"string","description":"Member Notification Type Code (ME051)"},"searchDateType":{"type":"string","description":"Search Period Type"},"dateSelect":{"type":"string","description":"Search Period Button"},"btnList":{"type":"array","description":"Template Button List","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":"Alert Message Retrieval Response DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"notiMsgSeq":{"type":"string","description":"Notification Message Sequence No."},"siteNm":{"type":"string","description":"Site Name"},"msgGbCd":{"type":"string","description":"Message Type Code (CH008)"},"msgGbNm":{"type":"string","description":"Message Type Name"},"aplyStrDt":{"type":"string","description":"Application Start Date"},"aplyEndDt":{"type":"string","description":"Application End Date"},"baseNotiMethodCd":{"type":"string","description":"Default Notification Method Code (CH009)"},"baseNotiMethodNm":{"type":"string","description":"Default Alert Method"},"ttl":{"type":"string","description":"Title"},"msg":{"type":"string","description":"Message"},"useYn":{"type":"string","description":"Usage Status","enum":["Y","N"]},"stateCd":{"type":"string","description":"Status Code"},"sndNo":{"type":"string","description":"Send No."},"sndmnNm":{"type":"string","description":"Sender Name"},"tmplNm":{"type":"string","description":"Template Name"},"tmplId":{"type":"string","description":"Template ID"},"kakaoTmplId":{"type":"string","description":"Kakao Template ID"},"mbrNotiTypCd":{"type":"string","description":"Member Notification Type Code (ME051)"},"mbrNotiTypNm":{"type":"string","description":"Member Alert Type"},"btnList":{"type":"array","description":"Template Button List","items":{"$ref":"#/components/schemas/CcNotiMsgBtnInfo"}},"hasMultiLang":{"type":"boolean","description":"Multilingual Existence Status"},"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":["Notification Message Management"],"summary":"Retrieve Notification Message List","description":"## Function Description\n* Retrieves the notification message list matching the notification item, notification method, template ID, and template name conditions selected on the screen.\n---\n## Detailed Description\n* Retrieves the notification message list matching the notification item, notification method, template ID, and template name conditions selected on the screen.\n---\n## Revision History\n* ```Release v2.00_240425```: Added site number (site_no) for multi-site expansion\n","operationId":"getNoticeMessageList","parameters":[{"name":"noticeMessageInfoRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/NoticeMessageInfoRequest"}},{"name":"msgGbCd","in":"query","description":"Notification Item","schema":{"type":"String"}},{"name":"baseNotiMethodCd","in":"query","description":"Notification Method","schema":{"type":"String"}},{"name":"tmplId","in":"query","description":"Template ID","schema":{"type":"String"}},{"name":"tmplNm","in":"query","description":"Template Name","schema":{"type":"String"}},{"name":"siteNo","in":"query","description":"Site No.","schema":{"type":"String"}},{"name":"pageIdx","in":"query","description":"Current Page","required":true,"schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"Rows per Page","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseNoticeMessageInfoResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````
## Retrieve Single Notification Message
> \## Function Description\
> \* Retrieves the notification message information for the given notification message sequence number.\
> \---\
> \## Detailed Description\
> \* Retrieves the notification message information for the given notification message sequence number.\
> \* Retrieved based on the dataLangCd cookie value.\
> \* Notification Message Sequence No. is required.
```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":"Register/Modify Notification Message Request DTO","properties":{"siteNo":{"type":"string","description":"Site No.","minLength":1},"notiMsgSeq":{"type":"string","description":"Notification Message Sequence No."},"msgGbCd":{"type":"string","description":"Message Type Code (CH008)","minLength":1},"aplyStrDt":{"type":"string","format":"date","description":"Application Start Date","minLength":1},"aplyEndDt":{"type":"string","format":"date","description":"Application End Date","minLength":1},"baseNotiMethodCd":{"type":"string","description":"Default Notification Method Code (CH009)","minLength":1},"tmplNm":{"type":"string","description":"Template Name","minLength":1},"ttl":{"type":"string","description":"Title","minLength":1},"msg":{"type":"string","description":"Message","minLength":1},"useYn":{"type":"string","description":"Usage Status","enum":["Y","N"],"minLength":1},"sndNo":{"type":"string","description":"Send No.","minLength":1},"sndmnNm":{"type":"string","description":"Sender Name","minLength":1},"tmplId":{"type":"string","description":"Template ID"},"kakaoTmplId":{"type":"string","description":"Kakao Template ID"},"mbrNotiTypCd":{"type":"string","description":"Member Notification Type Code (ME051)"},"searchDateType":{"type":"string","description":"Search Period Type"},"dateSelect":{"type":"string","description":"Search Period Button"},"btnList":{"type":"array","description":"Template Button List","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":"Alert Message Retrieval Response DTO","properties":{"siteNo":{"type":"string","description":"Site No."},"notiMsgSeq":{"type":"string","description":"Notification Message Sequence No."},"siteNm":{"type":"string","description":"Site Name"},"msgGbCd":{"type":"string","description":"Message Type Code (CH008)"},"msgGbNm":{"type":"string","description":"Message Type Name"},"aplyStrDt":{"type":"string","description":"Application Start Date"},"aplyEndDt":{"type":"string","description":"Application End Date"},"baseNotiMethodCd":{"type":"string","description":"Default Notification Method Code (CH009)"},"baseNotiMethodNm":{"type":"string","description":"Default Alert Method"},"ttl":{"type":"string","description":"Title"},"msg":{"type":"string","description":"Message"},"useYn":{"type":"string","description":"Usage Status","enum":["Y","N"]},"stateCd":{"type":"string","description":"Status Code"},"sndNo":{"type":"string","description":"Send No."},"sndmnNm":{"type":"string","description":"Sender Name"},"tmplNm":{"type":"string","description":"Template Name"},"tmplId":{"type":"string","description":"Template ID"},"kakaoTmplId":{"type":"string","description":"Kakao Template ID"},"mbrNotiTypCd":{"type":"string","description":"Member Notification Type Code (ME051)"},"mbrNotiTypNm":{"type":"string","description":"Member Alert Type"},"btnList":{"type":"array","description":"Template Button List","items":{"$ref":"#/components/schemas/CcNotiMsgBtnInfo"}},"hasMultiLang":{"type":"boolean","description":"Multilingual Existence Status"},"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":["Notification Message Management"],"summary":"Retrieve Single Notification Message","description":"## Function Description\n* Retrieves the notification message information for the given notification message sequence number.\n---\n## Detailed Description\n* Retrieves the notification message information for the given notification message sequence number.\n* Retrieved based on the dataLangCd cookie value.\n* Notification Message Sequence No. is required.\n","operationId":"getNoticeMessageInfo","parameters":[{"name":"noticeMessageInfoRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/NoticeMessageInfoRequest"}},{"name":"notiMsgSeq","in":"query","description":"Notification Message Sequence No.","required":true,"schema":{"type":"String"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/NoticeMessageInfoResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```