알림톡
알림톡은 기업 고객이 사용자에게 정보성 카카오톡 메시지를 발송하는 서비스이며, 카카오톡 채널과 친구를 맺지 않은 사용자에게도 발송할 수 있습니다.
알림톡으로 전송 가능한 메시지는 정보통신망법 관련 한국인터넷진흥원(KISA) 가이드상 ‘광고성 정보의 예외’ 중 사용자 보호 차원에서 서비스에 적합하다고 보는 일부 정보성 메시지에 한합니다. 예를 들어 고객의 행동에 따라 즉각적으로 발송하는 정보성 내용인 주문/예약 확인, 결제 내역, 배송 현황 메시지 등이 해당합니다. 구독자 대상의 뉴스레터, 회원가입 축하, 공지문 등은 정보성 메시지에 포함되지 않습니다.
알림톡으로 스팸 메시지를 발송하는 경우, 알림톡 및 카카오톡 채널 운영이 중단될 수 있으며 과태료가 부과될 수 있습니다. 정보성 메시지 관련 상세 내용은 KISA 불법스팸대응센터를 통해 확인할 수 있습니다. 자세한 설명은 KISA 불법 스팸 방지를 위한 정보통신망법 안내서(제5차 개정판) 바로가기를 참고하시기 바랍니다.
안내
- 알림톡 발송 API를 호출하기 전, OAuth 2.0 인증 API를 선제적으로 호출해야 합니다.
- API 기능별 예제는 Sample Code 문서를 참고하시기 바랍니다.
- 알림톡/친구톡 발송 시 버튼/이미지/강조 표기 등을 사용할 경우, 반드시 메시지 타입별 가이드를 준수해야 합니다.
주의
스테이징 서버는 카카오 운영 서버와 연동되어 있어 실제 메시지가 발송되므로, 메시지 오발송에 주의하시기 바랍니다.
알림톡만 발송하기
Push 방식으로 알림톡을 발송을 계약한 경우, 다음의 API를 사용하여 알림톡을 발송하고 응답(Response)으로 발송 결과를 즉시 확인할 수 있습니다.
Request
Request Syntax
코드예제알림톡 발송 Request Syntax
curl -X POST "https://{base_url}/v2/send/kakao" \
-H "accept: */*" \
-H "authorization: Bearer {access_token}" \
-H "Content-Type: application/json" \
-d '{
"message_type": "AT",
"sender_key": "{senderKey}",
"cid": "202210181600001",
"template_code": "TEMPLATE_001",
"phone_number": "01012341234",
"sender_no": "021112222",
"message": " 알림톡 메시지",
"fall_back_yn": false
}'
메서드 | 요청 URL |
---|---|
POST | https://{base_url}/v2/send/kakao |
파라미터 | 유형 | 필수 여부 | 대분류 | 구분 | 설명 |
---|---|---|---|---|---|
base_url | String | 필수 |
운영 | 일반 | bizmsg-web.kakaoenterprise.com |
금융권 | bizmsg-bank.kakaoenterprise.com |
||||
증권 | bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | bizmsg-gov.kakaoenterprise.com |
||||
스테이징 | 일반 | stg-user.bizmsg.kakaoenterprise.com |
|||
금융권 | stg-bizmsg-bank.kakaoenterprise.com |
||||
증권 | stg-bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | stg-bizmsg-gov.kakaoenterprise.com |
Request Header
표알림톡 발송 Request Header파라미터 | 유형 | 필수 여부 | 설명 |
---|---|---|---|
accept | MIME | */* 로 고정 |
|
authorization | String | Bearer {oauthToken} - {oauthToken} : OAuth 2.0 인증 API로 발급받은 액세스 토큰 |
|
Content-Type | String | application/json 으로 고정 |
Request Elements
표알림톡 발송 Request Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
message_type | String | 필수 |
알림톡 메시지 타입 - AT 로 고정- text(2) |
sender_key | String | 필수 |
발신 프로필 키 - 비즈 사이트에서 채널 생성 시 발급 - text(40) |
cid | String | 필수 |
고객사 정의 Key ID - 메시지의 일련번호 |
template_code | String | 필수 |
실제 발송할 메시지 유형으로 등록된 템플릿의 코드 - text(30) |
phone_number | String | 필수 |
수신자 전화번호(국가코드(82 ) 포함)- text(16) |
sender_no | String | 필수 |
고객사 발신 전화번호 - text(16) |
message | String | 필수 |
수신자에게 전달할 알림톡 메시지 - text(1000) |
client_id | String | 선택 |
고객사 ID - 계약 시 발급받는 정보 |
price | Integer | 선택 |
message(수신자에게 전달될 메시지) 내 포함된 가격/금액/결제금액 |
currency_type | String | 선택 |
message(수신자에게 전달될 메시지) 내 포함된 가격/금액/결제금액의 통화단위 - KRW, USD, EUR 등 국제 통화 코드 사용 |
title | String | 선택 |
템플릿 내용 중 강조 표기할 핵심 정보 - text(50) |
header | String | 선택 |
메시지 상단에 표기할 제목 - text(16) |
timeout | Integer | 선택 |
Polling 방식 전송 시 성공 여부를 결정하기 위한 시간 |
Array | 선택 |
버튼 목록 정보 | |
chat_event | String | 선택 |
Bot 전환 시 연결할 Bot 이벤트명 |
chat_extra | String | 선택 |
상담톡/Bot 전환 시 전달할 메타 정보 |
name | String | 필수 |
버튼 제목 |
scheme_android | String | 선택 |
Mobile Android 환경에서 버튼 클릭 시 실행할 application custom scheme |
scheme_ios | String | 선택 |
Mobile iOS 환경에서 버튼 클릭 시 실행할 application custom scheme |
type | String | 필수 |
버튼 타입 |
url_mobile | String | 선택 |
Mobile 환경에서 버튼 클릭 시 이동할 URL |
url_pc | String | 선택 |
PC 환경에서 버튼 클릭 시 이동할 URL |
Array | 선택 |
바로가기 목록 정보 | |
chat_event | String | 선택 |
Bot 전환 시 연결할 Bot 이벤트명 |
chat_extra | String | 선택 |
상담톡/Bot 전환 시 전달할 메타정보 |
name | String | 필수 |
버튼 제목 |
scheme_android | String | 선택 |
Mobile Android 환경에서 버튼 클릭 시 실행할 Application custom scheme |
scheme_ios | String | 선택 |
Mobile iOS 환경에서 버튼 클릭 시 실행할 Application custom scheme |
type | String | 필수 |
버튼 타입 - 버튼 가이드 참고 |
url_mobile | String | 선택 |
Mobile 환경에서 버튼 클릭 시 이동할 URL |
url_pc | String | 선택 |
PC 환경에서 버튼 클릭 시 이동할 URL |
biz_no | String | 선택 |
최초 발신자 식별 코드 (재판사용) |
fall_back_yn | Boolean | 필수 |
대체 메시지 전송 여부 |
true : 대체 메시지를 전송 |
|||
false (기본값): 대체 메시지를 전송하지 않음 |
|||
fall_back_message_type | String | 선택 |
대체 메시지 발송 시, 메시지 유형 - text(2) |
SM : SMS로 대체 발송 |
|||
LM : LMS로 대체 발송 |
|||
fall_back_title | String | 선택 |
대체 발송 메시지 제목 |
fall_back_message | String | 선택 |
대체 발송 메시지 본문 - text(2000) |
Item | 선택 |
아이템 리스트와 아이템 요약 정보 | |
필수 |
아이템 리스트 | ||
title | String | 필수 |
타이틀 - text(6) |
description | String | 필수 |
부가 정보 - text(23) |
Object | 선택 |
아이템 요약 정보 | |
title | String | 필수 |
타이틀 - text(6) |
description | String | 필수 |
가격 정보 - 통화기호(유니코드 통화기호, 元, 円, 원)만 허용 - 소수점 2자리까지 입력 가능 - text(14) |
Object | 선택 |
아이템 하이라이트 | |
title | String | 필수 |
타이틀 - 이미지가 있는 경우 최대 21자 - text(30) |
description | String | 필수 |
부가정보 - 이미지가 있는 경우 최대 13자 - text(19) |
tax_cd1 | String | 선택 |
정산 코드 1 - 고객사가 정산을 위해 정의하여 사용하는 변수 - text(50) |
tax_cd2 | String | 선택 |
정산 코드 2 - 고객사가 정산을 위해 정의하여 사용하는 변수 - text(50) |
Response
다음의 코드 예제는 알림톡 발송을 Push 방식으로 계약한 경우에 해당합니다. 만약 알림톡 발송을 Polling 방식을 계약한 경우, 수동으로 알림톡 발송 결과 요청과 완료 요청을 수행해야 합니다. 자세한 설명은 알림톡 발송 결과 요청(Polling)을 참고하시기 바랍니다.
Response Syntax
코드예제알림톡 발송 Response Syntax
{
"code": "200",
"uid": "",
"cid": "",
"result": {
"detail_code": "NRM0000",
"detail_message": "성공"
}
}
Response Elements
표알림톡 발송 Response Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
code | String | 필수 |
메시지 발송 결과 코드 |
100 : 발송 진행 중(처리 중) |
|||
200 : 성공 |
|||
400 : 권한 오류 |
|||
410 : 입력값이 유효하지 않음 |
|||
420 : 파일/이미지 관련 오류 |
|||
500 : 내부 시스템 오류 |
|||
510 : 발송 실패 |
|||
520 : 실패되었으나 재발송 가능 |
|||
uid | String | 필수 |
메시지 Key ID |
cid | String | 필수 |
고객사 정의 Key ID |
Object | 필수 |
세부 결과 정보(참고용) | |
detail_code | String | 필수 |
세부 결과 코드(참고용) |
detail_message | String | 필수 |
세부 결과 메시지(참고용) |
안내
API 기능 별 코드는 Sample Code 문서를 참고하시기 바랍니다.
알림톡 발송 결과 요청(Polling)
알림톡 발송을 Push 방식이 아닌 Polling 방식으로 계약한 경우, 다음의 API를 사용하여 알림톡 발송 결과를 요청해야 합니다.
안내
알림톡 발송 방식 중 Polling 계약 혹은 SMS/LMS(대체 발송 포함)를 사용하는 경우, 해당 API를 통해 최대 1000건의 결과를 수신받을 수 있습니다.
- 메시지 결과 요청 후 완료(알림톡 발송 결과 완료) 처리를 해야 처리된 결과를 재조회하지 않습니다.
Request
Request Syntax
코드예제알림톡 발송 결과 요청 Request Syntax
curl -X 'GET' \
'https://{base_url}/v2/info/message/results' \
-H 'accept: */*' \
-H 'Authorization: Bearer {oauthToken}'
메서드 | 요청 URL |
---|---|
GET | https://{base_url}/v2/info/message/results |
파라미터 | 유형 | 필수 여부 | 대분류 | 구분 | 설명 |
---|---|---|---|---|---|
base_url | String | 필수 |
운영 | 일반 | bizmsg-web.kakaoenterprise.com |
금융권 | bizmsg-bank.kakaoenterprise.com |
||||
증권 | bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | bizmsg-gov.kakaoenterprise.com |
||||
스테이징 | 일반 | stg-user.bizmsg.kakaoenterprise.com |
|||
금융권 | stg-bizmsg-bank.kakaoenterprise.com |
||||
증권 | stg-bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | stg-bizmsg-gov.kakaoenterprise.com |
Request Header
표알림톡 발송 결과 요청 Request Header파라미터 | 유형 | 필수 여부 | 설명 |
---|---|---|---|
accept | String | 필수 |
*/* 로 고정 |
Authorization | String | 필수 |
Bearer {oauthToken} - {oauthToken} : OAuth 2.0 인증 API로 발급받은 액세스 토큰 |
Response
Response Syntax
코드예제알림톡 발송 결과 요청 Response Syntax
{
"code": "200",
"code_detail": {
"detail_code": "NRM00000",
"detail_message": "성공"
},
"report_group_no": "8493608862033069978",
"results": [
{
"seq_no": 266931826,
"client_id": "",
"uid": "220918080309405KFXrvK8CR9e+k8s",
"cid": "77613652af2d464580796c41cf0d39a3",
"status_code": "API_200",
"sms_status_code": "-100",
"ended_yn": "Y",
"ended_date": "2022-09-18T08:04:04",
"message_type": "SM"
}
]
}
Response Elements
표알림톡 발송 결과 요청 Response Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
code | String | 필수 |
메시지 발송 결과 코드 |
100 : 발송 진행 중(처리 중) |
|||
200 : 성공 |
|||
400 : 권한 오류 |
|||
410 : 입력값이 유효하지 않음 |
|||
420 : 파일/이미지 관련 오류 |
|||
500 : 내부 시스템 오류 |
|||
510 : 발송 실패 |
|||
520 : 실패되었으나 재발송 가능 |
|||
Object | 선택 |
상세 코드 정보 | |
detail_code | String | 선택 |
상세 코드 |
detail_message | String | 선택 |
상세 메시지 |
report_group_no | String | 선택 |
메시지 결과 그룹 고유 번호 |
Array | 선택 |
메시지 결과 조회 리스트 | |
seq_no | Integer | 필수 |
메시지 결과 일련 번호 |
uid | String | 선택 |
메시지의 Key ID |
cid | String | 선택 |
고객사 정의 Key ID |
status_code | String | 선택 |
메시지 상태 코드 - 상세 정보는 API 메시지 상태 코드 참고 |
kko_status_code | String | 선택 |
카카오톡에서 전송되는 처리 결과 코드 |
sms_status_code | String | 선택 |
SMS 처리 결과 코드 |
ended_yn | String | 선택 |
메시지 결과 수신 완료 여부 |
Y : 수신 완료 |
|||
N : 수신 미완료 |
|||
ended_date | String | 선택 |
메시지 결과 수신 완료 날짜 |
알림톡 발송 결과 완료(Polling)
처리가 완료된 메시지 결과를 완료 처리하는 API입니다.
Request
Request Syntax
코드예제알림톡 발송 결과 완료 Request Syntax
curl -X 'PUT' \
'https://{base_url}/v2/info/message/results/complete/{report_group_no}' \
-H 'accept: */*' \
-H 'Authorization: Bearer {oauthToken}'
메서드 | 요청 URL |
---|---|
PUT | https://{base_url}/v2/info/message/results/complete/{report_group_no} |
파라미터 | 유형 | 필수 여부 | 대분류 | 구분 | 설명 |
---|---|---|---|---|---|
base_url | String | 필수 |
운영 | 일반 | bizmsg-web.kakaoenterprise.com |
금융권 | bizmsg-bank.kakaoenterprise.com |
||||
증권 | bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | bizmsg-gov.kakaoenterprise.com |
||||
스테이징 | 일반 | stg-user.bizmsg.kakaoenterprise.com |
|||
금융권 | stg-bizmsg-bank.kakaoenterprise.com |
||||
증권 | stg-bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | stg-bizmsg-gov.kakaoenterprise.com |
||||
report_group_no | String | 필수 |
메시지 결과 그룹 고유 번호 - ex. 8493608862033069978 |
Request Header
표알림톡 발송 결과 완료 Request Header파라미터 | 유형 | 필수 여부 | 설명 |
---|---|---|---|
accept | String | 필수 |
*/* 로 고정 |
Authorization | String | 필수 |
Bearer {oauthToken} - {oauthToken} : OAuth 2.0 인증 API로 발급받은 액세스 토큰 |
Response
Response Syntax
코드예제알림톡 발송 결과 완료 Response Syntax
{
"code": "200",
"code_detail": {
"detail_code": "NRM00000",
"detail_message": "성공"
}
}
Response Elements
표알림톡 발송 결과 완료 Response Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
code | String | 필수 |
메시지 발송 결과 코드 |
100 : 발송 진행 중(처리 중) |
|||
200 : 성공 |
|||
400 : 권한 오류 |
|||
410 : 입력값이 유효하지 않음 |
|||
420 : 파일/이미지 관련 오류 |
|||
500 : 내부 시스템 오류 |
|||
510 : 발송 실패 |
|||
520 : 실패되었으나 재발송 가능 |
|||
Object | 선택 |
메시지 상태 상세 코드 | |
detail_code | String | 선택 |
상세 코드 |
detail_message | String | 선택 |
상세 메시지 |
알림톡 발송 리스트 조회
알림톡 발송 리스트를 조회하는 API는 다음과 같습니다.
Request
Request Syntax
코드예제알림톡 발송 리스트 조회 Request Syntax
curl -X 'POST' \
'https://{base_url}/v2/info/message/search' \
-H 'accept: */*' \
-H 'Authorization: Bearer {oauthToken}' \
-H 'Content-Type: application/json' \
-d '{
"start_date": "2022-10-18",
"end_date": "2022-10-18",
"size": 1000
}'
메서드 | 요청 URL |
---|---|
POST | https://{base_url}/v2/info/message/search |
파라미터 | 유형 | 필수 여부 | 대분류 | 구분 | 설명 |
---|---|---|---|---|---|
base_url | String | 필수 |
운영 | 일반 | bizmsg-web.kakaoenterprise.com |
금융권 | bizmsg-bank.kakaoenterprise.com |
||||
증권 | bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | bizmsg-gov.kakaoenterprise.com |
||||
스테이징 | 일반 | stg-user.bizmsg.kakaoenterprise.com |
|||
금융권 | stg-bizmsg-bank.kakaoenterprise.com |
||||
증권 | stg-bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | stg-bizmsg-gov.kakaoenterprise.com |
Request Header
표알림톡 발송 리스트 조회 Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
accept | String | 필수 |
*/* 로 고정 |
Authorization | String | 필수 |
Bearer {oauthToken} - {oauthToken} : OAuth 2.0 인증 API로 발급받은 액세스 토큰 |
Content-Type | String | 필수 |
application/json 로 고정 |
Request Elements
표알림톡 발송 리스트 조회 Request Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
start_date | String | 선택 |
검색 시작일 - 형식: yyyy-mm-dd (date)- 시작일 입력 시 종료일도 필수 입력, 입력값이 없을 경우 당일 데이터를 검색 |
end_date | String | 선택 |
검색 종료일 - 형식: yyyy-mm-dd (date)- 종료일 입력 시 시작일도 필수 입력, 입력값이 없을 경우 당일 데이터를 검색 |
client_id | String | 선택 |
발송 고객사 ID |
size | Integer | 선택 |
페이지 당 리스트 수 - 최댓값: 1000 - int32 |
last_uid | String | 선택 |
조회한 페이지 리스트의 마지막 메시지 Key ID - 다음 페이지 조회 시 필수 |
etc1 | String | 선택 |
고객사 정의 값 1 - text(50) |
etc2 | String | 선택 |
고객사 정의 값 2 - text(50) |
status_code | String | 선택 |
메시지 상태 코드 - 상세 정보는 API 메시지 상태 코드 참고 |
Response
Response Syntax
코드예제알림톡 발송 리스트 조회 Response Syntax
{
"status": "200",
"code": "200",
"count": 4,
"next": false,
"code_detail": {
"detail_code": "NRM00000",
"detail_message": "성공"
},
"results": [
{
"uid": "221018080314511j7usTgzgQDOXvIk",
"reg_date": "2022-10-18T08:03:15",
"status_code": "API_200",
"kko_status_code": "0000",
"cid": "11329b64174a4738b049e2a74e93c5c1"
}
]
}
Response Elements
표알림톡 발송 리스트 조회 Response Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
status | String | 필수 |
메시지 발송 결과 코드 |
100 : 발송 진행 중(처리 중) |
|||
200 : 성공 |
|||
400 : 권한 오류 |
|||
410 : 입력값이 유효하지 않음 |
|||
420 : 파일/이미지 관련 오류 |
|||
500 : 내부 시스템 오류 |
|||
510 : 발송 실패 |
|||
520 : 실패되었으나 재발송 가능 |
|||
code | String | 선택 |
응답 상태 코드 |
count | Integer | 선택 |
결과 정보 조회 시 리스트 수 - int64 |
next | Boolean | 선택 |
페이지 조회 시 다음 페이지 여부 |
last_uid | String | 선택 |
조회한 페이지 리스트의 마지막 메시지 Key ID |
Object | 선택 |
메시지 상태 상세 코드 | |
detail_code | String | 선택 |
상세 코드 |
detail_message | String | 선택 |
상세 메시지 |
Array | 선택 |
메시지 결과 조회 리스트 | |
uid | String | 선택 |
메시지의 Key ID |
cid | String | 선택 |
고객사 정의 Key ID |
reg_date | String | 선택 |
메시지 등록일 |
status_code | String | 선택 |
메시지 상태 코드 - 상세 정보는 API 메시지 상태 코드 참고 |
kko_status_code | String | 선택 |
카카오톡에서 전송되는 처리 결과 코드 |
sms_status_code | String | 선택 |
SMS 처리 결과 코드 |
error_message | String | 선택 |
에러 메시지 (오류 시 존재하는 값) |
tax_cd1 | String | 선택 |
정산 코드1 - 고객사가 정산을 위해 정의하여 사용할 수 있는 변수 - text(50) |
tax_cd2 | String | 선택 |
정산 코드1 - 고객사가 정산을 위해 정의하여 사용할 수 있는 변수 - text(50) |
etc1 | String | 선택 |
고객사 정의 Value1 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc2 | String | 선택 |
고객사 정의 Value 2 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc3 | String | 선택 |
고객사 정의 Value 3 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc4 | String | 선택 |
고객사 정의 Value 4 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc5 | String | 선택 |
고객사 정의 Value 5 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc6 | String | 선택 |
고객사 정의 Value 6 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc7 | String | 선택 |
고객사 정의 Value 7 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc8 | String | 선택 |
고객사 정의 Value 8 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc9 | String | 선택 |
고객사 정의 Value 9 - 고객사가 정의하여 사용하는 변수 - text(50) |
etc10 | String | 선택 |
고객사 정의 Value 10 - 고객사가 정의하여 사용하는 변수 - text(50) |
알림톡 발송 리스트 상세 조회
메시지 발송 결과를 상세하게 조회할 수 있는 API 기능에 대한 설명입니다.
Request
Request Syntax
코드예제알림톡 발송 리스트 상세 조회 Request Syntax
curl -X 'GET' \
'https://{base_url}/v2/info/message/search/detail/{uid}' \
-H 'accept: */*' \
-H 'Authorization: Bearer {oauthToken}'
메서드 | 요청 URL |
---|---|
GET | https://{base_url}/v2/info/message/search/detail/{uid} |
파라미터 | 유형 | 필수 여부 | 대분류 | 구분 | 설명 |
---|---|---|---|---|---|
base_url | String | 필수 |
운영 | 일반 | bizmsg-web.kakaoenterprise.com |
금융권 | bizmsg-bank.kakaoenterprise.com |
||||
증권 | bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | bizmsg-gov.kakaoenterprise.com |
||||
스테이징 | 일반 | stg-user.bizmsg.kakaoenterprise.com |
|||
금융권 | stg-bizmsg-bank.kakaoenterprise.com |
||||
증권 | stg-bizmsg-stock.kakaoenterprise.com |
||||
공공 기관 | stg-bizmsg-gov.kakaoenterprise.com |
||||
uid | String | 필수 |
메시지 Key ID - ex. 21018173501346cxU7zEswSYSsTmS |
Request Header
표알림톡 발송 리스트 상세 조회 Request Header파라미터 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
accept | String | 필수 |
*/* 로 고정 |
Authorization | String | 필수 |
Bearer {oauthToken} - {oauthToken} : OAuth 2.0 인증 API로 발급받은 액세스 토큰 |
Response
Response Syntax
코드예제알림톡 발송 리스트 상세 조회 Response Syntax
{
"code": "200",
"code_detail": {
"detail_code": "NRM00000",
"detail_message": "성공"
},
"result": {
"uid": "221018080314511j7usTgzgQDOXvIk",
"reg_date": "2022-10-18T08:03:15",
"message_type": "AT",
"status_code": "API_200",
"phone_number": "01000000000",
"template_code": "test_kep_template_005",
"req_date": "2022-10-18T08:03:14",
"req_sms_yn": "N",
"kko_status_code": "0000",
"message": " 메시지",
"cid": "11329b64174a4738b049e2a74e93c5c1"
}
}
Response Elements
표알림톡 발송 리스트 상세 조회 Reponse Elements프로퍼티 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
code | String | 필수 |
메시지 발송 결과 코드 |
100 : 발송 진행 중(처리 중) |
|||
200 : 성공 |
|||
400 : 권한 오류 |
|||
410 : 입력값이 유효하지 않음 |
|||
420 : 파일/이미지 관련 오류 |
|||
500 : 내부 시스템 오류 |
|||
510 : 발송 실패 |
|||
520 : 실패되었으나 재발송 가능 |
|||
Object | 선택 |
메시지 상태 상세 코드 | |
detail_code | String | 선택 |
상세 코드 |
detail_message | String | 선택 |
상세 메시지 |
Object | 선택 |
단일 메시지의 발송 결과 상세 조회 | |
uid | String | 선택 |
메시지의 Key ID |
reg_date | String | 선택 |
메시지 등록일(date) |
message_type | String | 선택 |
메시지 타입 |
AT : 알림톡 |
|||
AI : 알림톡 이미지 |
|||
FT : 친구톡 |
|||
FI : 친구톡 이미지 |
|||
FW : 친구톡 와이드 이미지 |
|||
SM : SMS |
|||
LM : LMS |
|||
MM : MMS |
|||
ISM : 국제 SMS |
|||
status_code | String | 선택 |
메시지 상태 코드 - 상세 정보는 API 메시지 상태 코드 참고 |
phone_number | String | 선택 |
수신자 전화번호(국가코드(82 ) 포함)- text(16) |
template_code | String | 선택 |
실제 발송할 메시지 유형으로 등록된 템플릿의 코드 - text(30) |
req_date | String | 선택 |
발송 요청일(결과 존재 시 존재하는 값)(date) |
error_message | String | 선택 |
에러 메시지(오류 시 존재) |
req_sms_yn | String | 선택 |
SMS 발송 요청 여부 |
req_sms_date | String | 선택 |
SMS 발송 요청일(date-time) |
sender_no | String | 선택 |
고객사 발신 전화번호 - text(16) |
sms_type | String | 선택 |
대체발송 시 메시지 타입 - text(2) |
SM : SMS로 대체 발송 |
|||
LM : LMS로 대체 발송 |
|||
MM : MMS로 대체 발송 |
|||
kko_status_code | String | 선택 |
카카오톡에서 전송되는 처리 결과 코드 |
sms_status_code | String | 선택 |
SMS 처리 결과 코드 |
message | String | 선택 |
수신자에게 전달될 알림톡 메시지 - text(1000) |
sms_message | String | 선택 |
전달할 SMS 메시지 - text(4000) |
title | String | 선택 |
LMS, MMS 전송 시 TITLE - text(60) |
cid | String | 선택 |
고객사 정의 Key ID |
kko_title | String | 선택 |
템플릿 내용 중 강조 표기할 핵심 정보 - text(50) |
nat_cd | String | 선택 |
국제 발송 시 국가 코드 |
content_group_id | String | 선택 |
[MMS] 전송할 파일 그룹 ID contentGroupId (MMS 전송 시 필수) |
header | String | 선택 |
메시지 상단에 표기할 제목 |
알림톡 발송 확인하기
알림톡은 계약 방식에 따라 Push 방식과 Poll 방식에 따라 알림톡 발송 확인을 하는 방식이 다릅니다. Push 방식인 경우 발송 결과를 즉시 확인할 수 있습니다. Polling 방식의 경우, 발송 접수 후 일정 시간 대기 후 결과를 조회하는 방식으로 Push 방식 대비 발송 성공률이 높습니다.
알림톡 발송 코드
알림톡 발송 코드는 알림톡 발송 코드 문서를 참고하시기 바랍니다.