Classic/VPC 환경에서 이용 가능합니다.
모든 사용자를 대상으로 하는 정보 전달성 알림톡 메시지를 발송합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| POST | /alimtalk/v2/services/{serviceId}/messages |
요청 헤더
Simple & Easy Notification Service API에서 공통으로 사용하는 헤더에 대한 정보는 Simple & Easy Notification Service 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
serviceId |
String | Required | Biz Message 서비스 아이디
|
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
plusFriendId |
String | Required | 채널 아이디
|
templateCode |
String | Required | 템플릿 코드
|
messages |
Array | Required | 메시지 정보
|
reserveTime |
String | Optional | 예약 일시
|
reserveTimeZone |
String | Optional | 예약 타임존
|
참고
템플릿에 이미지가 등록된 경우, 알림톡 메시지에 이미지가 자동으로 추가됩니다.
messages
messages에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
countryCode |
String | Optional | 국가 코드
|
to |
String | Required | 수신 번호
|
title |
String | Optional | 강조 정보 제목
|
content |
String | Required | 메시지 내용 |
headerContent |
String | Optional | 알림톡 헤더(Bytes)
|
itemHighlight |
Object | Optional | 아이템 하이라이트 정보
|
itemHighlight.title |
String | Conditional | 아이템 하이라이트 제목
|
itemHighlight.description |
String | Conditional | 아이템 하이라이트 내용 |
item |
Object | Optional | 아이템 리스트 정보
|
item.list |
Array | Conditional | 아이템 리스트
|
item.summary |
Object | Optional | 아이템 요약 정보
|
item.summary.title |
String | Conditional | 아이템 요약 제목
|
item.summary.description |
String | Conditional | 아이템 요약 내용
|
buttons |
Array | Optional | 메시지 버튼 정보 |
useSmsFailover |
Boolean | Optional | SMS 대체 발송 사용 여부
|
failoverConfig |
Object | Optional | 대체 발송 설정 |
failoverConfig.type |
String | Optional | 메시지 타입
|
failoverConfig.from |
String | Optional | 발신 번호
|
failoverConfig.subject |
String | Optional | 메시지 제목
|
failoverConfig.content |
String | Optional | 메시지 내용
|
참고
content,buttons는 등록 및 검수된 템플릿에 맞추어 입력해 주십시오. 템플릿 규격에 맞지 않으면 발송이 실패할 수 있습니다.- SMS 대체 발송 기능은 Biz Message 수신 결과 코드를 기준으로 성공하지 않은 경우에 동작하며, 'B' 접두어가 붙은 코드일 경우에는 동작하지 않습니다.
- 템플릿에 이미지가 등록된 경우 별도로 메시지 발송 시, 요청 바디에 해당 내용을 넣지 않아도 등록된 이미지가 발송됩니다.
- 템플릿 등록 및 검수에 대한 자세한 내용은 AlimTalk Template 사용 가이드를 참조해 주십시오.
item.list
item.list에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
title |
String | Required | 아이템 이름
|
description |
String | Required | 아이템 내용
|
buttons
buttons에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
type |
String | Required | 버튼 유형
|
name |
String | Required | 버튼 이름
|
linkMobile |
String | Conditional | 모바일 웹 링크
|
linkPc |
String | Conditional | PC 웹 링크
|
schemeIos |
String | Conditional | iOS 앱 링크
|
schemeAndroid |
String | Conditional | Android 앱 링크
|
참고
모든 필드는 등록 및 검수된 템플릿에 맞추어 입력해 주십시오. 템플릿 규격에 맞지 않으면 발송이 실패할 수 있습니다.
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request POST 'https://sens.apigw.ntruss.com/alimtalk/v2/services/ncp:kkobizmsg:kr:27*********6:sens/messages' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"plusFriendId": "@******",
"templateCode": "temp001",
"messages": [
{
"countryCode": "82",
"to": "010********",
"content": "홍길동 님,\n요청하신 [PO394857] 번역 문서가 오늘 18:00에 메일로 전달될 예정입니다.\n\n메일 전송 후 알림을 보내드리겠습니다.\n감사합니다.",
"useSmsFailover": true,
"failoverConfig": {
"type": "SMS",
"from": "010********",
"content": "홍길동 님,\n요청하신 [PO394857] 번역 문서가 오늘 18:00에 메일로 전달될 예정입니다.\n\n메일 전송 후 알림을 보내드리겠습니다.\n감사합니다."
}
}
]
}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
requestId |
String | Required | 요청 아이디 |
requestTime |
String | Required | 요청 일시
|
statusCode |
String | Required | 상태 코드
|
statusName |
String | Required | 상태
|
messages |
Array | Required | 메시지 정보
|
messages
messages에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
messageId |
String | Required | 메시지 아이디 |
countryCode |
String | Optional | 국가 코드 |
to |
String | Required | 수신 번호 |
content |
String | Required | 메시지 내용 |
requestStatusCode |
String | Required | 요청 상태 코드
|
requestStatusName |
String | Required | 요청 상태
|
requestStatusDesc |
String | Required | 요청 상태 설명 |
useSmsFailover |
Boolean | Required | SMS 대체 발송 사용 여부
|
응답 상태 코드
Simple & Easy Notification Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Simple & Easy Notification Service 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"requestId": "RBAA-*************-****-********-zgrtzVEW",
"requestTime": "2025-11-25T15:39:20.899",
"statusCode": "202",
"statusName": "processing",
"messages": [
{
"messageId": "aa724ca6-****-****-****-66dfc1a700e7",
"countryCode": "82",
"to": "010********",
"content": "홍길동 님,\n요청하신 [PO394857] 번역 문서가 오늘 18:00에 메일로 전달될 예정입니다.\n\n메일 전송 후 알림을 보내드리겠습니다.\n감사합니다.",
"requestStatusCode": "A000",
"requestStatusName": "success",
"requestStatusDesc": "성공",
"useSmsFailover": true
}
]
}
지원 택배사 목록
웹 링크(WL) 버튼을 통해 배송 조회 페이지에 연결할 수 있는 택배사 목록은 다음과 같습니다.
참고
미지원 택배사의 경우, 버튼이 자동으로 추가되지 않습니다.
| 택배사 | 택배 이름 | 송장 번호 |
|---|---|---|
| 우체국택배 | 우체국 | 숫자 13자리 또는 숫자 [6+7]자리
|
| 로젠택배 | 로젠, 로잰 | 숫자 11자리 또는 숫자 [3+4+4]자리
|
| 일양로지스 |
|
숫자 9~11자리 |
| FedEX |
|
숫자 12자리 |
| 한진택배 | 한진택배 | 숫자 10자리 또는 숫자 12자리 |
| 경동택배 | 경동택배 | 숫자 9~16자리 또는 숫자 [4+3+6]자리
|
| 합동택배 | 합동택배 | 숫자 9~16자리 |
| 롯데택배 |
|
숫자 12자리 또는 숫자 [4+4+4]자리
|
| 농협택배 | 농협택배 | 숫자 12자리 |
| 호남택배 | 호남택배 | 숫자 10자리 |
| 천일택배 | 천일택배 | 숫자 11자리 |
| 대신택배 | 대신택배 | 숫자 13자리 |
| 건영택배 | 건영택배 | 숫자 10자리 |
| CU편의점택배 |
|
숫자 10자리 또는 숫자 12자리 또는 숫자 [4+4+4]자리
|
| CVSnet편의점택배 |
|
숫자 10자리 또는 숫자 12자리 또는 숫자 [4+4+4]자리
|
| 한덱스 | 한덱스 | 숫자 10자리 또는 숫자 14자리 |
| TNT Express |
|
숫자 8~9자리 |
| USPS | USPS | 숫자 10자리 또는 숫자 22자리 또는 [영문 대문자 2자리 + 숫자 9자리 + 영문 대문자 2자리]
|
| EMS | EMS | 영문 대문자 2자리 + 숫자 9자리 + 영문 대문자 2자리
|
| DHL | DHL | 숫자 10자리 |
| 굿투럭 | 굿투럭 | 숫자 [4+4+4]자리
|