> 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-guide/back-office/system-bo/undefined-2.md).

# 알림 메시지 관리

알림 메시지 관리 서비스는 사이트 내에서 특정 업무 진행 후 고객에게 완료 알림 메시지를 정의하고 전송하는 기능을 제공합니다. 주문 완료, 주문 취소, 1:1 문의 등의 업무에 대한 알림 메시지를 템플릿으로 정의하고, 선택한 알림 유형(KakaoTalk, SMS, 알림함)으로 고객에게 전송할 수 있습니다.

***

## 주요 기능

* **알림 메시지 정의**
  * 주문 완료, 주문 취소, 1:1 문의 등 각종 업무에 대한 알림 메시지를 정의합니다.
  * 알림 메시지에는 템플릿, 제목 등을 설정할 수 있습니다.
* **알림 유형 선택**
  * 등록한 알림 메시지를 특정 알림 유형(KakaoTalk, SMS, 알림함)으로 선택하여 고객에게 전송합니다.
* **템플릿 매핑**
  * 알림 메시지 관리 페이지에서 등록한 템플릿을 선택하여 해당 템플릿으로 정보를 매핑하여 전송합니다.

## 프로세스 정의

관리자페이지 혹은 사이트의 알림메시지 템플릿을 조회하고 등록, 수정할 수 있습니다.

<figure><img src="/files/hAuc87PDiydf0QLWop1a" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### 알림메시지 목록 조회

선택한 조회조건에 대한 알림 메시지 템플릿 목록 및 건수를 조회합니다.
{% endstep %}

{% step %}

### 알림메시지 단건 조회

목록에서 선택한 알림 메시지 템플릿 상세정보를 조회합니다.
{% endstep %}

{% step %}

### 알림메시지 등록, 수정

신규 알림메시지 템플릿을 등록하거나 기존 템플릿을 수정합니다.

* 신규 등록 시 기입한 템플릿ID가 기존 템플릿 ID로 존재하는지 체크 후 등록합니다.
  {% endstep %}
  {% endstepper %}

## API 기능 목록

<table><thead><tr><th width="127.888916015625">API</th><th width="311.666748046875">설명</th><th width="93.5555419921875">Server</th><th width="91.3333740234375">메소드</th><th>비고</th></tr></thead><tbody><tr><td>알림메시지 <br>목록 건수 <br>조회</td><td>알림메시지 템플릿 목록에 대한 건수를 조회합니다.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EC%95%8C%EB%A6%BC%20%EB%A9%94%EC%8B%9C%EC%A7%80%20%EA%B4%80%EB%A6%AC&#x26;path=getNoticeMessageListCount">🔗API 확인하기 ></a></td></tr><tr><td>알림메시지 <br>목록 조회</td><td>알림메세지 템플릿 목록을 조회합니다.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EC%95%8C%EB%A6%BC%20%EB%A9%94%EC%8B%9C%EC%A7%80%20%EA%B4%80%EB%A6%AC&#x26;path=getNoticeMessageList">🔗API 확인하기 ></a></td></tr><tr><td>알림메시지 <br>단건 조회</td><td>알림메세지 단건의 상세정보를 조회합니다.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EC%95%8C%EB%A6%BC%20%EB%A9%94%EC%8B%9C%EC%A7%80%20%EA%B4%80%EB%A6%AC&#x26;path=getNoticeMessageList">🔗API 확인하기 ></a></td></tr><tr><td>템플릿ID 중복체크</td><td>알림메세지 템플릿 등록 시 중복된 템플릿ID가 존재하는지 체크합니다.</td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EC%95%8C%EB%A6%BC%20%EB%A9%94%EC%8B%9C%EC%A7%80%20%EA%B4%80%EB%A6%AC&#x26;path=checkDuplicatedTmpId">🔗API 확인하기 ></a></td></tr><tr><td>알림메시지 등록, 수정</td><td>알림메세지 템플릿을 신규 등록하거나 기존 템플릿을 수정합니다.</td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EC%95%8C%EB%A6%BC%20%EB%A9%94%EC%8B%9C%EC%A7%80%20%EA%B4%80%EB%A6%AC&#x26;path=saveNoticeMessageInfo">🔗API 확인하기 ></a></td></tr></tbody></table>

## 기타 참고사항

* 템플릿ID 는 필수로 입력해야 합니다.
* 기본알림방법코드(CH009)에 따른 추가 필수 등록 값:
  * 카카오톡: 카카오템플릿ID
  * 알림함: 회원알림유형
* 알림메세지 내용에 **#{변수명}** 형태를 입력한 후, 실제 전송할 때 파라미터로 변수명을 넘겨주면 자동으로 매핑하여 알림메세지를 전송합니다.
* 버튼명/URL 칸에 버튼명과 버튼URL 을 입력하면 카카오톡, 알림함 내에서 URL 로 이동할 수 있는 버튼이 보여지게 됩니다.