알림톡 발송 접수
/public/v1/messages/alimtalk202Idempotency-Key 헤더로 중복 접수를 막을 수 있다. 샌드박스 키로 호출하면 과금·실발송 없는 모의발송으로 처리된다 — 응답 모델은 같고 groupId 는 sandbox- 프리픽스의 가짜 값이라 조회·취소할 수 없다.
알아 둘 것
- 접수(202)는 발송 성공이 아닙니다. 실제 도달 여부는 응답의 `groupId` 로 결과 조회를 폴링해 확인합니다.
- 승인된 템플릿만 발송할 수 있습니다 (미승인 템플릿은 6901).
- 수신거부·중복 제외는 접수 시점에 서버가 적용합니다 — 응답의 `sendCount` 가 실제로 나가는 건수입니다.
요청 본문
- recipientsPublicRecipientDto[]필수
수신자 목록 (번호 + 수신자별 변수)
- phonestring필수
수신 번호 (하이픈 무관)
예: "01012345678"
- variablesobject선택null 가능
수신자별 변수값 (키 = 템플릿 변수명 #{키}) · 키는 한글·영문·숫자·-·_ 조합(사이 공백 허용) 20자 이내, 값은 문자열
예: {"이름":"김철수","주문번호":"A-1001"}
- removeDuplicatesboolean선택null 가능
번호 중복 제거 여부 · 기본 false (의도한 중복은 유지, 중복 시 앞의 수신자가 남는다)
예: false
- variablesobject선택null 가능
전 수신자 공통 변수값 · 같은 키는 수신자별 값이 우선한다 · 키 규칙은 recipients[].variables 와 같다
예: {"회사명":"타이탄즈"}
- scheduledAtstring선택null 가능
예약 시각 (ISO8601) · 생략하면 즉시 발송
예: "2026-08-20T10:00:00+09:00"
- tagsstring[]선택null 가능
태그 (최대 3개)
예: ["API"]
- channelIdstring필수
카카오 채널 검색용 ID (@ 유무 무관)
예: "@우리브랜드"
- templateCodestring필수
카카오 템플릿 코드 (승인건만 · 콘솔 템플릿 상세에서 확인)
예: "TPL_ORDER_01"
- fallbackPublicFallbackDto선택null 가능
대체발송
- enabledboolean필수
대체발송 사용 여부
예: true
- channelstring선택null 가능
대체 채널 (SMS·LMS)
SMSLMS - senderNumberstring선택null 가능
대체발송 발신번호 (하이픈 없이 · 승인건만)
예: "0212345678"
- titlestring선택null 가능
대체 문자 제목 (LMS) · 비우면 템플릿 제목
- messagestring선택null 가능
대체 문자 본문 · 비우면 템플릿 본문
응답
아래는 202 응답의 실제 모양입니다. 자동 생성된 스펙이 그리는 것은 data 안쪽뿐이라, 그것만 보고 짜면 값을 찾지 못합니다.
- successboolean필수
성공 응답에서는 항상 `true` 입니다.
예: true
- messagestring필수
사람이 읽는 설명. 성공에는 기본 문구가 실리므로 분기 근거로 쓰지 마세요.
예: "Request processed successfully"
- dataPublicAcceptResponse필수
요청 결과 본문
- groupIdstring필수
발송 그룹 ID · 결과 조회(폴링)의 키
- statusstring필수
접수 상태 (QUEUED 즉시 · RESERVED 예약)
예: "QUEUED"
- sendCountnumber필수
발송 수 (수신거부·중복 제외 후)
예: 1206
- optOutExcludednumber필수
수신거부로 제외된 수
예: 3
- holdAmountnumber필수
선차감 홀드 포인트
예: 13266
- scheduledAtstring필수null 가능date-time
예약 시각 · 즉시 발송은 null
- timestampstring필수date-time
응답을 만든 시각 (KST)
- methodstring필수
요청 메서드. 요청을 그대로 되비춰 줍니다.
예: "POST"
- pathstring필수
요청 경로
예: "/public/v1/messages/alimtalk"
- correlationIdstring필수
요청 추적 ID. **문의할 때 이 값을 함께 알려 주세요** — 서버 로그를 이 값으로 찾습니다.
에러
실패 응답도 봉투에 담겨 오고, 숫자 code 로 원인이 갈립니다. 이 호출에서 볼 수 있는 코드는 다음과 같습니다.