메시지서비스 알림톡 API 규격서 ver. 2025.11.07
알림톡 REST API
- 알림톡 발송
- 템플릿
- 전송 결과
- 잔액 조회
알림톡 발송
기본정보
HEADERS
Content-Type application/json;charset=UTF-8
AUTH base64_encode ( API Key )
알림톡 발송
알림톡의 발송 가능 문자수는 한/영 구분 없이 1,000자까지 발송 가능합니다.
반드시 변수 포함 1,000자 이내로 작성해주셔야 합니다.
발신번호는 '발신번호 관리'에서 등록된 번호여야 합니다.
URL
POST https://alimtalk.bizservice.iwinv.kr/api/v2/send/
BODY
{
"templateCode": "10030",
"reserve": "Y",
"sendDate": "2025-07-20 05:00:00",
"reSend": "Y",
"resendCallback": "01000000000",
"resendType": "Y",
"resendTitle": "smstitle",
"resendContent": "smscontent",
"list":
[
{
"phone": "01012341234",
"templateParam": ["11","2","3"]
},
{
"phone": "01012341235",
"templateParam": ["1","2","3"]
},
{
"phone": "01012341236",
"templateParam": ["1","2","3"]
}
]
}
| 값 | 타입 | 필수 | 설명 | 예시 |
|---|---|---|---|---|
| templateCode | String | O | 사용 가능한 템플릿 코드 | 10001 |
| reserve | String | X (기본 N) | 예약발송 여부(N:즉시발송, Y:예약발송) | Y , N |
| sendDate | String | X | 발송 시각(예약 발송인 경우 필수, 예약 발송은 현재 시간 15분 이후 이틀 이전까지만 가능합니다.) | yyyy-MM-dd HH:mm:ss |
| reSend | String | X (기본 N) | 알림톡 발송 실패 시 대체 문자 전송 기능(Y:대체 발송, N:대체 발송 없음) | Y , N |
| resendCallback | String | O | 발신번호 | 010-0000-0000 혹은 01000000000 |
| resendType | String | X (기본 Y) | 대체 발송 내용 타입 (Y:알림톡 내용, N:직접 입력) | Y , N |
| resendTitle | String | X | 실패 시 LMS 대체 문자 제목 | - |
| resendContent | String | X | 실패 시 대체 문자 내용(대체 발송 내용 타입 직접 입력 시 필수) | SMS(90Bytes 이하) / LMS(91~2000 Bytes) |
| list | Array | O | 수신자 리스트(최대 1000명) | - |
| - phone | Array | O | 수신번호 | 010-0000-0000 혹은 01000000000 |
| - templateParam | Array | X | 템플릿 변수(템플릿 내용 중 치환할 항목(변수) 포함 시 필수) | [["항목1","항목2","항목3"],["항목1","항목2","항목3"]] |
응답
{
"code": 200,
"message": "메시지가 발송되었습니다",
"success": 3,
"fail": 1
}
| 값 | 타입 | 설명 |
|---|---|---|
| code | Integer | 응답 코드 |
| message | String | 응답 코드 결과 메시지 |
| success | Integer | 정상적으로 전송 요청된 연락처 개수 |
| fail | Integer | 중복번호로 인해 전송 요청되지 않은 연락처 개수 |
알림톡 발송 결과 코드 값
| 코드 | 설명 |
|---|---|
| 200 | 메시지가 발송되었습니다. |
| 501 | ( templateCode )값을 정확히 입력해 주세요. |
| 502 | ( ist )값을 정확히 입력해 주세요. |
| 503 | ( reSend )값을 정확히 입력해 주세요. |
| 504 | 유효하지 않는 값(resendType)입니다. |
| 505 | 발신번호는 발신번호 관리에서 사전에 등록된 발신번호로만 발송이 가능합니다. |
| 506 | 유효하지 않는 값(sendDate)입니다. |
| 507 | 예약 전송은 현재 시간 15분 이후 이틀 이전까지만 가능합니다. |
| 508 | templateParam은(는) 필수 입력 항목입니다. |
| 509 | 메시지 내용이 템플릿과 일치하지 않습니다. |
| 510 | 제목은 40 Bytes 까지만 입력이 가능합니다. |
| 511 | 제목 입력 가능 문자 : 한글, 영어, 숫자, 허용된 특수문자는 ( [ ] ( ) < > )입니다. |
| 512 | 수신 번호를 입력하여 주세요. |
| 513 | 핸드폰 번호 형식(예: 010-1234-45678 혹은 01012345678)에 맞춰 입력하여 주십시오. |
| 514 | 알림톡 발송은 1회 최대 10,000건까지 전송 가능합니다. |
| 515 | 대체 발송 메시지는 1,000자까지만 입력이 가능합니다. |
| 516 | 대체 발송으로 알림톡 내용 발송 시 변수가 치환되어 1,000자까지만 입력할 수 있습니다. |
| 517 | 알림톡 메시지 변수가 치환되어 1,000자까지만 입력할 수 있습니다. |
| 518 | 요금 충전 호출에 실패했습니다. |
| 519 | 잔액이 부족합니다. |
| 540 | 금칙어가 포함되어 메지시 발송이 금지 됩니다. (금칙어 : ooo ) |
템플릿
기본정보
HEADERS
Content-Type application/json;charset=UTF-8
AUTH base64_encode ( API Key )
템플릿 리스트
등록된 템플릿 목록을 조회합니다.
URL
POST https://alimtalk.bizservice.iwinv.kr/api/template/
BODY
{
"pageNum": "1",
"pageSize": "15",
"templateCode": "10030",
"templateName": "test1",
"templateStatus": "R"
}
| 값 | 타입 | 필수 | 설명 | 예시 |
|---|---|---|---|---|
| pageNum | Integer | X | 페이지 번호(기본:1) | 1 |
| pageSize | Integer | X | 조회 건수(기본:15, 최대:1000) | 10 |
| templateCode | String | X | 템플릿 코드 | 10001 |
| templateName | String | X | 템플릿 이름 | 템플릿 이름 |
| templateStatus | String | X | 템플릿 상태 코드(Y:사용가능, I:검수중, R:부결(반려)) | Y |
응답
{
"code": 200,
"message": "정상적으로 호출하였습니다.",
"totalCount": 2,
"list":
[
{
"templateCode": "10036",
"templateName": "알림",
"templateContent": "#{이름} 고객님 우리 회사와 거래하여주셔서 감사합니다.",
"status": "Y",
"templateStatusMsg": "status 설명",
"templateStatusComments": "템플릿 검수결과 부결시(R) 부결사유 표시",
"createDate": "2021-06-21 10:01:31",
"buttons":
[
{
"ordering": null,
"name": "iwinv",
"linkType": "WL",
"linkTypeName": "웹링크",
"linkMo": "https://www.iwinv.kr/board/notice/read?branch=NEWS&idx=#{idx}",
"linkPc": "https://www.iwinv.kr/board/notice/read?branch=NEWS&idx=#{idx}",
"linkIos": null,
"linkAnd": null
}
]
}
]
}
| 값 | 타입 | 설명 |
|---|---|---|
| code | Integer | 응답 코드 |
| message | String | 응답 코드 결과 메시지 |
| totalCount | Integer | 등록된 템플릿 총 개수 |
| list | JSON | 템플릿 리스트 |
| - templateCode | String | 템플릿 코드 |
| - templateName | String | 등록된 템플릿 명 |
| - templateContent | String | 등록된 템플릿 내용 |
| - status | String | 상태(Y:사용가능, I:검수중, R:부결(반려)) |
| - templateStatusMsg | String | 상태설명(Y:사용가능, I:검수중, R:부결(반려)) |
| - templateStatusComments | String | 부결시 부결사유 |
| - createDate | String | 사용 가능 일시 |
| - buttons | Array | 템플릿 버튼 정보 |
| -- ordering | String | 버튼 순서(1~5) |
| -- name | String | 버튼명 |
| -- linkType | String | 버튼 타입(WL:웹링크, AL:앱링크, DS:배송조회, BK:봇키워드, MD:메시지전달) |
| -- linkTypeName | String | 버튼 타입명 |
| -- linkMo | String | 모바일 웹 링크(WL) |
| -- linkPc | String | PC 웹 링크(WL) |
| -- linkIos | String | IOS 앱링크(AL) |
| -- linkAnd | String | 안드로이드 앱링크(AL) |
템플릿 생성
알림톡은 미리 지정한 템플릿만 사용 가능합니다.
한/영 구분 없이 띄어쓰기 포함 1,000자까지 발송 가능합니다.
템플릿 검수 기간은 2~3 영업일 소요되며, 신청한 내용에 따라 더 걸릴 수 있습니다.
URL
POST https://alimtalk.bizservice.iwinv.kr/api/template/add/
BODY
{
"templateName": "템플릿명",
"templateContent": "템플릿 내용",
"buttons":
[
{
"type": "WL",
"name": "웹링크",
"linkMo": "https://www.iwinv.kr/board/notice/read.html?branch=NEWS&idx=#{idx}",
"linkPc": "https://www.iwinv.kr/board/notice/read.html?branch=NEWS&idx=#{idx}"
},
{
"type": "AL",
"name": "앱링크",
"linkIos": "https://www.iwinv.kr/board/notice/read.html?branch=NEWS&idx=#{idx}",
"linkAnd": "https://www.iwinv.kr/board/notice/read.html?branch=NEWS&idx=#{idx}"
},
{
"type": "DS",
"name": "배송조회"
},
{
"type": "BK",
"name": "봇 키워드"
},
{
"type": "MD",
"name": "메시지 전달"
}
]
}
| 값 | 타입 | 필수 | 설명 | 예시 |
|---|---|---|---|---|
| templateName | String | O | 템플릿명(최대 15자) | 템플릿명 |
| templateContent | String | O | 템플릿 내용(최대1000자) | 가변 항목은 #{항목} 형태로 최대 10개까지 등록이 가능합니다. |
| buttons | JSON | X | 템플릿 버튼(최대 5개) | - |
| - type | String | X | 버튼 타입 | WL:웹링크, AL:앱링크, DS:배송조회, BK:봇 키워드, MD:메시지 전달 |
| - name | String | X | 버튼 이름(버튼이 있는 경우 필수, 최대 15자) | - |
| - linkMo | String | X | 모바일 웹 링크(WL 타입일 경우 필수, 최대200자) | http:// 또는 Https:// |
| - linkPc | String | X | PC 웹 링크(WL 타입일 경우 필수, 최대200자) | http:// 또는 Https:// |
| - linkIos | String | X | IOS 앱 링크(AL 타입일 경우 필수, 최대200자) | - |
| - linkAnd | String | X | Android 앱 링크(AL 타입일 경우 필수, 최대200자) | - |
응답
{
"code": 200,
"templateCode": "10031",
"message": "정상적으로 템플릿을 생성하였습니다."
}
| 값 | 타입 | 설명 |
|---|---|---|
| code | Integer | 응답 코드 |
| templateCode | String | 템플릿 코드 |
| message | String | 응답 코드 결과 메시지 |