docs(message_bizppurio): 운영자용 README 추가 + CHANGELOG 미배포 기준 정비
플러그인 README가 없어 webhook 등록, 검수/운영 계정, 알림톡 템플릿 역할 분리
등 운영자가 알아야 할 내용이 문서화되어 있지 않았다. 결제 플러그인(KG이니시스
등) README 관례를 따라 요구사항, 설치, 관리자 설정, webhook 등록, 발송 흐름,
결과 코드, 훅, API, 삭제 시 동작을 담은 README를 추가한다.
CHANGELOG는 아직 공개 저장소가 없는 미배포 상태이므로, 개발 중 쌓인 이력성
문구("예전에는 ~였지만 이제 ~")를 걷어내고 1.0.0이 처음 제공하는 기능 목록만
남기도록 정리한다. ja 번들 언어팩 CHANGELOG도 동일 기준으로 정리한다.
This commit is contained in:
chym1217 committed
1 parent
f66f1a2f20
commit
49edacf5e0
3 files changed
+250
-43
No files matched your search
@@ -4,12 +4,8 @@
|
||||
형식은 [Keep a Changelog](https://keepachangelog.com/ko/1.1.0/)를 따르며,
|
||||
[Semantic Versioning](https://semver.org/lang/ko/)을 준수합니다.
|
||||
|
||||
## [1.0.0] - 2026-07-24
|
||||
## [1.0.0] - 2026-07-28
|
||||
|
||||
### Added
|
||||
|
||||
- 비즈뿌리오 메시징 플러그인(sirsoft-message_bizppurio)의 일본어 번들 언어팩 초기 제공
|
||||
- 환경설정·알림톡 템플릿 관리·발송 이력 등 관리자 화면 텍스트와 발송 결과 코드 안내의 일본어 번역 추가 — 관련 화면이 일본어 로케일에서 자연스럽게 표시됩니다.
|
||||
- 후불 한도 초과(9071) 결과 코드 사유의 일본어 번역 추가.
|
||||
- 잔액부족 알림의 채널군 라벨(문자/알림톡) 일본어 번역 추가.
|
||||
- 발송 결과 코드 사유를 최신 공식 명세에 맞춰 정합화(추가·정정)한 내용을 일본어 번역에 반영.
|
||||
- 비즈뿌리오 메시징 플러그인(sirsoft-message_bizppurio)의 일본어 번들 언어팩을 제공합니다. 환경설정·알림톡 템플릿 관리·발송 이력 화면과 발송 결과 코드 안내가 일본어 로케일에서 자연스럽게 표시됩니다.
|
||||
@@ -4,43 +4,11 @@
|
||||
형식은 [Keep a Changelog](https://keepachangelog.com/ko/1.1.0/)를 따르며,
|
||||
[Semantic Versioning](https://semver.org/lang/ko/)을 준수합니다.
|
||||
|
||||
## [1.0.0] - 2026-07-09
|
||||
## [1.0.0] - 2026-07-28
|
||||
|
||||
### Added
|
||||
|
||||
- 비즈뿌리오 연동 환경설정 화면을 추가했습니다. 비즈뿌리오 아이디·비밀번호·API 키·발신번호·알림톡 발신프로필 키·연동 환경(검수/운영)을 관리자 화면에서 설정할 수 있습니다.
|
||||
- 연동 환경을 운영으로 설정하면 발송에 필요한 아이디·비밀번호·발신번호가 반드시 입력되도록 검증하고, 실제 발송·비용이 발생한다는 경고를 함께 안내합니다.
|
||||
- 발송 결과(리포트)를 받을 수신 주소를 설정 화면에서 확인·복사할 수 있습니다. 이 주소를 비즈뿌리오에 등록하면 발송 결과가 이력에 자동 기록됩니다.
|
||||
- 비즈뿌리오 메시지 발송 기능에 대한 조회·관리 권한을 추가했습니다. 관련 화면은 플러그인 설정 페이지에서 진입합니다.
|
||||
- 비즈뿌리오 지갑 잔액이 부족할 때 관리자에게 알리는 알림을 추가했습니다.
|
||||
- 회원가입·주문 등의 알림을 문자(SMS/LMS)로 자동 발송하는 채널을 알림 설정에 추가했습니다. 본문 길이에 따라 SMS·LMS 가 자동으로 선택되며, 발신 정보가 설정되지 않은 경우 어떤 항목을 채워야 하는지 안내합니다. 플러그인을 설치하면 회원 대상 알림의 문자·알림톡 채널 기본 템플릿(제목·본문·수신자)이 알림 설정에 자동으로 채워져, 바로 켜고 편집할 수 있습니다.
|
||||
- 비회원 주문 알림도 주문 시 입력한 연락처로 문자를 받을 수 있습니다.
|
||||
- 카카오 알림톡 채널을 알림 설정에 추가했습니다. (알림톡 실제 발송·템플릿 연동은 후속 단계에서 제공됩니다.)
|
||||
- 비즈뿌리오가 보내는 발송 결과 통보를 받아 각 발송의 실제 도달 여부(성공/실패)를 기록합니다. 실패한 경우 사유를 함께 확인할 수 있습니다(예: 음영 지역, 잘못된 번호, 스팸 차단, 지갑 잔액 부족 등).
|
||||
- 관리자 "알림 발송 이력" 화면에서 문자·알림톡의 발송 결과(성공/실패·사유·지갑 잔액 부족·SMS 대체발송 여부)를 각 발송 행에서 바로 확인할 수 있습니다. 문자·알림톡 탭에서만 결과가 표시되며, 행을 펼치면 상세 결과를 볼 수 있습니다. 대체발송을 실제로 요청한 건에서만 결과가 표시되어, 사용하지 않은 건에 잘못 표시되지 않습니다. 알림톡은 카카오 승인 템플릿의 실제 발송 내용을 별도로 함께 보여줘, 위에 표시되는 알림 기본 본문과 헷갈리지 않도록 합니다.
|
||||
- 지갑 잔액 부족으로 발송이 실패하면 관리자에게 알립니다. 대량 실패 시 알림이 반복 발송되지 않도록 일정 시간 간격으로 한 번만 안내합니다.
|
||||
- 설정 페이지의 알림톡 템플릿 탭에서 카카오 알림톡 템플릿의 목록·상태·내용을 확인할 수 있습니다. 템플릿 등록·수정·검수·상태변경은 비즈뿌리오 콘솔에서 하며, 이 화면은 목록·상태·내용 조회와 알림 연결을 담당합니다. 콘솔에서 등록한 템플릿도 이 목록에 그대로 표시되고 알림에 연결할 수 있습니다.
|
||||
- 템플릿 목록을 상태(발송가능·검수중·반려·미검수·중지 등) 배지와 함께 보여주고, 상태·이름으로 필터·검색할 수 있습니다. 검색 결과가 없으면 오류 없이 "등록된 알림톡 템플릿이 없습니다"로 표시됩니다. 발송가능(승인) 상태의 템플릿만 알림에 연결해 발송할 수 있습니다.
|
||||
- 각 템플릿의 [내용] 버튼으로 템플릿명·코드·카테고리·유형·본문·버튼을 담은 상세 내용을 확인할 수 있습니다.
|
||||
- 목록 상단에 배지 의미(발송가능·검수중·미검수·반려)와 함께, 템플릿 등록·수정·검수·상태변경은 비즈뿌리오 콘솔에서 한다는 안내와 콘솔 바로가기를 제공합니다.
|
||||
- 환경설정 탭에 카카오 알림톡·문자(SMS/LMS) 사용 전 준비 사항(비즈뿌리오 가입·API 승인·발신프로필 등록·발신번호 사전 등록)을 안내하는 박스를 추가했습니다.
|
||||
- 템플릿 목록·상세 조회가 실패하면 카카오가 알려준 실제 사유(예: 접근 불가 IP, 발신프로필 미설정 등)를 화면에 그대로 표시합니다.
|
||||
- 알림에 연결한 카카오 알림톡 템플릿을 실제로 발송합니다. 카카오에 등록·승인된 템플릿의 본문뿐 아니라 버튼·바로연결·강조표기·아이템리스트·대표링크까지 그대로 발송에 반영하며, 각 항목의 변수는 발송 시점의 실제 데이터로 채워집니다. 버튼이나 링크가 포함된 템플릿도 정상적으로 발송됩니다. 버튼 URL이 로그인·비밀번호 재설정 등 완전한 주소 변수와 결합되는 경우에도 주소가 겹치지 않도록 처리합니다.
|
||||
- 환경설정에 "알림톡 내용 캐시 시간(분)"과 "캐시 초기화" 버튼을 추가했습니다. 카카오 알림톡 템플릿 내용을 이 시간 동안 기억해 재사용하며(기본 60분, 0으로 두면 발송할 때마다 최신 내용을 가져옵니다), 카카오에서 템플릿을 방금 수정한 경우 [캐시 초기화]로 다음 발송부터 최신 내용이 즉시 반영되도록 할 수 있습니다.
|
||||
- 알림톡 발송이 일시적인 오류(카카오 시스템 오류·처리 지연·타임아웃 등)로 실패한 경우 자동으로 다시 시도합니다.
|
||||
- 알림에 연결한 알림톡 템플릿이 카카오에서 삭제·차단되거나 승인이 취소되면, 알림 설정 화면의 해당 알림에 "사용 불가 — 재연결 필요" 표시가 나타납니다. 예전에는 연결이 끊긴 뒤에도 정상 연결처럼 보여 발송 실패 후에야 알 수 있었지만, 이제 화면에서 바로 확인하고 다시 연결할 수 있습니다. (카카오 조회가 일시적으로 안 되는 경우에는 잘못된 경고가 뜨지 않도록 표시를 보류합니다.)
|
||||
- 알림톡 연결 창에서 자격증명 오류 등으로 승인 템플릿 목록을 불러오지 못한 경우와, 승인된 템플릿이 실제로 없는 경우를 구분해 안내합니다. 불러오기에 실패하면 설정을 확인하라는 안내가, 실제로 없으면 템플릿을 먼저 등록·검수하라는 안내가 표시됩니다.
|
||||
- 검수 모드 설정에 검수와 운영은 별도의 비즈뿌리오 계정으로 운영하는 것을 권장한다는 안내를 함께 표시합니다.
|
||||
- 사용 전 준비 안내를 문자(SMS/LMS)와 카카오 알림톡 두 갈래로 나눠 넓은 화면에서 좌우 두 칸으로 보여주고, 각 항목에 채널 아이콘을 더해 한눈에 구분되도록 정리했습니다.
|
||||
- 검수 모드로 발송된 문자·알림톡은 발송 이력 화면에 "발송중" 대신 "검수" 라벨로 표시되어, 실제 장애와 검수 도메인 특성을 운영자가 쉽게 구분할 수 있습니다.
|
||||
- 문자·알림톡 발송 시 비즈뿌리오에 실제로 전송한 요청 내용을 이력에 함께 저장합니다. 발송이 실패했을 때 어떤 내용이 전송됐는지 사후에 확인할 수 있습니다.
|
||||
- 알림톡 템플릿이 연결되지 않았거나 문자 템플릿이 없는 등 발송 자체를 시도하지 못한 경우, 관리자 알림 발송 이력 화면에 "성공"이 아닌 "실패"로 정확히 표시됩니다.
|
||||
- 플러그인을 삭제하면 이 플러그인이 알림 설정에 추가했던 문자·알림톡 채널이 함께 정리됩니다. 메일·사이트 내 알림 등 다른 채널과 알림 자체는 그대로 유지되며, 플러그인을 다시 설치하면 문자·알림톡 채널이 자동으로 복원됩니다.
|
||||
- 잔액 부족으로 발송이 실패해 관리자에게 보내는 알림에서, 실패한 채널(문자/알림톡)과 결과 코드가 안내 문구에 실제 값으로 표시됩니다. 후불 결제 한도를 초과한 경우도 잔액 부족과 동일하게 관리자에게 알립니다.
|
||||
- 발송 결과 코드의 사유 안내를 비즈뿌리오 최신 공식 명세에 맞춰 정비했습니다. 일부 코드의 설명을 정정하고 누락된 코드(접속 IP 오류, 수신거부, 발신 프로필 키 오류 등)를 추가해, 발송 이력에서 실패 사유가 더 정확히 표시됩니다.
|
||||
- 발송 요청이 실패하면 비즈뿌리오가 알려준 실제 사유와 결과 코드가 발송 이력에 기록됩니다. 예전에는 "발송 요청 실패"로만 표시되어 원인을 알 수 없었지만, 이제 "발신 프로필 키가 유효하지 않음 (7103)"처럼 구체적인 사유가 표시되어 문제를 바로 확인할 수 있습니다.
|
||||
|
||||
### Changed
|
||||
|
||||
- 환경설정·발송 이력 화면의 "테스트 모드" 표기를 "검수 모드"로 통일했습니다. 실제 동작 변화는 없습니다.
|
||||
- 알림 설정 화면에서 발송 설정이 미완료된 상태에서도 검수 모드 안내가 함께 표시되도록 했습니다. 두 안내 문구 사이 여백도 정리했습니다.
|
||||
- 비즈뿌리오 연동 환경설정 화면과 문자(SMS/LMS)·카카오 알림톡 발송 채널을 추가했습니다. 회원가입·주문 등 코어 알림에 자동 연결되며, 검수/운영 환경을 구분해 운영합니다.
|
||||
- 설정 화면에서 카카오 알림톡 템플릿을 조회해 알림에 연결하고 실제로 발송할 수 있습니다. 템플릿 등록·검수는 비즈뿌리오 콘솔에서 진행합니다.
|
||||
- 비즈뿌리오 webhook 으로 발송 결과를 수신해 "알림 발송 이력" 화면에 성공/실패와 사유를 기록하며, 지갑 잔액 부족 등으로 발송이 막히면 관리자에게 알립니다.
|
||||
- 플러그인을 삭제하면 추가했던 발송 채널이 함께 정리되고, 재설치 시 자동 복원됩니다.
|
||||
@@ -0,0 +1,243 @@
|
||||
# Bizppurio Messaging Plugin for G7
|
||||
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/version-1.0.0-blue" alt="Version">
|
||||
<img src="https://img.shields.io/badge/G7-%3E%3D7.0.3-0066FF" alt="G7">
|
||||
<img src="https://img.shields.io/badge/PHP-8.2%2B-777BB4?logo=php&logoColor=white" alt="PHP">
|
||||
<img src="https://img.shields.io/badge/license-MIT-green" alt="License">
|
||||
</p>
|
||||
|
||||
비즈뿌리오(Bizppurio)를 연동해 문자(SMS/LMS)와 카카오 알림톡을 발송하는 G7 플러그인입니다.
|
||||
|
||||
G7 코어 알림 시스템에 문자·알림톡 채널을 추가해, 회원가입·주문 등 코어/모듈이 발화하는 알림을 문자와 알림톡으로도 자동 발송합니다. 발송 결과는 비즈뿌리오가 보내는 webhook 통보로 수신해 성공/실패와 실패 사유를 발송 이력에 기록합니다.
|
||||
|
||||
[주요 기능](#주요-기능) · [요구 사항](#요구-사항) · [설치](#설치) · [관리자 설정](#관리자-설정) · [webhook 등록](#webhook발송-결과-리포트-등록) · [발송 흐름](#발송-흐름) · [알림톡 템플릿 연동](#알림톡-템플릿-연동) · [발송 결과 코드](#발송-결과-코드) · [훅](#가용-훅-hook) · [API](#api) · [테스트](#테스트)
|
||||
|
||||
---
|
||||
|
||||
## 주요 기능
|
||||
|
||||
- 문자(SMS/LMS) 발송 — 본문 길이에 따라 SMS/LMS 자동 선택
|
||||
- 카카오 알림톡 발송 — 승인된 템플릿의 본문·버튼·바로연결·강조표기·아이템리스트·대표링크까지 반영
|
||||
- 알림톡 미승인/미연결 시 문자로 자동 대체발송(옵션)
|
||||
- 회원·비회원 대상 알림에 문자 채널 연동 (비회원은 주문 시 입력한 연락처 사용)
|
||||
- 비즈뿌리오 webhook 리포트 수신으로 발송 결과(성공/실패/사유) 자동 기록
|
||||
- 검수(테스트) 모드 — 실제 발송 없이 화면·흐름 검증
|
||||
- 지갑 잔액 부족·후불 한도 초과 시 관리자 알림 (반복 발송 방지 쿨다운 적용)
|
||||
- 관리자 "알림 발송 이력" 화면에 문자·알림톡 결과 통합 표시
|
||||
- 알림톡 템플릿 목록·상태·내용 조회 및 알림 연결 (템플릿 등록·검수는 비즈뿌리오 콘솔에서 진행)
|
||||
- 알림톡 템플릿이 카카오에서 삭제·차단·승인취소된 경우 "사용 불가 — 재연결 필요" 표시
|
||||
|
||||
---
|
||||
|
||||
## 요구 사항
|
||||
|
||||
| 구분 | 항목 | 내용 |
|
||||
|------|------|------|
|
||||
| 플랫폼 | G7 | `>= 7.0.3` |
|
||||
| 플랫폼 | PHP | `^8.2` |
|
||||
| 사전 준비 | 비즈뿌리오 계정 | 가입 + API 사용 승인 |
|
||||
| 사전 준비 | 문자 발송 | 발신번호 사전 등록 (비즈뿌리오 콘솔) |
|
||||
| 사전 준비 | 알림톡 발송 | 카카오 발신프로필 등록 + 발송할 템플릿의 카카오 검수 승인 |
|
||||
|
||||
> 운영 모드로 전환하려면 비즈뿌리오 아이디·비밀번호·API 키·발신번호가 모두 입력되어야 하며, 이 시점부터 **실제 발송과 비용이 발생**합니다.
|
||||
|
||||
---
|
||||
|
||||
## 설치
|
||||
|
||||
플러그인을 G7 프로젝트의 플러그인 디렉토리에 배치합니다.
|
||||
|
||||
```text
|
||||
plugins/sirsoft-message_bizppurio
|
||||
```
|
||||
|
||||
프론트엔드 에셋을 수정한 경우 플러그인 디렉토리에서 빌드합니다.
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run build
|
||||
```
|
||||
|
||||
그다음 G7 관리자에서 플러그인을 활성화합니다. 설치 시 회원 대상 알림의 문자·알림톡 채널 기본 템플릿(제목·본문·수신자)이 알림 설정에 자동으로 채워집니다.
|
||||
|
||||
---
|
||||
|
||||
## 관리자 설정
|
||||
|
||||
관리자 플러그인 설정 화면에서 비즈뿌리오 계정 정보를 입력합니다.
|
||||
|
||||
| 설정 | 필수 여부 | 설명 |
|
||||
|------|:---:|------|
|
||||
| 검수 모드 | - | 활성화 시 실제 발송 없이 검수용으로만 동작. 발송 이력에 "검수" 라벨로 표시되어 실제 장애와 구분됨 |
|
||||
| 비즈뿌리오 아이디 / 비밀번호 | 운영 시 필수 | 비즈뿌리오 계정 로그인 정보 |
|
||||
| API 키 | 운영 시 필수 | 비즈뿌리오 API 인증에 사용 |
|
||||
| 발신번호 | 운영 시 필수 | 문자 발송용 발신번호. 비즈뿌리오 콘솔에 사전 등록된 번호만 사용 가능 |
|
||||
| 알림톡 발신프로필 키 | 알림톡 사용 시 필수 | 카카오 알림톡 발송에 사용할 발신프로필 키 |
|
||||
| 잔액부족 알림 재발송 간격(초) | 선택 (기본 3600) | 잔액 부족/한도 초과 실패 시 관리자 알림의 최소 재발송 간격. 대량 실패 시 반복 발송 방지 |
|
||||
| 알림톡 내용 캐시 시간(분) | 선택 (기본 60) | 카카오 템플릿 내용 재사용 시간. 0이면 매 발송마다 최신 조회, [캐시 초기화] 버튼으로 즉시 반영 가능 |
|
||||
|
||||
> 검수와 운영은 별도의 비즈뿌리오 계정으로 운영하는 것을 권장합니다. 비밀번호·API 키·발신프로필 키는 관리자 설정 화면에서만 입력하며 프론트엔드로 노출되지 않습니다.
|
||||
|
||||
---
|
||||
|
||||
## webhook(발송 결과 리포트) 등록
|
||||
|
||||
비즈뿌리오가 발송 결과를 통보할 URL을 비즈뿌리오 콘솔에 등록해야 발송 결과(성공/실패/사유)가 발송 이력에 자동 기록됩니다.
|
||||
|
||||
> **이 등록을 하지 않으면 발송 자체는 되지만 성공/실패 여부를 확인할 수 없습니다.**
|
||||
|
||||
```text
|
||||
https://your-domain.com/api/plugins/sirsoft-message_bizppurio/webhook
|
||||
```
|
||||
|
||||
정확한 URL은 관리자 플러그인 설정 화면의 환경설정 탭에서도 복사할 수 있습니다.
|
||||
|
||||
---
|
||||
|
||||
## 발송 흐름
|
||||
|
||||
```text
|
||||
코어/모듈이 알림 발화 (예: 회원가입, 주문 완료)
|
||||
→ 알림 설정에 연결된 문자·알림톡 채널로 발송 작업 큐잉
|
||||
→ 알림톡: 카카오 승인 템플릿 사용, 미승인/미연결 시 문자로 대체발송(옵션)
|
||||
→ 문자: 본문 길이에 따라 SMS/LMS 자동 선택
|
||||
→ 비즈뿌리오 발송 API 호출
|
||||
→ 비즈뿌리오가 webhook 으로 결과(성공/실패/사유) 통보
|
||||
→ 발송 이력에 결과 기록, 실패 시 사유·결과코드 함께 기록
|
||||
```
|
||||
|
||||
일시적 오류(카카오 시스템 오류, 처리 지연, 게이트웨이 오류 등)로 실패한 경우 자동으로 재시도합니다. 지갑 잔액 부족·후불 한도 초과는 재시도 대상이 아니며, 즉시 실패 처리와 함께 관리자에게 알림이 발송됩니다.
|
||||
|
||||
---
|
||||
|
||||
## 알림톡 템플릿 연동
|
||||
|
||||
카카오 알림톡 템플릿의 **등록·수정·검수·상태변경은 비즈뿌리오 콘솔에서** 진행합니다. 이 플러그인의 설정 화면(알림톡 템플릿 탭)은 콘솔에 등록된 템플릿의 목록·상태·내용을 조회하고, 발송가능(승인) 상태의 템플릿을 알림에 연결하는 역할만 담당합니다.
|
||||
|
||||
| 상태 | 발송 가능 | 설명 |
|
||||
|:---:|:---:|------|
|
||||
| 발송가능 | ✅ | 카카오 검수 승인 완료, 알림에 연결해 발송 가능 |
|
||||
| 검수중 | ❌ | 카카오 검수 진행 중 |
|
||||
| 반려 | ❌ | 카카오 검수 반려, 콘솔에서 재신청 필요 |
|
||||
| 미검수 | ❌ | 콘솔에 등록만 되고 검수 신청 전 상태 |
|
||||
| 중지 | ❌ | 사용 중지된 템플릿 |
|
||||
|
||||
알림에 연결한 템플릿이 이후 카카오에서 삭제·차단되거나 승인이 취소되면, 알림 설정 화면의 해당 알림에 "사용 불가 — 재연결 필요"가 표시됩니다. 이 경우 알림톡 템플릿 탭에서 다른 승인 템플릿으로 다시 연결해야 합니다.
|
||||
|
||||
---
|
||||
|
||||
## 발송 결과 코드
|
||||
|
||||
비즈뿌리오/카카오가 반환하는 결과 코드는 4가지로 분류되어 처리됩니다.
|
||||
|
||||
| 분류 | 처리 방침 |
|
||||
|:---:|------|
|
||||
| 성공 | 발송 완료 |
|
||||
| 재시도 (일시 오류) | 자동 재시도 대상 (예: 카카오 시스템 오류, 처리 지연, 게이트웨이 오류) |
|
||||
| 잔액 부족 | 즉시 실패 처리 + 관리자 자체 알림 |
|
||||
| 영구 실패 | 즉시 실패 처리, 재시도하지 않음 |
|
||||
|
||||
주요 코드 예시:
|
||||
|
||||
| 코드 | 분류 | 사유 |
|
||||
|:---:|------|------|
|
||||
| `1000` `4100` `6600` `7000` | 성공 | 발송/리포트 성공 |
|
||||
| `9070` | 잔액 부족 | 잔액 부족(문자) |
|
||||
| `9071` | 잔액 부족 | 후불 한도 초과 |
|
||||
| `7436` | 잔액 부족 | 지갑 잔액 부족(알림톡) |
|
||||
| `4400` | 영구 실패 | 음영 지역 |
|
||||
| `7103` | 영구 실패 | 발신 프로필 키 무효 |
|
||||
|
||||
발송 이력 화면에는 `사유 (코드)` 형식(예: "음영 지역 (4400)")으로 표시됩니다. 전체 코드 목록은 `lang/ko/result_codes.php` / `lang/en/result_codes.php`에 정의되어 있으며, lang에 없는 코드는 코드만 표시됩니다.
|
||||
|
||||
---
|
||||
|
||||
## 가용 훅 (Hook)
|
||||
|
||||
다른 모듈이나 플러그인에서 아래 훅에 연결해 잔액부족 상황을 확장 처리할 수 있습니다.
|
||||
|
||||
### 액션 훅
|
||||
|
||||
| 훅 이름 | 시점 | 인수 |
|
||||
|------|------|------|
|
||||
| `sirsoft-message_bizppurio.balance.low` | 잔액 부족·한도 초과로 발송 실패 시 (쿨다운 내 최초 1회) | `string $resultCode, string $channel` |
|
||||
|
||||
### 훅 등록 예시
|
||||
|
||||
```php
|
||||
use App\Extension\HookManager;
|
||||
|
||||
HookManager::addAction(
|
||||
'sirsoft-message_bizppurio.balance.low',
|
||||
function (string $resultCode, string $channel) {
|
||||
// 예: 잔액 부족 시 Slack으로도 별도 알림
|
||||
SlackNotifier::send("비즈뿌리오 잔액 부족: 채널={$channel}, 코드={$resultCode}");
|
||||
},
|
||||
priority: 10
|
||||
);
|
||||
```
|
||||
|
||||
`$resultCode`는 잔액 부족(`9070` 문자 / `7436` 알림톡) 또는 후불 한도 초과(`9071`) 코드입니다. 이 훅은 관리자 자체 알림(잔액부족/후불한도초과 안내)을 발화하는 지점과 동일하며, 채널별 쿨다운(기본 3600초) 동안 한 번만 실행됩니다.
|
||||
|
||||
---
|
||||
|
||||
## API
|
||||
|
||||
전체 엔드포인트 레퍼런스는 [docs/api/README.md](docs/api/README.md)를 참고하세요.
|
||||
|
||||
| 문서 | 내용 |
|
||||
|------|------|
|
||||
| [webhook.md](docs/api/webhook.md) | 비즈뿌리오 발송 결과 리포트 수신 |
|
||||
| [templates.md](docs/api/templates.md) | 알림톡 템플릿 조회 |
|
||||
| [alimtalk-templates.md](docs/api/alimtalk-templates.md) | 알림톡 템플릿 관리자 API |
|
||||
| [notification-bindings.md](docs/api/notification-bindings.md) | 알림-템플릿 연결 |
|
||||
| [dispatch-results.md](docs/api/dispatch-results.md) | 발송 결과 조회 |
|
||||
| [report.md](docs/api/report.md) | 발송 결과 리포트 URL 조회 |
|
||||
|
||||
### 권한
|
||||
|
||||
| 권한 | 설명 |
|
||||
|------|------|
|
||||
| `sirsoft-message_bizppurio.messaging.view` | 발송 이력, 알림톡 템플릿, 발송 결과 조회 |
|
||||
| `sirsoft-message_bizppurio.messaging.manage` | 알림톡 템플릿 연결, 캐시 초기화 등 관리 작업 |
|
||||
|
||||
---
|
||||
|
||||
## 삭제 시 동작
|
||||
|
||||
플러그인을 삭제하면 이 플러그인이 알림 설정에 추가했던 문자·알림톡 채널이 함께 정리됩니다. 메일·사이트 내 알림 등 다른 채널과 알림 자체는 그대로 유지되며, 플러그인을 다시 설치하면 문자·알림톡 채널이 자동으로 복원됩니다.
|
||||
|
||||
---
|
||||
|
||||
## 보안 및 운영 참고
|
||||
|
||||
- 비즈뿌리오 비밀번호, API 키, 알림톡 발신프로필 키는 외부에 노출하지 마세요. 관리자 설정 화면에서만 입력하며 프론트엔드로 노출되지 않습니다.
|
||||
- 운영 모드 전환 전 검수 모드에서 문자·알림톡 발송 흐름을 먼저 확인하세요. 운영 모드는 실제 발송과 비용이 발생합니다.
|
||||
- webhook URL을 비즈뿌리오 콘솔에 등록하지 않으면 발송 결과 확인이 불가능합니다.
|
||||
- 검수와 운영은 별도의 비즈뿌리오 계정 사용을 권장합니다.
|
||||
- 지갑 잔액/후불 한도를 주기적으로 확인하세요. 부족 시 관리자 알림이 발송되지만, 알림 자체도 같은 채널(문자/알림톡)을 사용하지 않는 별도 채널(예: 사이트 내 알림, 메일)로 함께 받는 것을 권장합니다.
|
||||
|
||||
---
|
||||
|
||||
## 테스트
|
||||
|
||||
플러그인을 G7 프로젝트에 배치한 뒤 G7 루트에서 PHP 테스트를 실행합니다.
|
||||
|
||||
```bash
|
||||
php artisan test plugins/sirsoft-message_bizppurio/tests
|
||||
```
|
||||
|
||||
프론트엔드 테스트와 빌드는 플러그인 디렉토리에서 실행합니다.
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npm run test:run
|
||||
npm run build
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 라이선스
|
||||
|
||||
MIT
|
||||
Reference in new issue
Block a user