알림톡 템플릿

1. GetATSTemplateMgtURL - 알림톡 템플릿 등록 팝업 URL

미리보기

알림톡 템플릿을 등록하는 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 1,200px (최소 1,000px) / height = 800px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

function string getATSTemplateMgtURL(string corpnum, string userid) throws popbillexception

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	userid	string	50	N	팝빌회원 아이디

응답

string - 요청에 대한 응답 URL

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	string	-	API 처리 실패에 대한 오류메시지

2. GetATSTemplate - 알림톡 템플릿 정보 확인

알림톡 템플릿 정보를 확인합니다.

function atstemplate getatstemplate (string corpnum, string templatecode, string userid) throws popbillexception

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	templatecode	string	12	Y	템플릿 코드
3	userid	string	50	N	팝빌회원 아이디

응답

ATSTemplate

순번	변수명	타입	길이	설명
1	templateCode	string	12	템플릿 코드
2	templateName	string	20	템플릿 제목
3	template	string	1,300	템플릿 내용
4	plusFriendID	string	30	검색용 아이디
5	ads	string	80	광고 메시지
6	appendix	string	500	부가 메시지
7	secureYN	boolean	-	보안템플릿 여부 true 보안템플릿 false 일반템플릿
8	state	integer	1	템플릿 상태 0 임시저장 2 심사중 3 승인 4 반려 5 정지 7 휴면 8 삭제
9	stateDT	string	14	템플릿 상태 일시 → 형식 : yyyyMMddHHmmss
10	btns	KakaoButton[ ]	5	버튼 목록
KakaoButton[ ] 순번 변수명 타입 길이 설명 1 n string 14 버튼명 2 t string 2 버튼유형 WL 웹링크 AL 앱링크 DS 배송조회 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 string 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 string 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	string	-	API 처리 실패에 대한 오류메시지

3. ListATSTemplate - 알림톡 템플릿 목록 확인

“승인” 상태의 알림톡 템플릿 목록을 확인합니다.

subroutine listatstemplate(string corpnum, ref atstemplate ref_list[]) throws popbillexception

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	corpnum	string	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	ref_list	ref ATSTemplate[ ]	-	Y	서브루틴 반환 결과값
ref ATSTemplate[ ] 순번 변수명 타입 길이 필수 설명 1 templateCode string 12 N 템플릿 코드 2 templateName string 20 N 템플릿 제목 3 template string 1000 N 템플릿 내용 4 plusFriendID string 30 N 검색용 아이디 5 ads string 80 N 광고 메시지 6 appendix string 500 N 부가 메시지 7 secureYN boolean - N 보안템플릿 여부 true 보안템플릿 false 일반템플릿 8 state integer 1 N 템플릿 상태 0 임시저장 2 심사중 3 승인 4 반려 5 정지 7 휴면 8 삭제 9 stateDT string 14 N 템플릿 상태 일시 → 형식 : yyyyMMddHHmmss 10 btns KakaoButton[ ] - N 버튼 목록 → 최대 : 5개 KakaoButton[ ] 순번 변수명 타입 길이 필수 설명 1 n string 14 N 버튼명 2 t string 2 N 버튼유형 WL 웹링크 AL 앱링크 MD 메시지전달 DS 배송조회 BK 봇키워드 AC 채널추가 3 u1 string 1000 N 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 string 1000 N 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용

응답

ATSTemplate

순번	변수명	타입	길이	설명
1	templateCode	string	12	템플릿 코드
2	templateName	string	20	템플릿 제목
3	template	string	1,300	템플릿 내용
4	plusFriendID	string	30	검색용 아이디
5	ads	string	80	광고 메시지
6	appendix	string	500	부가 메시지
7	secureYN	boolean	-	보안템플릿 여부 true 보안템플릿 false 일반템플릿
8	state	integer	1	템플릿 상태 0 임시저장 2 심사중 3 승인 4 반려 5 정지 7 휴면 8 삭제
9	stateDT	string	14	템플릿 상태 일시 → 형식 : yyyyMMddHHmmss
10	btns	KakaoButton[ ]	5	버튼 목록
KakaoButton[ ] 순번 변수명 타입 길이 설명 1 n string 14 버튼명 2 t string 2 버튼유형 WL 웹링크 AL 앱링크 DS 배송조회 MD 메시지전달 BK 봇키워드 AC 채널추가 3 u1 string 1,000 버튼링크 → {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 4 u2 string 1,000 버튼링크 → {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	long	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	string	-	API 처리 실패에 대한 오류메시지