알림톡
1. GetATSTemplateMgtURL - 템플릿 등록 팝업 URL
- 알림톡 템플릿 등록하는 팝업 URL을 반환합니다.
- 권장 사이즈 : width = 1,200px (최소 1,000px) / height = 800px
- 반환되는 URL은 30초 동안만 사용이 가능합니다.
- 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.
Function GetATSTemplateMgtURL(CorpNum, UserID)
요청
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
응답
String - 요청에 대한 응답 URL
예외
2. GetATSTemplate - 템플릿 정보 확인
- 알림톡 템플릿 정보를 확인합니다.
Function GetATSTemplate(CorpNum, templateCode, UserID)
요청
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| templateCode | String | 12 | Y | 템플릿 코드 | |
| UserID | String | 50 | N | 팝빌회원 아이디 |
응답
예외
3. ListATSTemplate - 템플릿 목록 확인
- 승인된 알림톡 템플릿 목록을 확인합니다.
Function ListATSTemplate(CorpNum)
요청
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
응답
예외
4. SendATS - 전송
- 승인된 템플릿의 내용을 작성하여 알림톡 전송을 팝빌에 접수합니다.(최대 1,000건)
- 모든 수신자에게 동일한 내용을 전송하거나(동보전송), 수신자마다 개별 내용을 전송할 수 있습니다(대량전송).
- 전송실패시 사전에 지정한 변수 'altSendType' 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
- 승인된 템플릿과 일치하지 않는 내용(알림톡 내용, 버튼 목록)을 입력하는 경우 '전송실패' 처리됩니다.
- 팝빌 서비스의 안정적인 제공을 위하여 동시호출이 제한될 수 있습니다.
동시에 1,000건 이상 요청하는 경우 동보전송 또는 대량전송으로 이용하시는 것을 권장합니다.
Function SendATS(CorpNum, templateCode, senderNum, content, altContent, altSendType, reserveDT, receiverList, requestNum, UserID, btnList, altSubject)
요청
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| templateCode | String | 12 | Y | 승인된 알림톡 템플릿 코드 | |
| senderNum | String | 20 | 조건부 |
발신번호
대체문자 전송시 필수
팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환 |
|
| content | String | 1000 | 조건부 |
알림톡 내용 (템플릿 내용의 변수 치환 필요)
단건전송, 동보전송 경우 필수
최대 : 1,000자 - 템플릿 예시 : 주문하신 #{상품}이 금일 발송 처리되었습니다. - 작성 예시 : 주문하신 노트북이 금일 발송 처리되었습니다. |
|
| altContent | String | 2000 | N |
대체문자 내용
단건전송, 동보전송 경우 사용
메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송 |
|
| altSendType | String | 1 | N |
대체문자 유형
C알림톡 내용 전송
A대체문자 내용 전송
기본값 : 미전송
|
|
| reserveDT | String | 14 | N |
전송 예약일시
형식 : yyyyMMddHHmmss
기본값 : 즉시전송
|
|
| receiverList | KakaoReceiver( ) | Y |
전송정보
최대 : 1,000개
|
||
| requestNum | String | 36 | N |
요청번호
파트너가 접수 단위를 식별하기 위해 할당하는 관리번호
영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능 |
|
| UserID | String | 50 | N | 팝빌회원 아이디 | |
| btnList | KakaoButton( ) | N |
버튼 목록
단건전송, 동보전송 경우 사용
버튼링크를 변경해야할 경우 사용 최대 : 5개 기본값 : 승인된 템플릿의 버튼 목록
|
||
| altSubject | String | 40 | N |
대체문자 제목
단건전송, 동보전송 경우 사용
메시지 길이가 90byte 이상인 경우에만 적용 |
|
응답
String - 요청에 대한 접수번호(receiptNum)
예외
5. CancelReserve - 예약전송 취소 (접수번호)
- 팝빌에서 반환받은 접수번호로 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
Function CancelReserve(CorpNum, ReceiptNum, UserID)
요청
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| ReceiptNum | String | 18 | Y |
팝빌에서 할당한 접수번호
카카오톡 예약전송 요청의 반환값
|
|
| UserID | String | 50 | N | 팝빌회원 아이디 |
응답
예외
6. CancelReserveRN - 예약전송 취소 (요청번호)
- 파트너가 할당한 요청번호로 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
Function CancelReserveRN(CorpNum, RequestNum, UserID)
요청
Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | |
| RequestNum | String | 36 | Y | 파트너가 할당한 요청번호 | |
| UserID | String | 50 | N | 팝빌회원 아이디 |












