A. 객체정보
Response
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | long | - |
API 처리에 대한 응답코드
1성공
|
|
| message | String | - | API 처리에 대한 응답메시지 |
PopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | long | - |
API 처리 실패에 대한 오류코드
음의 정수 8자리 숫자값 [참고] 오류코드
|
|
| Message | String | - | API 처리 실패에 대한 오류메시지 |
SenderNumber
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| number | String | 20 | 발신번호 | |
| representYN | bool? | N |
대표번호 지정여부
true대표번호
false일반번호
|
|
| state | int? | 1 |
상태
0대기
1사용
2중지
5반려
|
|
| memo | String | 200 | 메모 |
PlusFriendID
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| plusFriendID | String | 30 | 검색용 아이디 | |
| plusFriendName | String | 100 | 채널명 | |
| regDT | String | 14 |
등록일시
형식 : yyyyMMddHHmmss
|
|
| state | int | - |
채널 상태
|
|
| stateDT | String | 14 |
채널 상태 일시
형식 : yyyyMMddHHmmss
|
ATSTemplate
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| templateCode | String | 12 | 템플릿 코드 | |
| templateName | String | 20 | 템플릿 제목 | |
| template | String | 1000 | 템플릿 내용 | |
| emphasizeTitle | String | 50 | 강조표기 타이틀 | |
| emphasizeSubTitle | String | 50 | 강조표기 보조 문구 | |
| plusFriendID | String | 30 | 검색용 아이디 | |
| ads | String | 80 | 광고 메시지 | |
| appendix | String | 500 | 부가 메시지 | |
| secureYN | bool | - |
보안템플릿 여부
true보안템플릿
false일반템플릿
|
|
| state | String | 1 |
템플릿 상태
|
|
| stateDT | String | 14 |
템플릿 상태 일시
형식 : yyyyMMddHHmmss
|
|
| btns | List<KakaoButton> |
버튼 목록
최대 : 5개
|
||
KakaoReceiver
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| receiveNum | String | 20 | Y | 수신번호 | |
| receiveName | String | 70 | N | 수신자명 | |
| content | String | - | 조건부 |
알림톡 내용 (템플릿 내용의 변수 치환 필요)
대량전송 경우 필수
알림톡(텍스트) : 최대 1,000자 - 템플릿 예시 : 주문하신 #{상품}이 금일 발송 처리되었습니다. - 작성 예시 : 주문하신 노트북이 금일 발송 처리되었습니다. |
|
| altSubject | String | 40 | N |
대체문자 제목
대량전송 경우 사용
메시지 길이가 90byte 이상인 경우에만 적용 |
|
| altContent | String | 2000 | N |
대체문자 내용
대량전송 경우 사용
|
|
| btns | List<KakaoButton> | N |
버튼 목록
대량전송 경우 사용
최대 : 5개 |
||
| interOPRefKey | String | 20 | N |
파트너 지정키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
|
| emphasizeTitle | String | 50 | N |
강조표기 타이틀
알림톡 템플릿 유형이 '강조표기형' 인 경우에만 적용
- 템플릿 예시 : 주문하신 #{상품}이 도착했습니다. - 작성 예시 : 주문하신 노트북이 도착했습니다. 기본값 : 승인된 템플릿의 강조표기 타이틀
|
|
KakaoReceiver
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| receiveNum | String | 20 | Y | 수신번호 | |
| receiveName | String | 70 | N | 수신자명 | |
| content | String | - | 조건부 |
브랜드 메시지 내용
줄바꿈 최대 99개
대량 전송인 경우 필수
|
|
| altSubject | String | 40 | N |
대체문자 제목
대체문자 내용이 90byte 이상인 경우에만 적용
대량 전송인 경우 필수
|
|
| altMessage | String | 2000 | N |
대체문자 내용
대체문자 전송 시 필수
단위 : byte 대량 전송인 경우 입력
|
|
| interOPRefKey | String | 20 | N |
파트너 지정키
브랜드 메시지 대량 전송 시 파트너가 개별건마다 입력할 수 있는 값
|
|
| btns | List<KakaoButton> | N |
버튼 목록
최대 5개 (쿠폰 강조을 포함하는 경우 최대 4개)
대량 전송인 경우 입력
|
||
| coupon | KakaoCoupon | N |
쿠폰 강조
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수 대량 전송인 경우 입력
|
||
KakaoReceiver
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| receiveNum | String | 20 | Y | 수신번호 | |
| receiveName | String | 70 | N | 수신자명 | |
| imageUrl | String | 500 | Y |
이미지 URL
[UploadImage - 이미지 업로드] API로 응답받은 URL
|
|
| imageLink | String | 500 | N |
이미지 링크 URL
이미지를 클릭하면 연결되는 URL
|
|
| content | String | - | 조건부 |
브랜드 메시지 내용
줄바꿈 최대 99개
대량 전송인 경우 필수
|
|
| altSubject | String | 40 | N |
대체문자 제목
대체문자 내용이 90byte 이상인 경우에만 적용
대량 전송인 경우 필수
|
|
| altMessage | String | 2000 | N |
대체문자 내용
대체문자 전송 시 필수
단위 : byte 대량 전송인 경우 입력
|
|
| interOPRefKey | String | 20 | N |
파트너 지정키
브랜드 메시지 대량 전송 시 파트너가 개별건마다 입력할 수 있는 값
|
|
| btns | List<KakaoButton> | N |
버튼 목록
최대 5개 (쿠폰 강조을 포함하는 경우 최대 4개)
대량 전송인 경우 입력
|
||
| coupon | KakaoCoupon | N |
쿠폰 강조
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수 대량 전송인 경우 입력
|
||
KakaoReceiver
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| receiveNum | String | 20 | Y | 수신번호 | |
| receiveName | String | 70 | N | 수신자명 | |
| imageUrl | String | 500 | Y |
이미지 URL
[UploadWideImage - 와이드 이미지 업로드] API로 응답받은 URL
|
|
| imageLink | String | 500 | N |
이미지 링크 URL
이미지를 클릭하면 연결되는 URL
|
|
| content | String | - | 조건부 |
브랜드 메시지 내용
줄바꿈 최대 99개
대량 전송인 경우 필수
|
|
| altSubject | String | 40 | N |
대체문자 제목
대체문자 내용이 90byte 이상인 경우에만 적용
대량 전송인 경우 필수
|
|
| altMessage | String | 2000 | N |
대체문자 내용
대체문자 전송 시 필수
단위 : byte 대량 전송인 경우 입력
|
|
| interOPRefKey | String | 20 | N |
파트너 지정키
브랜드 메시지 대량 전송 시 파트너가 개별건마다 입력할 수 있는 값
|
|
| btns | List<KakaoButton> | N |
버튼 목록
최대 5개 (쿠폰 강조을 포함하는 경우 최대 4개)
대량 전송인 경우 입력
|
||
| coupon | KakaoCoupon | N |
쿠폰 강조
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수 대량 전송인 경우 입력
|
||
KakaoReceiver
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| receiveNum | String | 20 | Y | 수신번호 | |
| receiveName | String | 70 | N | 수신자명 | |
| interOPRefKey | String | 20 | N |
파트너 지정 키
카카오톡 동보전송시 파트너가 개별건마다 입력한 값
|
KakaoSearchResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| code | long | - |
API 처리에 대한 응답코드
1성공
|
|
| message | String | - | API 처리에 대한 응답메시지 | |
| total | long | - | 총 검색결과 건수 | |
| perPage | long | - | 페이지 당 목록 건수 | |
| pageNum | long | - | 페이지 번호 | |
| pageCount | long | - | 페이지 개수 | |
| list | List<KakaoSentDetail> |
전송결과 정보
최대 : 1,000건
|
||
KakaoSentResult
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| contentType | String | - |
카카오톡 유형
1알림톡
4알림톡 이미지
5알림톡 강조표기
6브랜드 메시지 텍스트
7브랜드 메시지 이미지
8브랜드 메시지 와이드
9브랜드 메시지 리스트
10브랜드 메시지 캐러셀
11브랜드 메시지 동영상
12브랜드 메시지 커머스
13브랜드 메시지 캐러셀 커머스
|
|
| templateCode | String | 12 |
템플릿 코드
알림톡 전송 시 반환
|
|
| plusFriendID | String | 30 | 검색용 아이디 | |
| targeting | String | 1 |
전송대상
I채널친구
M전체
N비채널 친구
브랜드 메시지 전송 시 반환
|
|
| unsubscribeNo | String | 20 |
080 무료수신거부 전화번호
브랜드 메시지 전송 시 반환
|
|
| sendNum | String | 20 | 발신번호 | |
| altUnsubscribeNo | String | 20 |
대체문자 080 무료수신거부 전화번호
브랜드 메시지 전송 시 반환
|
|
| altSubject | String | 40 | 대체문자 제목 | |
| altContent | String | 2000 |
대체문자 내용
단위 : byte
|
|
| altSendType | String | 1 |
대체문자 유형
null미전송
C카카오톡과 동일 내용 전송
A대체문자 내용 전송
|
|
| reserveDT | String | 14 |
예약일시
형식 : yyyyMMddHHmmss
|
|
| adsYN | String | - |
광고메시지 전송 여부
true광고
false일반
|
|
| sendCnt | String | - | 전송건수 | |
| successCnt | String | - | 성공건수 | |
| failCnt | String | - | 실패건수 | |
| altCnt | String | - | 대체문자 건수 | |
| cancelCnt | String | - | 취소건수 | |
| btns | List<KakaoButton> |
버튼 목록
최대 : 5개
|
||
| msgs | List<KakaoSentDetail> |
전송결과 정보
최대 : 1,000건
|
||
KakaoButton
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| n | String | 14 | Y | 버튼명 | |
| t | String | 2 | Y |
버튼유형
채널 추가 버튼은 첫번째 위치에만 가능
|
|
| u1 | String | 1000 | 조건부 |
버튼링크
- {t} = "AL" 경우 iOS 앱링크 적용 - {t} = "WL" 경우 Mobile 웹링크 적용 |
|
| u2 | String | 1000 | 조건부 |
버튼링크
- {t} = "AL" 경우 Android 앱링크 적용 - {t} = "WL" 경우 PC 웹링크 적용 |
KakaoButton
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| n | String | 8 | Y | 버튼명 | |
| t | String | 2 | Y |
버튼유형
버튼 1개인 경우 채널추가 버튼은 첫번째 위치만 가능
버튼 2개인 경우 채널추가 버튼은 두번째 위치만 가능 |
|
| u1 | String | 1000 | 조건부 |
버튼링크
- {t} = "AL" 경우 iOS 앱링크 적용 - {t} = "WL" 경우 Mobile 웹링크 적용 |
|
| u2 | String | 1000 | 조건부 |
버튼링크
- {t} = "AL" 경우 Android 앱링크 적용 - {t} = "WL" 경우 PC 웹링크 적용 |
KakaoButton
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| n | String | 14 | 버튼명 | |
| t | String | 2 |
버튼유형
|
|
| u1 | String | 1000 |
버튼링크
- {t} = "AL" 경우 iOS 앱링크 적용 - {t} = "WL" 경우 Mobile 웹링크 적용 |
|
| u2 | String | 1000 |
버튼링크
- {t} = "AL" 경우 Android 앱링크 적용 - {t} = "WL" 경우 PC 웹링크 적용 |
|
| tg | String | 3 |
아웃 링크
out디바이스 기본 브라우저
공백(기본값) : 카카오톡 인앱 브라우저 사용
|
BMSText (단건)
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| plusFriendID | String | 30 | Y | 검색용 아이디 | |
| targeting | String | 1 | Y |
전송대상
I채널친구
M전체
N비채널 친구
|
|
| unsubscribeNo | String | 13 | 조건부 |
080 수신거부 번호
{targeting}="N" or "M" 인 경우 필수
|
|
| receiveNum | String | 20 | Y | 수신번호 | |
| receiveName | String | 70 | N | 수신자명 | |
| adultYN | Boolean? | - | N |
성인용 메시지 여부
기본값 : false
|
|
| content | String | 1300 | Y |
브랜드 메시지 내용
줄바꿈 최대 99개
|
|
| altYN | Boolean? | - | N |
대체문자 전송 여부
기본값 : false
|
|
| sendNum | String | 20 | 조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환 |
|
| altSubject | String | 40 | N |
대체문자 제목
대체문자 내용이 90byte 이상인 경우에만 적용
|
|
| altContent | String | 2000 | 조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte |
|
| altUnsubscribeNo | String | 20 | 조건부 |
대체문자 080 수신거부 번호
대체문자 전송 시 필수
|
|
| reserveDT | String | 14 | N |
전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50 기본값 : 즉시전송
|
|
| requestNum | String | 36 | N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
|
|
| buttons | KakaoButton[ ] | N |
버튼 목록
최대 5개 (쿠폰 강조을 포함하는 경우 최대 4개)
|
||
| coupon | KakaoCoupon | - | N |
쿠폰 강조
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수 |
|
BMSText (동보)
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| plusFriendID | String | 30 | Y | 검색용 아이디 | |
| targeting | String | 1 | Y |
전송대상
I채널친구
M전체
N비채널 친구
|
|
| unsubscribeNo | String | 13 | 조건부 |
080 수신거부 번호
{targeting}="N" or "M" 인 경우 필수
|
|
| adultYN | Boolean? | - | N |
성인용 메시지 여부
기본값 : false
|
|
| content | String | 1300 | Y |
브랜드 메시지 내용
줄바꿈 최대 99개
|
|
| altYN | Boolean? | - | N |
대체문자 전송 여부
기본값 : false
|
|
| sendNum | String | 20 | 조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환 |
|
| altSubject | String | 40 | N |
대체문자 제목
대체문자 내용이 90byte 이상인 경우에만 적용
|
|
| altContent | String | 2000 | 조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte |
|
| altUnsubscribeNo | String | 20 | 조건부 |
대체문자 080 수신거부 번호
대체문자 전송 시 필수
|
|
| reserveDT | String | 14 | N |
전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50 기본값 : 즉시전송
|
|
| requestNum | String | 36 | N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
|
|
| buttons | KakaoButton[ ] | N |
버튼 목록
최대 5개 (쿠폰 강조을 포함하는 경우 최대 4개)
|
||
| coupon | KakaoCoupon | - | N |
쿠폰 강조
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수 |
|
| receivers | KakaoReceiver[ ] | Y |
전송정보
최대 : 1,000개
|
||
BMSImage (단건)
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| plusFriendID | String | 30 | Y | 검색용 아이디 | |
| targeting | String | 1 | Y |
전송대상
I채널친구
M전체
N비채널 친구
|
|
| unsubscribeNo | String | 13 | 조건부 |
080 수신거부 번호
{targeting}="N" or "M" 인 경우 필수
|
|
| imageUrl | String | 500 | Y |
이미지 URL
[UploadImage - 이미지 업로드] API로 응답받은 URL
|
|
| imageLink | String | 500 | N |
이미지 링크 URL
이미지를 클릭하면 연결되는 URL
|
|
| receiveNum | String | 20 | Y | 수신번호 | |
| receiveName | String | 70 | N | 수신자명 | |
| adultYN | Boolean? | - | N |
성인용 메시지 여부
기본값 : false
|
|
| content | String | 1300 | Y |
브랜드 메시지 내용
줄바꿈 최대 99개
|
|
| altYN | Boolean? | - | N |
대체문자 전송 여부
기본값 : false
|
|
| sendNum | String | 20 | 조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환 |
|
| altSubject | String | 40 | N |
대체문자 제목
대체문자 내용이 90byte 이상인 경우에만 적용
|
|
| altContent | String | 2000 | 조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte |
|
| altUnsubscribeNo | String | 20 | 조건부 |
대체문자 080 수신거부 번호
대체문자 전송 시 필수
|
|
| reserveDT | String | 14 | N |
전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50 기본값 : 즉시전송
|
|
| requestNum | String | 36 | N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
|
|
| buttons | KakaoButton[ ] | N |
버튼 목록
최대 5개 (쿠폰 강조을 포함하는 경우 최대 4개)
|
||
| coupon | KakaoCoupon | - | N |
쿠폰 강조
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수 |
|
BMSImage (동보)
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| plusFriendID | String | 30 | Y | 검색용 아이디 | |
| targeting | String | 1 | Y |
전송대상
I채널친구
M전체
N비채널 친구
|
|
| unsubscribeNo | String | 13 | 조건부 |
080 수신거부 번호
{targeting}="N" or "M" 인 경우 필수
|
|
| imageUrl | String | 500 | Y |
이미지 URL
[UploadImage - 이미지 업로드] API로 응답받은 URL
|
|
| imageLink | String | 500 | N |
이미지 링크 URL
이미지를 클릭하면 연결되는 URL
|
|
| adultYN | Boolean? | - | N |
성인용 메시지 여부
기본값 : false
|
|
| content | String | 1300 | Y |
브랜드 메시지 내용
줄바꿈 최대 99개
|
|
| altYN | Boolean? | - | N |
대체문자 전송 여부
기본값 : false
|
|
| sendNum | String | 20 | 조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환 |
|
| altSubject | String | 40 | N |
대체문자 제목
대체문자 내용이 90byte 이상인 경우에만 적용
|
|
| altContent | String | 2000 | 조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte |
|
| altUnsubscribeNo | String | 20 | 조건부 |
대체문자 080 수신거부 번호
대체문자 전송 시 필수
|
|
| reserveDT | String | 14 | N |
전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50 기본값 : 즉시전송
|
|
| requestNum | String | 36 | N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
|
|
| buttons | KakaoButton[ ] | N |
버튼 목록
최대 5개 (쿠폰 강조을 포함하는 경우 최대 4개)
|
||
| coupon | KakaoCoupon | - | N |
쿠폰 강조
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수 |
|
| receivers | KakaoReceiver[ ] | Y |
전송정보
최대 : 1,000개
|
||
BMSWideImage (단건)
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| plusFriendID | String | 30 | Y | 검색용 아이디 | |
| targeting | String | 1 | Y |
전송대상
I채널친구
M전체
N비채널 친구
|
|
| unsubscribeNo | String | 13 | 조건부 |
080 수신거부 번호
{targeting}="N" or "M" 인 경우 필수
|
|
| imageUrl | String | 500 | Y |
이미지 URL
[UploadWideImage - 와이드 이미지 업로드] API로 응답받은 URL
|
|
| imageLink | String | 500 | N |
이미지 링크 URL
이미지를 클릭하면 연결되는 URL
|
|
| receiveNum | String | 20 | Y | 수신번호 | |
| receiveName | String | 70 | N | 수신자명 | |
| adultYN | Boolean? | - | N |
성인용 메시지 여부
기본값 : false
|
|
| content | String | 76 | Y |
브랜드 메시지 내용
줄바꿈 최대 5개
|
|
| altYN | Boolean? | - | N |
대체문자 전송 여부
기본값 : false
|
|
| sendNum | String | 20 | 조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환 |
|
| altSubject | String | 40 | N |
대체문자 제목
대체문자 내용이 90byte 이상인 경우에만 적용
|
|
| altContent | String | 2000 | 조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte |
|
| altUnsubscribeNo | String | 20 | 조건부 |
대체문자 080 수신거부 번호
대체문자 전송 시 필수
|
|
| reserveDT | String | 14 | N |
전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50 기본값 : 즉시전송
|
|
| requestNum | String | 36 | N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
|
|
| buttons | KakaoButton[ ] | N |
버튼 목록
최대 2개
|
||
| coupon | KakaoCoupon | - | N |
쿠폰 강조
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수 |
|
BMSWideImage (동보)
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| plusFriendID | String | 30 | Y | 검색용 아이디 | |
| targeting | String | 1 | Y |
전송대상
I채널친구
M전체
N비채널 친구
|
|
| unsubscribeNo | String | 13 | 조건부 |
080 수신거부 번호
{targeting}="N" or "M" 인 경우 필수
|
|
| imageUrl | String | 500 | Y |
이미지 URL
[UploadWideImage - 와이드 이미지 업로드] API로 응답받은 URL
|
|
| imageLink | String | 500 | N |
이미지 링크 URL
이미지를 클릭하면 연결되는 URL
|
|
| adultYN | Boolean? | - | N |
성인용 메시지 여부
기본값 : false
|
|
| content | String | 76 | Y |
브랜드 메시지 내용
줄바꿈 최대 5개
|
|
| altYN | Boolean? | - | N |
대체문자 전송 여부
기본값 : false
|
|
| sendNum | String | 20 | 조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환 |
|
| altSubject | String | 40 | N |
대체문자 제목
대체문자 내용이 90byte 이상인 경우에만 적용
|
|
| altContent | String | 2000 | 조건부 |
대체문자 내용
대체문자 전송 시 필수
단위 : byte |
|
| altUnsubscribeNo | String | 20 | 조건부 |
대체문자 080 수신거부 번호
대체문자 전송 시 필수
|
|
| reserveDT | String | 14 | N |
전송 예약일시
형식 : yyyyMMddHHmmss
예약 가능 시간 08:00~20:50 기본값 : 즉시전송
|
|
| requestNum | String | 36 | N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-', '_')만 이용 가능
|
|
| buttons | KakaoButton[ ] | N |
버튼 목록
최대 2개
|
||
| coupon | KakaoCoupon | - | N |
쿠폰 강조
채널 쿠폰 사용 시 linkAndroid, linkIos 중 1개 필수
외부 쿠폰 사용 시 linkMobile 필수 |
|
| receivers | KakaoReceiver[ ] | Y |
전송정보
최대 : 1,000개
|
||
KakaoCoupon (입력부)
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| title | String | 15 | Y |
쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
|
|
| description | String | 12 | Y |
쿠폰 설명
줄바꿈 사용 불가
|
|
| linkMobile | String | 1000 | 조건부 | Mobile 웹링크 | |
| linkPc | String | 1000 | N | PC 웹링크 | |
| linkAndroid | String | 1000 | 조건부 | Android 앱링크 | |
| linkIos | String | 1000 | 조건부 | iOS 앱링크 |
KakaoCoupon (입력부)
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| title | String | 15 | Y |
쿠폰 제목
#{숫자}원 할인 쿠폰(숫자 : 1~99,999,999)
#{숫자}% 할인 쿠폰(숫자 : 1~100)
배송비 할인 쿠폰
#{7자 이내} 무료 쿠폰
#{7자 이내} UP 쿠폰
|
|
| description | String | 18 | Y |
쿠폰 설명
줄바꿈 사용 불가
|
|
| linkMobile | String | 1000 | 조건부 | Mobile 웹링크 | |
| linkPc | String | 1000 | N | PC 웹링크 | |
| linkAndroid | String | 1000 | 조건부 | Android 앱링크 | |
| linkIos | String | 1000 | 조건부 | iOS 앱링크 |
KakaoCoupon
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| title | String | 15 | 쿠폰 제목 | |
| description | String | 18 | 쿠폰 설명 | |
| linkMobile | String | 1000 | Mobile 웹링크 | |
| linkPc | String | 1000 | PC 웹링크 | |
| linkAndroid | String | 1000 | Android 앱링크 | |
| linkIos | String | 1000 | iOS 앱링크 |
KakaoSentDetail
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| state | int? | 1 | 상태코드 | |
| sendDT | String | 14 |
전송일시
형식 : yyyyMMddHHmmss
|
|
| result | int? | 3 |
카카오 결과코드
{state} = 3 경우 카카오톡 전송결과 확인 가능
|
|
| resultDT | String | 14 |
전송결과 수신일시
형식 : yyyyMMddHHmmss
|
|
| contentType | String | - |
카카오톡 유형
1알림톡
4알림톡 이미지
5알림톡 강조표기
6브랜드 메시지 텍스트
7브랜드 메시지 이미지
8브랜드 메시지 와이드
9브랜드 메시지 리스트
10브랜드 메시지 캐러셀
11브랜드 메시지 동영상
12브랜드 메시지 커머스
13브랜드 메시지 캐러셀 커머스
|
|
| receiveNum | String | 20 | 수신번호 | |
| receiveName | String | 70 | 수신자명 | |
| emphasizeTitle | String | 50 |
강조표기 타이틀
알림톡 강조표기형 전송 시 반환
|
|
| content | String | 1300 | 카카오톡 내용 | |
| altSubject | String | 40 | 대체문자 제목 | |
| altContent | String | 2000 |
대체문자 내용
단위 : byte
|
|
| altContentType | int? | N |
대체문자 전송타입
4단문
6장문
|
|
| altSendDT | String | 14 |
대체문자 전송일시
형식 : yyyyMMddHHmmss
|
|
| altResult | String | 3 | 대체문자 통신사 결과코드 | |
| altResultDT | String | 14 |
대체문자 전송결과 수신일시
형식 : yyyyMMddHHmmss
|
|
| reserveDT | String | 14 |
예약일시
형식 : yyyyMMddHHmmss
|
|
| receiptNum | String | 18 | 접수번호 | |
| requestNum | String | 36 | 요청번호 | |
| interOPRefKey | String | 20 |
파트너 지정키
카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값
|
|
| btns | List<KakaoButton> |
버튼 목록
최대 : 5개
|
||
| coupon | KakaoCoupon | - |
쿠폰 강조
브랜드 메시지 전송 시 반환
|
|
BinaryFile
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| fileName | String | - | Y | 파일명 | |
| fileData | Stream | - | Y | 바이너리 데이터 |












