API 레퍼런스
모든 엔드포인트는 https://api.directalk.io 아래에 있고, API 키로 인증합니다. 각 페이지에는 실제 응답 모양(봉투 포함)과 복사해 바로 쓸 수 있는 코드 샘플이 있습니다.
- post알림톡 발송 접수202
/public/v1/messages/alimtalkIdempotency-Key 헤더로 중복 접수를 막을 수 있다. 샌드박스 키로 호출하면 과금·실발송 없는 모의발송으로 처리된다 — 응답 모델은 같고 groupId 는 sandbox- 프리픽스의 가짜 값이라 조회·취소할 수 없다. - post알림톡 다건 발송 접수200
/public/v1/messages/alimtalk/batchitems 1개 = 발송 그룹 1개 (최대 500개 · 전체 수신자 10만 명 이하). 항목마다 단건 발송과 같은 검증·접수를 독립으로 하므로 일부만 실패할 수 있고, 결과는 results 에 요청 순서대로 담긴다. 재시도 시 중복 접수는 항목별 idempotencyKey 로 막는다 (Idempotency-Key 헤더는 쓰지 않는다). 요청 형식 오류는 전체 400. 샌드박스 키면 항목별 모의발송. - post브랜드 메시지 발송 접수준비중
/public/v1/messages/brand - postSMS 단건 발송 접수 (문자 스코프 키 필요)준비중
/public/v1/messages/sms - get발송 그룹 결과 조회 (폴링)200
/public/v1/messages/{groupId}COMPLETED 는 발송사 제출 완료입니다. success + fail 이 sent 와 같아지면 최종 결과입니다. 24시간이 지나도 모자란 건은 결과를 받지 못한 건입니다. - get개별 메시지 결과200
/public/v1/messages/{groupId}/details수신번호는 마스킹된다. 커서 페이지네이션. - delete예약 취소200
/public/v1/messages/{groupId}발송 서버 제출 전까지만 가능하다 (6911). - delete예약 일괄 취소200
/public/v1/messagesgroupIds 를 한 트랜잭션으로 취소하고 홀드를 푼다 (최대 1,000개). 조건은 단건 취소와 같다(발송 서버 제출 전). 취소하지 못한 건은 실패가 아니라 skipped 에 사유와 함께 담긴다. groupIds 는 요청 본문(JSON)으로 보낸다. - postLMS 단건 발송 접수 (문자 스코프 키 필요)
/public/v1/messages/lms수신자 1명. 본문 2000byte 이하. 짧은 본문도 LMS 로 보내고 LMS 단가로 차감된다. - postMMS 단건 발송 접수 (문자 스코프 키 필요)
/public/v1/messages/mms수신자 1명. 이미지는 먼저 /messages/mms/attachments 로 올린 fileId 로. 샌드박스 키는 이미지 존재를 확인하지 않는다. - postMMS 이미지 업로드 (문자 스코프 키 필요)
/public/v1/messages/mms/attachmentsmultipart/form-data 의 file 1장. jpg/jpeg(RGB) · 1장 300KB 이하 · 1500×1440 미만. 받은 fileId 를 /messages/mms 의 attachmentFileIds 에 넣는다(24시간 유효 · 발송당 최대 3장·합계 900KB). 서명(X-Signature)의 본문 해시는 빈 본문 기준 — hex(sha256("")). - post문자 다건 발송 접수 (문자 스코프 키 필요)
/public/v1/messages/sms/bulk수신자 여러 명(최대 10만) · 발송 그룹 1개. 종류는 서버가 정한다 — 템플릿에 #{변수}가 없으면(본문고정형) (광고)·080 포함 90byte 이하·제목 없음이면 SMS, 아니면 LMS. #{변수}가 있으면(본문변수형) 무조건 LMS. MMS 는 단건(/messages/mms)만.