알림톡 전송
1. SendATS - 단건전송
섹션 제목: “1. SendATS - 단건전송”승인된 템플릿의 내용을 작성하여 1건의 알림톡 전송을 팝빌에 접수합니다.
- 전송실패시 사전에 지정한 변수 ‘Altsendtype’ 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
- 승인된 템플릿과 일치하지 않는 내용(알림톡 내용, 버튼 목록)을 입력하는 경우 ‘전송실패’ 처리됩니다.
- 팝빌 서비스의 안정적인 제공을 위하여 동시호출이 제한될 수 있습니다.
동시에 1,000건 이상 요청하는 경우 동보전송 또는 대량전송으로 이용하시는 것을 권장합니다.
function SendATS(CorpNum : String; TemplateCode : String; SenderNum : String; Altsendtype : String; ReserveDT: String; ReceiverNum : String; ReceiverName : String; ATSMsg : String; ATSAltSjt : String ; ATSAltMsg : String; Buttons : TSendKakaoButtonList; UserID : String = ''; requestNum : String = '') : String;Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | ||||||||||||||||||||||||||||||||||||
| 2 | TemplateCode | String | 12 | Y | 승인된 알림톡 템플릿 코드 | ||||||||||||||||||||||||||||||||||||
| 3 | SenderNum | String | 20 | 조건부 | 발신번호 대체문자 전송시 필수 팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환 | ||||||||||||||||||||||||||||||||||||
| 4 | Altsendtype | String | 1 | N | 대체문자 유형
기본값 : 미전송 | ||||||||||||||||||||||||||||||||||||
| 5 | ReserveDT | String | 14 | N | 전송 예약일시 형식 : yyyyMMddHHmmss
기본값 : 즉시전송 | ||||||||||||||||||||||||||||||||||||
| 6 | ReceiverNum | String | 20 | Y | 수신번호 | ||||||||||||||||||||||||||||||||||||
| 7 | ReceiverName | String | 70 | N | 수신자명 | ||||||||||||||||||||||||||||||||||||
| 8 | ATSMsg | String | 1,300 | Y | 알림톡 내용 (템플릿 내용의 변수 치환 필요) 템플릿 예시 : 주문하신 #{상품}이 금일 발송 처리되었습니다. 작성 예시 : 주문하신 노트북이 금일 발송 처리되었습니다. | ||||||||||||||||||||||||||||||||||||
| 9 | ATSAltSjt | String | 64 | N | 대체문자 제목 대체문자 내용이 90byte 초과한 경우에만 적용 단위 : byte | ||||||||||||||||||||||||||||||||||||
| 10 | ATSAltMsg | String | 2,000 | N | 대체문자 내용 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송 단위 : byte | ||||||||||||||||||||||||||||||||||||
| 11 | Buttons | 5 | N | 버튼 목록 버튼링크를 변경해야할 경우 사용 최대 : 5개
기본값 : 승인된 템플릿의 버튼 목록 | |||||||||||||||||||||||||||||||||||||
TSendKakaoButtonList
| |||||||||||||||||||||||||||||||||||||||||
| 12 | UserID | String | 50 | N | 팝빌회원 아이디 | ||||||||||||||||||||||||||||||||||||
| 13 | requestNum | String | 36 | N | 요청번호 파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능 | ||||||||||||||||||||||||||||||||||||
String - 요청에 대한 접수번호(receiptNum)
EPopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | LongInt | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | String | - | API 처리 실패에 대한 오류메시지 |
2. SendATS - 동보전송/대량전송
섹션 제목: “2. SendATS - 동보전송/대량전송”승인된 템플릿 내용을 작성하여 다수건의 알림톡 전송을 팝빌에 접수합니다.
- 모든 수신자에게 동일한 내용을 전송하거나(동보전송), 수신자마다 개별 내용을 전송할 수 있습니다(대량전송). (최대 1,000건)
- 전송실패시 사전에 지정한 변수 ‘Altsendtype’ 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
- 승인된 템플릿과 일치하지 않는 내용(알림톡 내용, 버튼 목록)을 입력하는 경우 ‘전송실패’ 처리됩니다.
function SendATS(CorpNum : String; TemplateCode : String; SenderNum : String; Content : String; AltSubject : String; AltContent : String; Altsendtype : String; ReserveDT : String; Receivers : TSendKakaoReceiverList; Buttons : TSendKakaoButtonList; UserID : String = ''; requestNum : String = '') : String;Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 2 | TemplateCode | String | 12 | Y | 승인된 알림톡 템플릿 코드 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 3 | SenderNum | String | 20 | 조건부 | 발신번호 대체문자 전송시 필수 팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 4 | Content | String | 1000 | 조건부 | 알림톡 내용 (템플릿 내용의 변수 치환 필요) 동보전송 경우 필수 템플릿 예시 : 주문하신 #{상품}이 금일 발송 처리되었습니다. 작성 예시 : 주문하신 노트북이 금일 발송 처리되었습니다. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 5 | AltSubject | String | 64 | N | 대체문자 제목 동보전송 경우 사용 메시지 길이가 90byte 초과한 경우에만 적용 단위 : byte | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 6 | AltContent | String | 2000 | N | 대체문자 내용 동보전송 경우 사용 메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송 단위 : byte | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 7 | Altsendtype | String | 1 | N | 대체문자 유형
기본값 : 미전송 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 8 | ReserveDT | String | 14 | N | 전송 예약일시 형식 : yyyyMMddHHmmss
기본값 : 즉시전송 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 9 | Receivers | 1,000 | Y | 전송정보 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TSendKakaoReceiverList
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 10 | Buttons | 5 | N | 버튼 목록 동보전송 경우 사용 버튼링크를 변경해야할 경우 사용
기본값 : 승인된 템플릿의 버튼 목록 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
TSendKakaoButtonList
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 11 | UserID | String | 50 | N | 팝빌회원 아이디 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 12 | requestNum | String | 36 | N | 요청번호 파트너가 접수 단위를 식별하기 위해 할당하는 관리번호 영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
String - 요청에 대한 접수번호(receiptNum)
EPopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | LongInt | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | String | - | API 처리 실패에 대한 오류메시지 |
3. CancelReserve - 예약전송 취소 (접수번호)
섹션 제목: “3. CancelReserve - 예약전송 취소 (접수번호)”팝빌에서 반환받은 접수번호로 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
function CancelReserve(CorpNum : String; receiptNum : String; UserID : String = '') : TResponse;Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | receiptNum | String | 18 | Y | 팝빌에서 할당한 접수번호 카카오톡 예약전송 요청의 반환값 |
| 3 | UserID | String | 50 | N | 팝빌회원 아이디 |
TResponse
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | LongInt | - | API 처리에 대한 응답코드
|
| 2 | message | String | - | API 처리에 대한 응답메시지 |
EPopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | LongInt | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | String | - | API 처리 실패에 대한 오류메시지 |
4. CancelReserveRN - 예약전송 취소 (요청번호)
섹션 제목: “4. CancelReserveRN - 예약전송 취소 (요청번호)”파트너가 할당한 요청번호로 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)
function CancelReserveRN(CorpNum : String; requestNum : String; UserID : String = '') : TResponse;Parameters
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | CorpNum | String | 10 | Y | 팝빌회원 사업자번호 ('-' 제외) |
| 2 | requestNum | String | 36 | Y | 파트너가 할당한 요청번호 |
| 3 | UserID | String | 50 | N | 팝빌회원 아이디 |
TResponse
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | LongInt | - | API 처리에 대한 응답코드
|
| 2 | message | String | - | API 처리에 대한 응답메시지 |
EPopbillException
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | LongInt | - | API 처리 실패에 대한 오류코드 음의 정수 8자리 숫자값 [참고] 오류코드 |
| 2 | message | String | - | API 처리 실패에 대한 오류메시지 |