Parameter Description
설명 |
|
URL | [POST] api.bizppurio.com/v3/message |
Request
Header
키 | 타입 | 설명 |
Content-type | String |
application/json; charset=utf-8 |
Autorization | String | 인증 토큰 발급을 통해 받은 {type} + “ “ + {accesstoken} |
ex)
POST /v3/message HTTP/1.1
Content-type: application/json; charset=utf-8
Authorization: Bearer + " " + {accesstoken}
Body
- 공통
키 | 타입 | 길이 | 필수 | 설명 |
account | text | 20 | Y | 비즈뿌리오 계정 |
type | text | 3 | Y |
메시지 데이터 *sms, lms, mms, at, ai, ft, fi, fw, fc, fm, fp, fa, rcs |
from | text | 16 | Y | 발신 번호 |
to | text | 16 | Y | 수신 번호 |
country | text | 5 | N | 국가 코드 *국제 메시지 발송 참조 |
content | json | - | Y | 메시지 데이터 *CONTENT 참조 |
refkey | text | 32 | Y | 고객사에서 부여한 키 |
userinfo | text | 50 | N | 정산용 부서 코드 |
resend | json | 3 | N | 대체 발송 에시지 유형 *RESEND 참조 |
recontent | json | - | N | 대체 발송 메시지 데이터 *CONTENT 참조 |
resellercode | text | 9 | N | 특부가사업자 식별코드(9자리 숫자) |
sendtime | text | 10 | N |
발송시간 (unixtime, 최대 30일 이내) * 비즈뿌리오 서버 시간 기준, 한국 표준시 (GMT +9) * 과거 시간 입력시 즉시 발송 * 즉시 발송을 원하는 경우 미입력 |
ex)
{
/*text(20)*//*비즈뿌리오 계정*/
"account": "",
/*text(3)*//*메시지 타입*/
"type": "",
/*text(20)*//*발신 번호*/
"from": "",
/*text(20)*//*수신 번호*/
"to": "",
/*text(20)*//*국가 코드*/
"country": "",
/*text(20)*//*메시지 데이터*/
"content": ""
/*text(20)*//*고객사에서 부여한 키*/
"refkey": "",
/*text(20)*//*정산용 부서 코드*/
"userinfo": "",
/*text(20)*//*대체 전송 메시지 유형*/
"resend": "",
/*text(20)*//*대체 전송 메시지 데이터*/
"recontent": "",
/*text(20)*//*특부가 사업자 식별코드*/
"resellercode": "",
/*text(10)*//*발송 시간*/
"sendtime" : ""
}
Response
Headers
HTTP/1.1 200 OK
Content-type: application/json
Body
키 | 타입 | 길이 | 필수 | 설명 |
code | text | 5 | Y | 결과 코드 * API 응답 상태 및 결과 코드 참조 |
description | text | 32 | Y | 결과 에시지 |
messagekey | text | 32 | Y | 메시지 키 * 고객 문의 및 리포트 재 요청 기준 키 |
refk | text | 32 | Y | 고객사에서 부여한 키 |
예시)
{
"code": 1000,
"description": "Success",
"refkey": "123456789012345678901234890123",
"messagekey": "190922175225820#ft002951servj8FU67"
}
SMS
키 | 타입 | 길이 | 필수 | 설명 |
message | text | - | Y | 내용 (EUC-KR 기준, 최대 90바이트) |
{
"account": "",
"type": "",
"from": "",
"to": "",
"country": "",
"content": {
"sms": {
"message": ""
}
},
"refkey": "",
"userinfo": "",
"resend": "",
"recontent": "",
"resellercode": "",
"sendtime" : ""
}
LMS
키 | 타입 | 길이 | 필수 | 설명 |
message | text | - | Y | 내용 (EUC-KR 기준, 최대 2000바이트) |
subject | text | 64 | N | 제목 (EUC-KR 기준, 최대 64바이트) |
{
"account": "",
"type": "",
"from": "",
"to": "",
"country": "",
"content": {
"lms": {
"message": "",
"subject": ""
}
},
"refkey": "",
"userinfo": "",
"resend": "",
"recontent": "",
"resellercode": "",
"sendtime" : ""
}
MMS
키 | 타입 | 길이 | 필수 | 설명 |
message | text | - | N | 내용 (EUC-KR 기준, 최대 2000바이트) |
*file | json | - | Y | 첨부파일 (최대 3개) *FILE 참조 |
subject | text | 64 | N | 제목 (EUC-KR 기준, 최대 64바이트) |
file
키 | 타입 | 길이 | 필수 | 설명 |
type | text | 3 | Y | 파일 유형 (IMG) |
key | text | 40 | Y | 파일 키 |
{
"account": "",
"type": "",
"from": "",
"to": "",
"country": "",
"content": {
"mms": {
"message": "",
"subject": "",
"file": [
{
"type": "",
"key": ""
}
]
}
},
"refkey": "",
"userinfo": "",
"resend": "",
"recontent": "",
"resellercode": "",
"sendtime" : ""
}
알림톡 (AT/AI)
(AT: 알림톡, AI:이미지 알림톡)
유형 | 키 | 타입 | 길이 | 필수 | 설명 |
at/ai | message | text | - | Y | 내용 (한글/영문 1000자) |
senderkey | text | 40 | Y | 발신 프로필 키 | |
templatecode | text | 32 | Y | 템플릿 코드 | |
button | json | - | - | 버튼 * 템쫄릿에 포함된 경우. 필수 입력 (최대 57b * BUTTON 참조 |
|
quickreply | json | - | - | 바로연결 버른 * 템플릿에 포함된 경우. 필수 입력 (최대 107b * QUICKREPLY 참조 |
|
title | text | 50 | N | 강조표기 문구 * 템플릿에 포함된 경우. 필수 입력 |
|
header | text | 16 | N | 알림톡 아이템리스트 헤더 | |
ltem | json | - | N | 아이템리스트와 아이템 요약정보 * ITEM 참조 |
|
itemhighlight | json | - | N | 아이템 하이라이트 * ITEMHIGHLIGHT 참조 |
|
link | json | - | N | 대표 링크 * LINK 참조 |
BUTTON
키 | 타입 | 길이 | 필수 | 설명 |
name | text | 28 | Y | 버튼 제목 * AC 타입인 경우, '채널 추가'로 고정 |
type | text | 2 | Y | 버튼 타입 *버튼 타입 속성 참조 |
url_pc | text | - | N | PC 환경에서 이동활 URL |
url_mobile | text | - | N | MOBILE 환경에서 이동할 URL |
scheme_iOS | text | - | N | IOS 환경, ApplIcation Custom Scheme |
scheme_android | text | - | N | ANDROID 환경, Application Custom Scheme |
chat_extra | text | 50 | N | 상당톡/봇 전환 시 전달할 메타정보 |
chat_envent | text | 20 | N | 봇 전환 시 연결할 붓 이벤트 명 |
plugin_id | text | 24 | N | 플러그인 ID |
relay_id | text | - | N | 플러그인 실행시 X-Kaka0-Plugin-Relay-ld 헤더를 통해 전달 받을 값 |
oneclick_id | text | - | N | 원클릭, 결제 플러그인에서 사용하는 결제 정보 |
product_id | text | - | N | 원클릭, 결제 플러그인에서 사용하는 결제 정보 |
버튼 타입 별 속성 (*type)
버튼타입 | 속성 | 타입 | 필수 | 설명 | |
웹링크 | WL | url_pc | text | N | PC 환경에서 이동할 URL |
url_mobile | text | Y | MOBILE 환경에서 이동할 URL | ||
앱링크 |
AL | scheme_ios | text | - |
* scheme_ios, scheme_android, url_mobile 중 2가지 필수 입력 클릭 시 실행할 OS 별 Application Custom Scheme |
scheme_android | text | - | |||
url_pc | text | N | PC 환경에서 이동할 URL | ||
url_mobile | text | - | MOBILE 환경에서 이동할 URL | ||
배송조회 | DS | - | - | - | 버튼 클릭 시 배송 조회 페이지로 이동 |
봇 키워드 | BK | - | - | - | 해당 버튼 텍스트 전송 |
메시지 전달 | MD | - | - | - | 해당 버튼 텍스트 + 메시지 본문 전송 |
상담톡전환 | BC | - | - | - | 상담톡을 이용하는 카카오톡 채널만 이용 가능 |
chat_extra | text | N | 봇 전환 시 전달할 메타 정보 | ||
봇 전환 |
BT | - | - | - | 카카오 | 오픈 빌더의 챗봇을 사용하는 카카오톡 채널만 이용 가능 |
chat_extra | text | N | 봇 전환 시 전달할 메타 정보 | ||
chat_event | text | N | 봇 전환 시 연결할 봇 이벤트명 | ||
채널 추가 | AC | - | - | - | 버튼 클릭 시 카카오톡 채널 추가 |
플러그인 | P1 | - | - | - | 이미지 보안 전송 플러그인 |
P2 | - | - | - | 개인정보이용 플러그인 | |
P3 | - | - | - |
원클릭 결제 플러그인 (발송시 oneclick_id 또는 product_id 를 필수로 전달해아 함) |
|
비즈폼 | BF | biz_form_id | number | 카카오 비즈니스에서 생성한 비즈니스폼 ID |
ITEM
키 | - | 타입 | 길이 | 필수 | 설명 |
list | array | Y | 아이템 리스트 | ||
title | text | 6 | Y | 타이틀 | |
description | text | 23 | Y | 부가정보 | |
summary | json | N | 아이템 요약 정보 | ||
title | text | 6 | Y | 타이틀 | |
description | text | 14 | Y | 가격정보 * 허용되는 문자: 통화기호 (유니코드, 통화기호, 元, 円, 원), 통화코드 (ISO 4217), 숫자, 콤마, 소수점, 공백 * 소수점 2자리까지 허용 |
ITEMHIGHLIGHT
키 | 타입 | 길이 | 필수 | 설명 |
title | text | 30 | Y | 타이를 (이미지가 있는 경우 최대 기자) 발송 시 내용 마지막에 "WWs" 플래그를 포함 할 경우 취소선 스타일이 적용됩니다. |
description | text | 19 | Y | 부가정보 (이미지가 있는 경우 최대 13자) |
QUICKREPLY
키 | 타입 | 길이 | 필수 | 설명 |
name | text | 14 | Y | 바로 연결 제목 |
type | text | 2 | Y | 버튼 연결 타입 *바로연결 타입 별 속성 표 참조 |
url_pc | text | - | N | PC 환경에서 이동할 URL |
url_mobile | text | - | N | MOBILE 환경에서 이동할 URL |
scheme_ios | text | - | N | iOS 환경. Application Custom Scheme |
scheme_android | text | - | N | ANDROID 환경. Application Custom Scheme |
chat_extra | text | 50 | N | 상담톡/봇 전환 시 전달할 메타 정보 |
chat_event | text | 50 | N | 봇 전환 시 연결한 봇 이벤트명 |
LINK
키 | 타입 | 길이 | 필수 | 설명 |
url_mobile | text | - | - | mobile 환경에서 버튼 클릭 시 이동할 url |
url_pc | text | - | - | pc 환경에서 버튼 클릭 시 이동할 url |
scheme_android | text | - | - |
mobile android 환경에서 버튼 클릭 시 실행할 application custom scheme |
scheme_ios | text | - | - |
mobile ios 환경에서 버튼 클릭 시 실행할 application custom scheme |
친구톡 (FT/FI/FW/FL/FC/FM/FP/FA)
유형 | 키 | 타입 | 길이 | 필수 | 설명 |
ft/fi/fw/fl/fc/ fm/fp/fa |
message | text | - | Y |
내용 (타입별 최대 글자 수 참고) FL, FC 타입은 필수 X, FP 타입은 선택 |
senderkey | text | 40 | Y | 발신 프로필 키 | |
userkey | text | 30 | N | 사용자 식별키 카카오톡 채널 봇을 이용해 받은 카카오톡 채널 사용자 식별키 |
|
adflag | text | 1 | N | 광고성 메시지 노출 여부 (Y/N, 기본 Y) | |
button | json | - | N | 버튼 (최대 5개) * BUTTON 참조 | |
image | json | - | N | 이미지 (최대 1개) * IMAGE 참조 | |
header | text | 25 | N | 와이드 아이템 리스트 메시지 타입(FL) 사용시 필수 | |
carousel | json | - | N |
캐러셀 메시지 타입(FC) 사용시 필수 * CAROUSEL 참조 |
|
item | json | - | N |
와이드 아이템 리스트 메시지 타입(FL) 사용시 필수 * ITEM 참조 |
|
coupon | json | - | N |
메세지 최하단에 쿠폰 추가 * COUPON 참조 |
|
additionalcontent | text | 34 | N |
부가 정보 (공백 포함 34자로 제한) FM 타입에서 사용 |
|
adult | text | 1 | N |
성인용 메시지 여부 (성인용 메시지 여부 Y/N, 기본값 N) |
|
pushalarm | text | 1 | N |
메시지 푸시 알람 발송 여부 (Y/N, 기본값 Y) |
|
commerce | json | - | N |
커머스 FM 타입 사용시 필수 * COMMERCE 참조 |
|
video | json | - | N |
비디오 FP 타입 사용시 필수 * VIDEO 참조 |
BUTTON
키 | 타입 | 길이 | 필수 | 설명 |
name | text | 28 | Y | 버튼 제목 * AC 타입인 경우, ,채널 추가로 고정 |
type | text | 2 | Y | 버튼 타입 *버튼 타입 별 속성 참조 |
urLpc | text | - | N | PC 환경에서 이동할 URL |
url_mobile | text | - | N | MOBILE 환경에서 이동할 URL |
scheme_ios | text | - | N | iOS 환경, Application Custom Scheme |
scheme_android | text | - | N | ANDROID 환경, Application Custom Scheme |
chat_extra | text | 50 | N | 상당톡/봇 전환 시 전달할 메타정보 |
chat_envent | text | 50 | N | 봇 전환 시 연결할 봇 이벤트 명 |
biz_form_id | number | - | - | 카카오 비즈니스에서 생성한 비즈니스폼 ID |
버튼 타입별 속성 (*type)
타입 | 속성 | 타입 | 필수 | 설명 |
WL | urLpc | text | N | PC 환경에서 이동활 URL |
url_mobile | text | Y | MOBILE 환경에서 이동할 URL | |
AL | scheme_iOS | text | - |
*scheme_ios, scheme-android, url-mobile 중 2가지 필수 입력 |
scheme_android | text | - | ||
url-pc | text | N | PC 환경에서 이동할 URL | |
url_mobile | text | - | MOBILE 환경에서 이동할 IJRL | |
BK | - | - | 해당 버튼 텍스트 발송 | |
MD | - | - | 해당 버튼 텍스트 + 에시지 본문 발송 | |
BC | - | - | 상담특을 이용하는 카카오특 채널만 이용 가능 | |
chat extra | text | N | 전환 시 전달할 메타 정보 | |
BT | - | - | 카카오 | 오픈 밀더의 잿봇을 사용하는 카카오톡 채널만 이용 가능 | |
chat extra | text | N | 봇 전환 시 전달할 에다 정보 | |
chat_event | text | N | 봇 전환 시 연결할 봇 이벤트명 | |
BF | biz from_id | number | - | 카카오 비즈니스에서 생성한 비즈니스폼 ID |
IMAGE
키 | 타입 | 길이 | 필수 | 설명 |
img_url | text | - | Y | 노출할 이미지 |
img_link | text | - | N | 이미지 클릭 시 이동활 URL |
ITEM
키 | - | 타입 | 길이 | 필수 | 설명 |
list | array | Y | 와이드 아이템 리스트 전용 | ||
title | text | 25 | Y | 아이템 제목 | |
img_url | text | - | Y | 아이템 이미지 URL | |
scheme_android | text | - | N |
mobile androld 환경에서 이미지 클릭 시 실행 할 application custom scheme |
|
scheme_ios | text | - | Y |
mobile ios 환경에서 이미지 클릭 시 실행 할 application custom scheme |
|
url_mobile | text | - | Y |
mobile 환경에서 이미지 클릭 시 이동할 url |
|
urLpc | text | - | N |
pc 환경에서 이미지 클릭 시 이동할 url |
COUPON
- title의 경우 5가지 형식으로 제한 됨
- url_pc, url_mobile, scheme_android, scheme_ios의 경우 값에 따라 필수값이 두가지 케이스로 구분 됨
case1) 채널 쿠폰 URL(alimtalk=coupon://) 사용: scheme_android, scheme_ios 둘 중 하나 필수
case2) 기본: url_mobile 필수
키 | 타입 | 길이 | 필수 | 설명 |
title | text | - | Y |
쿠폰 이름 지원하는 형식 : - ${숫자}원 할인 쿠폰 (숫자: 1 ~ 99,999,999) - ${숫자}% 할인 쿠폰 (숫자: 1 ~ 100) - 배송비 할인 쿠폰 - ${7자 이내} 무료 쿠폰 - ${7자 이내} UP 쿠폰 |
description | text | - | Y | 쿠폰 상세 실명 ( FW, FL, FP- 18자 제한 / 그 외 - 12자) |
url_pc | text | - | - | pc 한경에서 쿠폰 클릭 시 이동활 url |
url_mobile | text | - | - | mobile 환경에서 쿠폰 클릭 시 이동활 url |
scheme_android | text | - | - |
mobile androld 환경에서 쿠폰 클릭 시 실행할 appllcation custom scheme |
scheme_iOS | text | - | - |
mobile ios 환경에서 쿠폰 클릭 시 실행할 appllcation custom scheme |
CAROUSEL
키 | - | - | - | 타입 | 길이 | 필수 | 설명 |
head | json | N |
캐러셀 인트로 정보 - 캐러셀 피드형(FC)은 사용불가 |
||||
header | text | 20 | Y | 캐러셀 인트로 헤더 | |||
content | text | 50 | Y | 캐러셀 인트로 내용 | |||
image_url | text | Y | 캐러셀 인트로 이미지 주소 | ||||
url_mobile | text | N |
mobile 환경에서 인트로 클릭 시 이동할 url url_mobile, url_pc, scheme_android, scheme_ios 넷 중 하나라도 빈 값이 아니라면 url_mobile이 필수 |
||||
url_pc | text | N | pc 환경에서 인트로 클릭 시 이동할 url | ||||
scheme_android | text | N |
mobile android 환경에서 인트로 클릭 시 실행할 application custom scheme |
||||
scheme_ios | text | N |
mobile ios 환경에서 인트로 클릭 시 실행할 application custom scheme |
||||
list | array | Y | Carousel Item List | ||||
header | text | 20 | N |
캐러셀 아이템 제목 - 캐러셀 피드형(FC) 사용시 필수값 - 캐러셀 커머스형(FA)은 사용불가 |
|||
message | text | 180 | N |
캐러셀 아이템 메시지 - 캐러셀 피드형(FC) 사용시 필수값 - 캐러셀 커머스형(FA)은 사용불가) |
|||
additional_content | text | 34 | N |
부가 정보 (공백 포함 34자로 제한) - 캐러셀 피드형(FC)은 사용불가 |
|||
attachment | json | N | 캐러셀 아이템 이미지, 버튼 정보 | ||||
button | array | N | 버튼 목록 | ||||
name | text | 28 | - | 버튼 제목 | |||
type | text | 2 | - | 버튼 타입 <버튼 타입 별 속성에서 확인 가능> | |||
|
scheme_android | text | - | mobile android 환경에서 버튼 클릭 시 실행할 application custom scheme |
|||
scheme_ios | text | - | mobile ios 환경에서 버튼 클릭 시 실행할 application custom scheme |
||||
url_mobile | text | - | mobile 환경에서 버튼 클릭 시 이동할 url | ||||
url_pc | text | - | pc 환경에서 버튼 클릭 시 이동할 url | ||||
|
image | json | Y | 캐러셀 썸네일 이미지 | |||
img_url | text | Y | 캐러셀 썸네일 이미지 주소 | ||||
img_link | text | N | 캐러셀 썸네일 링크 주소 | ||||
coupon | json | N | 캐러셀 최하단에 쿠폰 추가 | ||||
title | text | Y | 쿠폰 이름 형식 | ||||
description | text | Y | 12자 제한 | ||||
url_pc | text | - | pc 환경에서 쿠폰 클릭 시 이동할 url | ||||
url_mobile | text | - | mobile 환경에서 쿠폰 클릭 시 이동할 url | ||||
scheme_android | text | - |
mobile android 환경에서 쿠폰 클릭 시 실행할 application custom scheme |
||||
scheme_ios | text | - |
mobile ios 환경에서 쿠폰 클릭 시 실행할 application custom scheme |
||||
commerce | json | N |
커머스 - 캐러셀 커머스형 (FA) 사용 시 필수값 - 캐러셀 피드형(FC)은 사용불가 |
||||
title | text | Y | 상품제목 | ||||
regular_price | number | Y | 정상가격 (0 ~ 99,999,999) | ||||
discount_price | number | N | 할인가격 (0 ~ 99,999,999) | ||||
discount_rate | number | N |
할인율 할인가격 존재시 할인율, 정액할인가격 중 하나는 필수 (0 ~ 100) |
||||
discount_fixed | number | N |
정액할인가격 할인가격 존재시 할인율, 정액할인가격 중 하나는 필수 (0 ~ 999,999) |
||||
tail | json | N | 더보기 버튼 정보 | ||||
|
url_pc | text | N | pc 환경에서 버튼 클릭 시 이동할 url | |||
url_mobile | text | Y | mobile 환경에서 버튼 클릭 시 이동할 url | ||||
scheme_ios | text | N | mobile ios 환경에서 버튼 클릭 시 실행할 application custom scheme | ||||
scheme_android | text | N | mobile android 환경에서 버튼 클릭 시 실행할 application custom scheme |
COMMERCE
키 | 타입 | - | 필수 | 설명 |
title | text | Y | 상품제목 (최대 30자) | |
regular_price | number | Y | 정상가격 (0 ~ 99,999,999) | |
discount_price | number | N | 할인가격 (0 ~ 99,999,999) | |
discount_rate | number | N |
할인율 할인가격 존재시 할인율, 정액할인가격 중 하나는 필수 (0 ~ 100) |
|
discount_fixed | number | N |
정액할인가격 할인가격 존재시 할인율, 정액할인가격 중 하나는 필수 (0 ~ 999,999) |
VIDEO
키 | 타입 | - | 필수 | 설명 |
video_url | text | Y | 카카오TV 동영상 URL | |
thumbnail_url | text | N | 동영상 썸네일용 이미지 URL, 없는 경우 동영상 기본썸네일 사용 |
Examples
알림톡
{
"account": "test",
"refkey": "test1234",
"type": "at",
"from": "07000000000",
"to": "01000000000",
"content": {
"at": {
"senderkey": "12345",
"templatecode": "template",
"message": "알림톡 + 버튼(WL)",
"button": [
{
"name": "웹 링크 버튼",
"type": "WL",
"url_pc": "http://www.bizppurio.com",
"url_mobile": "http://www.bizppurio.com"
}
]
}
}
}
알림톡 아이템 리스트형
{
"account": "test",
"refkey": "test1234",
"type": "at",
"from": "07000000000",
"to": "01000000000",
"content": {
"at": {
"senderkey": "12345",
"templatecode": "template",
"message": "알림톡 아이템리스트 + 버튼(WL)",
"header": "헤더 (최대 16자)",
"button": [
{
"name": "웹 링크 버튼",
"type": "WL",
"url_pc": "http://www.bizppurio.com",
"url_mobile": "http://www.bizppurio.com"
}
],
"item": {
"list": [
{
"title": "타이틀",
"description": "디스크립션"
},
{
"title": "타이틀2",
"description": "디스크립션2"
}
],
"summary": {
"title": "요약 타이틀",
"description": "$100,000원"
}
},
"itemhighlight": {
"title": "타이틀",
"description": "디스크립션"
}
}
}
}
알림톡 이미지
{
"account": "test",
"refkey": "test1234",
"type": "ai",
"from": "07000000000",
"to": "01000000000",
"content": {
"ai": {
"senderkey": "12345",
"templatecode": "template",
"message": "알림톡 이미지"
}
}
}
알림톡 + 대표링크
{
"account": "test",
"refkey": "test1234",
"type": "at",
"from": "07000000000",
"to": "01000000000",
"content": {
"at": {
"senderkey": "12345",
"templatecode": "template",
"message": "알림톡 이미지",
"button": [
{
"name": "웹 링크 버튼",
"type": "WL",
"url_pc": "http://www.bizppurio.com",
"url_mobile": "http://www.bizppurio.com"
}
],
"link": {
"url_mobile": "https://www.bizppurio.com",
"url_pc": "https://www.bizppurio.com"
}
}
}
}
친구톡 텍스트 + 버튼 + 쿠폰
{
"account": "test",
"refkey": "test1234",
"type": "ft",
"from": "07000000000",
"to": "01000000000",
"content": {
"ft": {
"senderkey": "1234",
"message": "친구톡 텍스트 + 버튼 + 쿠폰",
"adflag": "Y",
"coupon": {
"title": "문자 발송 무료 쿠폰",
"description": "비즈뿌리오",
"url_mobile": "http://www.bizppurio.com"
},
"button": [
{
"name": "버튼 제목",
"type": "WL",
"url_pc": "http://www.bizppurio.com",
"url_mobile": "http://www.bizppurio.com"
},
{
"name": "버튼 제목",
"type": "WL",
"url_pc": "http://www.bizppurio.com",
"url_mobile": "http://www.bizppurio.com",
"scheme_ios": "sceme://xxx.xxx",
"schemea_ndroid": "sceme://xxx.xxx"
}
]
}
}
}
친구톡 이미지
{
"account": "test",
"refkey": "test1234",
"type": "fi",
"from": "07000000000",
"to": "01000000000",
"content": {
"fi": {
"senderkey": "1234",
"message": "친구톡 이미지",
"adflag": "Y",
"image": {
"img_url": "노출할 이미지 url",
"imglink": "http://www.bizppurio.com"
}
}
}
}
친구톡 와이드 이미지
{
"account": "test",
"refkey": "test1234",
"type": "fw",
"from": "07000000000",
"to": "01000000000",
"content": {
"fw": {
"senderkey": "1234",
"message": "친구톡 와이드 이미지",
"adflag": "Y",
"image": {
"img_url": "노출할 와이드 이미지 url",
"imglink": "http://www.bizppurio.com"
}
}
}
}
친구톡 와이드 아이템 리스트
{
"account": "test",
"refkey": "test1234",
"type": "fl",
"from": "07000000000",
"to": "01000000000",
"content": {
"fl": {
"senderkey": "1234",
"header": "아이템 리스트 제목",
"adflag": "Y",
"item": {
"list": [
{
"title": "title",
"img_url": "아이템 이미지 URL",
"url_mobile": "http://www.bizppurio.com/"
},
{
"title": "title",
"img_url": "아이템 이미지 URL",
"url_mobile": "http://www.bizppurio.com/"
},
{
"title": "title",
"img_url": "아이템 이미지 URL",
"url_mobile": "http://www.bizppurio.com/"
},
{
"title": "title",
"img_url": "아이템 이미지 URL",
"url_mobile": "http://www.bizppurio.com/"
}
]
}
}
}
}
친구톡 캐러셀 피드
{
"account": "test",
"refkey": "test1234",
"type": "fc",
"from": "07000000000",
"to": "01000000000",
"content": {
"fc": {
"senderkey": "1234",
"adflag": "Y",
"carousel": {
"tail": {
"url_mobile": "http://www.bizppurio.com"
},
"list": [
{
"header": "헤더",
"message": "메세지",
"attachment": {
"button": [
{
"name": "비즈메시지 소개",
"type": "WL",
"url_pc": "http://www.bizppurio.com",
"url_mobile": "http://www.bizppurio.com"
},
{
"name": "비즈메시지 소개",
"type": "WL",
"url_pc": "http://www.bizppurio.com",
"url_mobile": "http://www.bizppurio.com"
}
],
"image": {
"img_url": "케러셀 썸네일 이미지 주소",
"img_link": "http://www.bizppurio.com"
}
}
},
{
"header": "헤더",
"message": "메세지",
"attachment": {
"button": [
{
"name": "비즈메시지 소개",
"type": "WL",
"url_pc": "http://www.bizppurio.com",
"url_mobile": "http://www.bizppurio.com"
},
{
"name": "비즈메시지 소개",
"type": "WL",
"url_pc": "http://www.bizppurio.com",
"url_mobile": "http://www.bizppurio.com"
}
],
"image": {
"img_url": "케러셀 썸네일 이미지 주소",
"img_link": "http://www.bizppurio.com"
}
}
}
]
}
}
}
}
친구톡 커머스
{
"account": "test",
"refkey": "test1234",
"type": "fm",
"from": "07000000000",
"to": "01000000000",
"content": {
"fm": {
"senderkey": "2662e99eb7a1f21abb3955278e9955f5a9a99b62",
"image": {
"img_url": "https://mud-kage.kakao.com/xxx.jpg",
"img_link": "http://www.bizppurio.com"
},
"additionalcontent": "부가 정보",
"commerce": {
"title": "상품제목 (최대 30자)",
"regular_price": 10000,
"discount_price": 9000,
"discount_fixed": 1000
},
"button": [
{
"name": "비즈메시지 소개",
"type": "WL",
"url_pc": "http://bizmessage.kakao.com/",
"url_mobile": "http://bizmessage.kakao.com/"
},
{
"name": "비즈메시지 소개",
"type": "WL",
"url_pc": "http://bizmessage.kakao.com/",
"url_mobile": "http://bizmessage.kakao.com/"
}
]
}
}
친구톡 프리미엄 동영상
{
"account": "test",
"refkey": "test1234",
"type": "fp",
"from": "07000000000",
"to": "01000000000",
"content": {
"fp": {
"senderkey": "2662e99eb7a1f21abb3955278e9955f5a9a99b62",
"message": "사용자에게 전달될 메시지",
"video": {
"video_url": "https://tv.kakao.com/channel/10095965/cliplink/xxxxxxxx"
},
"button": [
{
"name": "비즈메시지 소개",
"type": "WL",
"url_pc": "http://bizmessage.kakao.com/",
"url_mobile": "http://bizmessage.kakao.com/"
}
]
}
}
친구톡 캐러셀 커머스
{
"account": "test",
"refkey": "test1234",
"type": "fa",
"from": "07000000000",
"to": "01000000000",
"content": {
"fa": {
"senderkey": "2662e99eb7a1f21abb3955278e9955f5a9a99b62",
"carousel": {
"head": {
"header": "캐러셀 인트로 헤더",
"content": "캐러셀 인트로 내용",
"image_url": "https://mud-kage.kakao.com/xxx.jpg",
"url_pc": "http://bizmessage.kakao.com/",
"url_mobile": "http://bizmessage.kakao.com/"
},
"tail": {
"url_pc": "http://bizmessage.kakao.com/",
"url_mobile": "http://bizmessage.kakao.com/"
},
"list": [
{
"additionalcontent": "부가 정보",
"attachment": {
"coupon": {
"title": "999999원 할인 쿠폰",
"description": "비즈뿌리오비즈뿌리오12",
"url_mobile": "https://bizppurio.com"
},
"commerce": {
"title": "상품제목 (최대 30자)",
"regular_price": 10000,
"discount_price": 9000,
"discount_fixed": 1000
},
"button": [
{
"name": "비즈메시지 소개",
"type": "WL",
"url_pc": "http://bizmessage.kakao.com/",
"url_mobile": "http://bizmessage.kakao.com/"
}
],
"image": {
"img_url": "https://mud-kage.kakao.com/xxx.jpg",
"img_link": "https://daou.co.kr"
}
}
},
{
"attachment": {
"commerce": {
"title": "상품제목 (최대 30자)",
"regular_price": 10000,
"discount_price": 9000,
"discount_fixed": 1000
},
"button": [
{
"name": "비즈메시지 소개",
"type": "WL",
"url_pc": "http://bizmessage.kakao.com/",
"url_mobile": "http://bizmessage.kakao.com/"
}
],
"image": {
"img_url": "https://mud-kage.kakao.com/xxx.jpg",
"img_link": "https://daou.co.kr"
}
}
}
]
}
}
}
}
카카오톡 이모티콘 삽입
카카오톡 기본 이모티콘 삽입을 원할 경우 이모티콘에 해당하는 명령어를 입력합니다.
예) 안녕하세요 (하하)(씨익)
RCS
키 | 타입 | 길이 | 필수 | 설명 |
message | json | - | N | 메시지 베이스에서 치환할 정보 * MESSAGE 참조 |
messagebaseid | text | 40 | Y |
RCS 공통 포맷 (RCS SMS, LMS, MMS) * 공통 포켓 참조 또는 템플릿 ID |
chatbotid | text | 40 | Y | RCS 브랜드 포탈을 통해 생성한 챗봇 ID |
agencyid | text | 20 | N | 대행사 ID (기본 : daoutech) |
header | text | 1 | Y | 메시지 상단에 식별 문구 입력 (0: Web 발신. 1 : 광고) |
footer | text | 64 | N | 메시지 하단에 수신 거부 문구를 입력 |
copyallowed | text | 1 | N | 단말기에서 사용자에게 , '복사/공유' 메뉴 보기 여부 |
groupid | text | 20 | N | 그룹 ID (통계용), 캠페인 단위(유니크) |
button | json | - | N | 메시지에 삽입말 버튼 정보 * BUTTON 참조 |
agencykey | text | 64 | N | 대행사 KEY (2자 대행사의 경우 값이 필수) |
brandkey | text | 64 | Y | 브랜드 별 제공되는 특수 키 |
공통 포맷(MESSAGEBASE ID)
ID | 메시지 유형 | 카드 장수 |
카드 별 최대 버튼 수 |
본문 글자 수 | |
SS000000 | SMS | Standalone | 1 | 1 | 100 |
SL000000 | LMS | Standalone | 1 | 3 | 1300 |
SMwThT00 |
MMS | Standalone Media Top | 1 | 2 | 1300 |
SMwThM00 | MMS | Standalone Media Top | 1 | 2 | 1300 |
CMwMhM0300 | MMS | Carousel Medium | 2 | 2 |
RCS MMS 슬라이드형 글자/라인수 정의 참고 |
CMwMhM0300 | MMS | Carousel Medium | 3 | 2 | |
CMwMhM0400 | MMS | Carousel Medium | 4 | 2 | |
CMwMhM0500 | MMS | Carousel Medium | 5 | 2 | |
CMwMhM0600 | MMS | Carousel Medium | 6 | 2 | |
CMwShS0200 | MMS | Carousel Small | 2 | 2 | |
CMwShS0300 | MMS | Carousel Small | 3 | 2 | |
CMwShS0400 | MMS | Carousel Small | 4 | 2 | |
CMwShS0500 | MMS | Carousel Small | 5 | 2 | |
CMwShS0600 | MMS | Carousel Small | 6 | 2 | |
OMHITV0001 | 신규 MMS |
이미지 & 타이틀 강조형 (3:4) |
1 | 2 | 150 |
OMH|TS0001 | 신규 MMS |
이미지 & 타이틀 강조형 (1:1) |
1 | 2 | |
OMHIMV0001 | 신규 MMS |
이미지 강조형 (34) | 1 | 2 | |
OMHIMS0001 | 신규 MMS |
이미지 강조형 (1:1) | 1 | 2 | |
OMTBNV0001 | 신규 MMS |
썸네일형 (세로) | 1 | 2 | |
OMTBNH0001 | 신규 MMS |
썸네일형 (가로) | 1 | 2 | |
OMSNSS0001 | 신규 MMS |
SNS | 1 | 2 | |
OMSNSH0001 | 신규 MMS |
SNS(중간버튼) | 1 | 2 | |
UBR로 시작 템플릿별 상이 |
템플릿 | 서술 (description) | 1 | 2 | 90 |
스타일 (cell) | 1 | 2 | |||
기본 (free) | 1 | 0 | |||
IBR로 시작 템플릿별 상이 |
이미지 템플릿 |
신규 MMS 동일 (8종) | 1 | 2 | 150 |
LBR로 시작 템플릿별 상이 |
LMS 템플릿 |
LMS 템플릿 (4종) | 1 | 2 | 1300 |
RCS MMS 슬라이드형(Carousel Medium, Small)은 1,300자까지 발송 가능하나 실제 단말에서 수신 가능한 글자 수가 적어 메시지 내용이 잘려 발송될 수 있습니다.
아래 글자/라인수 정의 확인하시어 발송하시기 바랍니다.
RCS MMS 슬라이드형 글자/ 라인수 정의
글자 수 : 1줄 당 정상적으로 표현가능한 글자 수, 한글 '가' 기준 측정
라인 수 : 수신 가능한 디스크립션(본문) 줄 수
(expand 없이 메시지 버블 최대크기에서 표현 가능한 description 줄 수 )
LMS (Standalone No Media)
[글자 수]
타이틀 | 디스크립션 | 버튼명 |
16 | 18 | 17 |
[줄 수(접혀있는 경우)]
버튼 0개 | 버튼 1개 | 버튼 2개 | 버튼 3개 | |
디스크립션 only | 28 | 26 | 24 | 22 |
타이틀 1줄 + 디스크립션 |
27 | 25 | 23 | 20 |
타이틀 2줄 + 디스크립션 |
26 | 23 | 21 | 19 |
MMS (Standalone Media Top - 세로형)
[글자 수]
타이틀 | 디스크립션 | 버튼명 |
16 | 18 | 17 |
[줄 수 (Media Tall인 경우, 접혀있는 경우)]
버튼 0개 | 버튼 1개 | 버튼 2개 | |
디스크립션 only | 9 | 8 | 6 |
타이틀 1줄 + 디스크립션 |
8 | 6 | 4 |
타이틀 2줄 + 디스크립션 |
7 | 5 | 3 |
[줄 수(Media Medium인 경우, 접혀있는 경우)]
버튼 0개 | 버튼 1개 | 버튼 2개 | |
디스크립션 only | 15 | 13 | 11 |
타이틀 1줄 + 디스크립션 |
14 | 12 | 10 |
타이틀 2줄 + 디스크립션 |
13 | 11 | 9 |
MMS (Carousel Medium - 슬라이드)
[글자 수]
타이틀 | 디스크립션 | 버튼명 |
13 | 14 | 13 |
[줄 수 (Media 없는 경우, RCS A2P 단말 기준)]
버튼 0개 | 버튼 1개 | 버튼 2개 | |
디스크립션 only | 28 | 26 | 23 |
타이틀 1줄 + 디스크립션 | 27 | 25 | 23 |
타이틀 2줄 + 디스크립션 | 26 | 23 | 21 |
타이틀 3줄 + 디스크립션 | 24 | 22 | 20 |
[줄 수(Media Medium인 경우, RCS A2P 단말 기준)]
버튼 0개 | 버튼 1개 | 버튼 2개 | |
디스크립션 only | 17 | 15 | 13 |
타이틀 1줄 + 디스크립션 | 16 | 14 | 12 |
타이틀 2줄 + 디스크립션 | 15 | 13 | 11 |
타이틀 3줄 + 디스크립션 | 14 | 12 | 10 |
MMS (Carousel Small - 슬라이드형)
[글자 수]
타이틀 | 디스크립션 | 버튼명 |
5 | 6 | 5 |
버튼 0개 | 버튼 1개 | 버튼 2개 | |
디스크립션 only | 20 | 18 | 16 |
타이틀 1줄 + 디스크립션 | 19 | 17 | 15 |
타이틀 2줄 + 디스크립션 | 18 | 16 | 14 |
타이틀 3줄 + 디스크립션 | 17 | 15 | 13 |
타이틀 4줄 + 디스크립션 | 16 | 14 | 12 |
타이틀 5줄 + 디스크립션 | 15 | 13 | 11 |
MESSAGE
키 | 타입 | 길이 | 필수 | 설명 |
title | text | - | N | 제목 |
media | text | - | N | 첨부파일 |
descriptlon | text | - | N | 내용 |
MESSAGE(신규 MMS 제외)
키 | 타입 | 필수 | 설명 |
title | text | N | main 제목 |
media | text | N | main 첨부파일 |
description | text | N | main 내용 |
title1 | text | N | 1번째 카드 제목 |
description1 | text | N | 1번째 카드 본문 텍스트 |
media1 | text | N | 1번째 카드 첨부파일 |
title2 | text | N | 2번째 카드 제목 |
description2 | text | N | 2번째 카드 본문 텍스트 |
media2 | text | N | 2번째 카드 첨부파일 |
title3 | text | N | 3번째 카드 제목 |
description3 | text | N | 3번째 카드 본문 텍스트 |
media3 | text | N | 3번째 카드 첨부파일 |
MESSAGE (신규 MMS, 이미지 템플릿 발송 규격 – 이미지 & 타이틀 강조형 )
키 | 타입 | 필수 | 설명 |
media | text | Y | 이미지 *이미지 템플릿 발송 시 불필요 |
mediaUrl | text | N | 이미지 클릭 시 랜딩 URL |
title | text | N | 제목 |
subTitle1 | text | Y | 소제목 1 |
subDesc1 | text | Y | 소본문 1 |
subTitle2 | text | N | 소제목 2 |
subDesc2 | text | N | 소본문 2 |
subTitle3 | text | N | 소제목 3 |
subDesc3 | text | N | 소본문 3 |
MESSAGE (신규 MMS, 이미지 템플릿 발송 규격 – 이미지 강조형, SNS형 )
키 | 타입 | 필수 | 설명 |
media | text | Y | 이미지 *이미지 템플릿 발송 시 불필요 |
mediaUrl | text | N | 이미지 클릭 시 랜딩 URL |
title | text | N | 제목 |
description | text | Y | 본문 |
MESSAGE (신규 MMS, 이미지 템플릿 발송 규격 – 썸네일형 (세로) )
키 | 타입 | 필수 | 설명 |
media | text | Y | main 첨부파일 *이미지 템플릿 발송 시 불필요 |
mediaUrl | text | N | 이미지 클릭 시 랜딩 URL |
title | text | N | 제목 |
description | text | N | 본문 |
subMedia1 | text | Y | 서브 이미지 1 |
subMediaUrl1 | text | N | 서브 이미지 1 클릭 시 랜딩 URL |
subDesc1 | text | Y | 소본문 1 |
subMedia2 | text | Y | 서브 이미지 2 |
subMediaUrl2 | text | N | 서브 이미지 2 클릭 시 랜딩 URL |
subDesc2 | text | Y | 소본문 2 |
subMedia3 | text | N | 서브 이미지 3 |
subMediaUrl3 | text | N | 서브 이미지 3 클릭 시 랜딩 URL |
subDesc3 | text | N | 소본문 3 |
MESSAGE (신규 MMS, 이미지 템플릿 발송 규격 - 썸네일형 (가로) )
키 | 타입 | 필수 | 설명 |
media | text | Y | main 점부파일 *이미지 템플릿 발송 시 불필요 |
mediaUrl | text | N | 이미지 클릭 시 랜딩 URL |
title | text | N | 제목 |
description | text | Y | 본문 |
subMedia1 | text | Y | 서브 이미지 1 |
subMediaUrl1 | text | N | 서브 이미지 1 클릭 시 랜딩 URL |
subMedia2 | text | Y | 서브 이미지 2 |
subMediaUrl2 | text | N | 서브 이미지 2 클릭 시 랜딩 URL |
subMedia3 | text | Y | 서브 이미지 3 |
subMediaUrl3 | text | N | 서브 이미지 3 클릭 시 랜딩 URL |
신규 RCS 포맷
"body": {
"title1": "제목",
"description1": "본문 텍스트",
"media1": "maapfile://{fileId_1}",
"title2": "제목 2번째 카드",
"description2": "본문 텍스트",
"media2": "maapfile://{fileId_2}",
"title3": "제목 3번째 카드",
"description3": "본문 텍스트",
"media3": "maapfile://{fileId_3}",
"media": "maapfile://{fileId_main} > (신규포맷 mms 전용) 상단 main 이미지",
"title": "제목 텍스트 > (신규포맷 mms 전용) 상단 main 제목",
"description": "본문 텍스트 > (신규포맷 mms 전용) 상단 main 본문",
"subMedia1": "maapfile://{fileId_sub1} > (신규포맷 mms 전용) 선택 옵션 서브 이미지 1",
"subMediaUrl1": "URL > (신규포맷 mms 전용) 선택 옵션 서브 이미지 1 클릭 시 랜딩 URL",
"subTitle1": "제목 텍스트 > (신규포맷 mms 전용) 선택 옵션 소제목 1",
"subDesc1": "본문 텍스트 > (신규포맷 mms 전용) 선택 옵션 소본문 1",
"subMedia2": "maapfile://{fileId_sub2} > (신규포맷 mms 전용) 선택 옵션 서브 이미지 2",
"subMediaUrl2": "URL > (신규포맷 mms 전용) 선택 옵션 서브 이미지 2 클릭 시 랜딩 URL",
"subTitle2": "제목 텍스트 > (신규포맷 mms 전용) 선택 옵션 소제목 2",
"subDesc2": "본문 텍스트 > (신규포맷 mms 전용) 선택 옵션 소본문 2",
"subMedia3": "maapfile://{fileId_sub3} > (신규포맷 mms 전용) 선택 옵션 서브 이미지 3",
"subMediaUrl3": "URL > (신규포맷 mms 전용) 선택 옵션 서브 이미지 3 클릭 시 랜딩 URL",
"subTitle3": "제목 텍스트 > (신규포맷 mms 전용) 선택 옵션 소제목 3",
"subDesc3": "본문 텍스트 > (신규포맷 mms 전용) 선택 옵션 소본문 3"
}
Media 종류
이미지
비즈뿌리오 사이트의 [메시지관리] – [RCS 관리] – [RCS 이미지 관리] 메뉴에서 이미지를 등록하여 사용합니다.
이미지는 등록일로부터 365일간 발송 가능합니다. (이후 자동 삭제)
이미지 URL
포맷
maapfile://{fileId}
예시
"media" : "maapfile://BR.i6dOpSm8N8.20200302150000.001"
동영상 스트리밍
-
3가지 형태의 YouTube URL 주소 지원 (정확한 형식을 준수해야 하며, 일부만 일치하는 경우 실패)
-
동영상 썸네일은 등록된 이미지만 사용 가능하며 YouTube URL 뒤에 콤마(,)와 함께 입력 (콤마(,) 외 공백을 포함하는 경우 실패)
-
동영상 발송 시 Footer에 '동영상 재생 시 데이터 요금제가 적용됩니다.' 라는 문구 자동 삽입
동영상 스트리밍 URL
포맷
https://www.youtube.com/watch?v=[videoId],maapfile://{썸네일용 fileId_1}
https://youtu.be/[VideoId],maapfile://{썸네일용 fileId_2}
https://m.youtube.com/watch?v=[videoId],maapfile://{썸네일용 fileId_3}
예시
"media1" : "https://www.youtube.com/watch?v=KCbtF9I0qvI,maapfile://BR.i6dOpSm8N8.20200302150000.001"
BUTTON
키 | 타입 | 설명 |
suggestions | array Of 'suggestions' | * SUGGESTIONS 참조 |
SUGGESTIONS
키 | 타입 | 설명 |
Action | json | * Action 참조 |
ACTION
키 | 타입 | 설명 | |||
displayText | text | ||||
urlAction | json | URL 연결하기 | |||
openUrl | |||||
url | |||||
dialerAction | json | 전화 연결하기 | |||
dialPhoneNumber | |||||
phoneNumber | |||||
mapAction | json | 지도 보여주기 | |||
showLocation | |||||
location | |||||
latitude | |||||
longitude | |||||
label | |||||
fallbackUrl | |||||
mapAction | json | 현재 위치 공유하기 | |||
requestLocationPush | |||||
clipboardAction | json | 복사하기 | |||
copyToClipboard | |||||
text | |||||
composeAction | json | 메시지 전송 | |||
composeTextMessage | |||||
phoneNumber | |||||
text | |||||
calendarAction | json | 캘린더 등록 | |||
createCalendarEvent | |||||
startTime | |||||
endTime | |||||
title | |||||
description |
RCS Examples
RCS : 공통 포맷 SMwThT00 (MMS Standalone Tall) 사용 첨부파일 1개, 버튼 1개
{
"account": "test",
"refkey": "test1234",
"type": "rcs",
"from": "07000000000",
"to": "01000000000",
"content": {
"rcs": {
"messagebaseid": "SMwThT00",
"chatbotid": "15880000",
"header": "1",
"footer": "무료 수신 거부 080-1234-5678",
"copyallowed": "Y",
"message": {
"description": "안녕하세요! MMS-StandaloneTall(SMwThT00)",
"media": " maapfile://BR.05NGK0A6dA.20200326140000.001"
},
"button": [
{
"suggestions": [
{
"action": {
"urlAction": {
"openUrl": {
"url": "https://www.google.com"
}
},
"displayText": "구글로 이동"
}
}
]
}
]
}
}
}
RCS : 공통 포맷 : CMwMhM0300 (MMS Carousel Medium 3장) 사용 첨부파일 3개, 버튼 카드 별 2개
{
"account": "test",
"refkey": "test1234",
"type": "rcs",
"from": "07000000000",
"to": "01000000000",
"content": {
"rcs": {
"messagebaseid": "CMwMhM0300",
"chatbotid": "15880000",
"header": "0",
"copyallowed": "Y",
"message": {
"title1": "첫번째",
"description1": "1번",
"media1": "maapfile://BR.05NGK0A6dA.20200326140000.001",
"title2": "두번째",
"description2": "2번",
"media2": "maapfile://BR.05NGK0A6dA.20200326140000.002",
"title3": "세번째",
"description3": "3번",
"media3": "maapfile://BR.05NGK0A6dA.20200326140000.003"
},
"button": [
{
"suggestions": [
{
"action": {
"urlAction": {
"openUrl": {
"url": "https://www.google.com"
}
},
"displayText": "URL 연결하기"
}
},
{
"action": {
"dialerAction": {
"dialPhoneNumber": {
"phoneNumber": "+1650253000"
}
},
"displayText": "전화 걸기"
}
}
]
},
{
"suggestions": [
{
"action": {
"composeAction": {
"composeTextMessage": {
"phoneNumber": "+1650253000",
"text": "Draft to go into the send message text field."
}
},
"displayText": "메시지 전송"
}
},
{
"action": {
"clipboardAction": {
"copyToClipboard": {
"text": "COUPONE-1234-1234"
}
},
"displayText": "복사하기"
}
}
]
},
{
"suggestions": [
{
"action": {
"calendarAction": {
"createCalendarEvent": {
"startTime": "2017-03-16T17:40:00.214+09:00",
"endTime": "2017-03-18T17:40:00.216+09:00",
"title": "Meeting",
"description": "GSG review meeting"
}
},
"displayText": "캘린더 등록"
}
},
{
"action": {
"mapAction": {
"showLocation": {
"location": {
"latitude": 37.4220041,
"longitude": -122.0862515,
"label": "Googleplex"
},
"fallbackUrl": "https://www.google.com/maps/@37.4219162,-22.078063,15z"
}
},
"displayText": "지도 보여주기"
}
}
]
}
]
}
}
}
New RCS examples
Highlighted image n title (이미지 & 타이틀 강조형)
{
"body": {
"media": "maapfile://fileId123", (필수)
"title": "제목",
"subTitle1": "소제목1",(필수)
"subDesc1": "소본문1",(필수)
"subTitle2": "소제목2",
"subDesc2": "소본문2"
},
"buttons": [
{
"suggestions": [
{
"action": {
"urlAction": {
"openUrl": {
"url": "https://www.google.com"
}
},
"displayText": "구글"
}
},
{
"action": {
"urlAction": {
"openUrl": {
"url": "https://www.naver.com"
}
},
"displayText": "네이버"
}
}
]
}
]
}
이미지 강조형, SNS형
{
"body": {
"media": "maapfile://fileId123",(필수)
"title": "제목",
"description": "본문"(필수)
},
"buttons": [
{
"suggestions": [
{
"action": {
"urlAction": {
"openUrl": {
"url": "https://www.google.com"
}
},
"displayText": "구글"
}
},
{
"action": {
"urlAction": {
"openUrl": {
"url": "https://www.naver.com"
}
},
"displayText": "네이버"
}
}
]
}
]
}
썸네일형 (세로)
{
"body": {
"media": "maapfile://fileId123",(필수)
"title": "제목",
"description": "본문",
"subMedia1": "maapfile://fileid456",(필수)
"subMediaUrl1": "http://www.naver.com",
"subDesc1": "소본문1 이미지클릭가능",(필수)
"subMedia2": "maapfile://fileid789",(필수)
"subDesc2": "소본문2 이미지클릭불가"(필수)
},
"buttons": [
{
"suggestions": [
{
"action": {
"urlAction": {
"openUrl": {
"url": "https://www.google.com"
}
},
"displayText": "구글"
}
},
{
"action": {
"urlAction": {
"openUrl": {
"url": "https://www.naver.com"
}
},
"displayText": "네이버"
}
}
]
}
]
}
썸네일형 (가로)
{
"body": {
"media": "maapfile://fileId123",(필수)
"title": "제목",
"description": "본문",(필수)
"subMedia1": "maapfile://fileid456",(필수)
"subMediaUrl1": "http://www.naver.com",
"subMedia2": "maapfile://fileid789",(필수)
"subMedia3": "maapfile://fileid000"(필수)
},
"buttons": [
{
"suggestions": [
{
"action": {
"urlAction": {
"openUrl": {
"url": "https://www.google.com"
}
},
"displayText": "구글"
}
},
{
"action": {
"urlAction": {
"openUrl": {
"url": "https://www.naver.com"
}
},
"displayText": "네이버"
}
}
]
}
]
}
NTALK
유형 | 키 | 타입 | 길이 | 필수 | 설명 |
ntalk | partnerid | text | 40 | Y | 네이버 톡톡 발송 ID |
partnerkey | text | 64 | Y | 네이버 톡톡 발송 Key | |
msgtype | text | 2 | N | 메시지 타입 *MSGTYPE 참조 | |
username | text | 5 | N | 전화번호 소유자 실명 | |
productcode | text | 64 | Y |
템플릿 생성시 지정한 상품코드 값 - INFORMATION / BENEFIT / CARDINFO |
|
templatecode | text | 64 | Y | 템플릿 코드 | |
groupkey | text | 30 | N |
발송그룹 키 - 발송그룹에 포함된 템플릿과 파트너로 발송 시 필수 |
|
extra | json | - | N | 메시지에 추가될 수 있는 데이터 필드 *EXTRA 참조 | |
message | text | 2048 | N | 템플릿이 변환되어 발송될 최종 텍스트 |
- templateCode와 templateParams는 함께 사용하는 파라미터이며,
가변 컨텐트가 아닌 고정된 내용을 보내고자 한다면 templateCode와 message 파라미터를 이용한다.
MSGTYPE
타입 | 상품코드 | 설명 |
ID | INFORMATION | 정보(Information) 기본 (Default) |
IG | 정보 선물전달 (Gift) | |
IT | 정보 테이블 (Table) | |
BD | BENEFIT | 혜택(Benefit) 기본 (Default) |
BM | 혜택 LMS (Message) | |
BC | 혜택 캐러셀 커머스/피드 (Carousel) | |
BL | 혜택 리스트 커머스/피드 (List) | |
CT | CARDINFO | 카드 템플릿 |
EXTRA
키 | 타입 | 길이 | 필수 | 설명 |
templateParams | json | - | N | 템플릿에서 치환시킬 키와 값 쌍 |
attachment | json | - | N | 메시지에 추가될 수 있는 데이터 필드 |
ATTACHMENT
- 링크버튼(buttons)과 이미지(imageHashId)를 첨부할 수 있는 데이터 필드 입니다.
쿠폰 템플릿의 경우 gift.coupon 필드에 쿠폰 정보를 넣어야 합니다.
키 | 타입 | 길이 | 필수 | 설명 |
imageUrl | text | - | N | http 로 시작하는 이미지 URL |
imageHashId | text | 64 | N | 이미지 업로드 API를 이용하여 업로드한 hashId |
buttons | array | 5 | N | 템플릿 등록한 buttons 정보 |
gift | json | N |
선물 전달 타입의 템플릿일 경우 사용 *GIFT 참고 |
BUTTONS
키 | 타입 | 길이 | 필수 | 설명 |
buttonCode | text | - | Y | 등록 시 사용한 버튼 코드 |
pcUrl | text | - | N |
PC 환경에서 버튼 클릭 시 이동할 링크 - WEB_LINK 타입일 시 필수 |
mobileUrl | text | - | N |
Mobile 환경에서 버튼 클릭 시 이동할 링크 - WEB_LINK 타입일 시 필수 |
aOsAppScheme | text | - | N |
Android 환경에서 버튼 클릭 시 이동할 앱링크 - APP_LINK 타입일 시 필수 |
iOsAppScheme | text | - | N |
iOS 환경에서 버튼 클릭 시 이동할 앱링크 - APP_LINK 타입일 시 필수 |
GIFT
키 | - | 타입 | 길이 | 필수 | 설명 |
coupon | json | - | - | 쿠폰 | |
code | text | - | Y | 쿠폰 코드 | |
name | text | - | N |
쿠폰 이름 - 미입력시 템플릿에 등록된 이름으로 발송 |
|
endDate | text | - | Y |
쿠폰 종료일자 - '-'로 구분하여 입력 (e.g., "2024-04-10") |
|
publisher | text | - | N |
쿠폰 발급자 - 미입력시 표시되지 않음 |
|
imageUrl | text | - | N | 쿠폰에 표시될 이미지 URL |
NTALK 버튼 포함 예시
{
"account": "test",
"refkey": "test1234",
"type": "ntalk",
"from": "07000000000",
"to": "01000000000",
"content": {
"ntalk": {
"partnerid": "partnerid",
"partnerkey": "partnerkey",
"msgtype": "ID",
"username": "홍길동",
"productcode": "INFORMATION",
"templatecode": "templatecode",
"groupkey": "groupkey",
"extra": {
"templateParams": {
"orderNo": "19102387851"
},
"attachments": {
"buttons": [
{
"buttonCode": "dailyExpressionGroup",
"pcUrl": "https://www.yourdomain.com/dailyExpressionGroup?user=2919",
"mobileUrl": "https://m.yourdomain.com/dailyExpressionGroup?user=2919"
}
]
}
}
}
}
}
NTALK 쿠폰 포함 예시
{
"account": "test",
"refkey": "test1234",
"type": "ntalk",
"from": "07000000000",
"to": "01000000000",
"content": {
"ntalk": {
"partnerid": "partnerid",
"partnerkey": "partnerkey",
"msgtype": "ID",
"username": "홍길동",
"productcode": "INFORMATION",
"templatecode": "templatecode",
"groupkey": "groupkey",
"extra": {
"templateParams": {
"orderNo": "19102387851"
},
"attachments": {
"gift": {
"coupon": {
"code": "couponCode",
"name": "couponName",
"endDate": "2022-09-30",
"publisher": "네이버톡톡",
"imageUrl": "https://ssl.pstatic.net/static.talk/biztalk/202204212248/front/chat/img/shoppingbot.png"
}
}
}
}
}
}
}
NTALK 이미지 포함 예시
{
"account": "test",
"refkey": "test1234",
"type": "ntalk",
"from": "07000000000",
"to": "01000000000",
"content": {
"ntalk": {
"partnerid": "partnerid",
"partnerkey": "partnerkey",
"msgtype": "ID",
"username": "홍길동",
"productcode": "INFORMATION",
"templatecode": "templatecode",
"groupkey": "groupkey",
"extra": {
"templateParams": {
"orderNo": "19102387851"
},
"attachments": {
"imageUrl": "https://cdn.yourdomain.com/images/about.png",
"imageHashId": " 8mF7nz1FGtEQbhJ8eyMAXqbUIMi5txscQbB_RRbGWATp6WpcI8CwA_KFG_eLmrRY"
}
}
}
}
}
국제 메시지 발송
-
해외수신자에게 국제 메시지를 발송하는 서비스
메시지 유형별 메시지 길이 제한
1. 수신번호(to) : 002+국가코드+수신번호
지원 메시지 유형 | 주요 파라미터 예시 |
SMS | "to" : "00211012341234" |
LMS |
"to" : "00211012341234" |
2. country : 국가코드 , to : 수신번호
메시지 유형 | 대체 전송 메시지 유형 |
주요 파라미터 예시 |
SMS | - | "country" : 1 "to" : "01012341234" |
LMS | - | |
AT/AI | - | |
SMS | ||
LMS | ||
FT | - | |
SMS | ||
LMS |
Response
Headers
HTTP/1.1 200 OK
Content-type: application/json
Body
키 | 타입 | 길이 | 필수 | 설명 |
code | text | 5 | Y | 결과 코드 * API 응답 상대 및 결과 코드 참조 |
description | text | 32 | Y | 결과 메시지 |
messagekey | text | 32 | Y | 메시지 키 * 고객 문의 및 리포트 재 요청 기준 키 |
refkey | Text | 32 | Y | 고객사에서 부여한 키 |
예시)
{
"code": 1000,
"description": "Success",
"refkey": "123456789012345678901234890123",
"messagekey": "190922175225820#ft002951servj8FU67"
}
대체발송
RESEND
메시지 발송이 실패한 경우, 대체 전송 설정
키 | 타입 | 필수 | 설명 |
first | text | N |
1차 대체 발송 메시지 유형 *sms, mms, lms, at, ai, rcs |
second | text | N |
2차 대체 발송 메시지 유형 *sms, mms |
1차 대체 발송
예시 (AT 발송 실패하는 경우, SMS (1차) 대체 발송)
{
"account": "test",
"refkey": "test1234",
"type": "at",
"from": "07000000000",
"to": "01000000000",
"content": {
"at": {
"senderkey": "12345",
"templatecode": "template",
"message": "알림톡 + 버튼(WL)",
"button": [
{
"name": "웹 링크 버튼",
"type": "WL",
"url_mobile": "https: //www.daou.com",
"url_pc": "https://www.daou.com"
}
]
}
},
"resend": {
"first": "sms"
},
"recontent": {
"sms": {
"message": "SMS 대체 발송"
}
}
}
2차 대체 발송
예시 (RCS 발송 실패하는 경우, AT (1차) 대체 발송, AT (1차) 대체 발송 실패하는 경우, SMS (2차) 대체 발송)
{
"account": "test",
"refkey": "test1234",
"type": "rcs",
"from": "07000000000",
"to": "01000000000",
"content": {
"rcs": {
"messagebaseid": "SL000000",
"chatbotid": "15880000",
"header": "0",
"copyallowed": "Y",
"message": {
"title": "RCS LMS",
"description": "RCS 전송"
},
"button": [
{
"suggestions": [
{
"action": {
"mapAction": {
"requestLocationPush": {}
},
"displayText": "현재 위치 공유하기"
}
}
]
}
]
}
},
"resend": {
"first": "at",
"second": "sms"
},
"recontent": {
"at": {
"senderkey": "1234",
"templatecode": "template",
"message": "알림톡 전송",
"button": [
{
"name": "웹 링크 버튼",
"type": "WL",
"url_mobile": "https://www.daou.com"
}
]
},
"sms": {
"message": "SMS 대체 발송"
}
}
}
댓글
댓글 0개
이 문서에는 댓글을 달 수 없습니다.