알림톡 전송

1. SendATS - 알림톡 전송

POST https://popbill-test.linkhub.co.kr/ATS

승인된 템플릿 내용을 작성하여 다수건의 알림톡 전송을 팝빌에 접수하며, 수신자별 개별 내용 또는 동일 내용을 전송합니다. (최대 1,000건)
전송실패시 사전에 지정한 변수 ‘altSendType’ 값으로 대체문자를 전송할 수 있고, 이 경우 문자(SMS/LMS) 요금이 과금됩니다.
승인된 템플릿과 일치하지 않는 내용(알림톡 내용, 버튼 목록)을 입력하는 경우 ‘전송실패’ 처리됩니다.
수신자 전체에 동일한 내용을 전송하는 동보 전송, 수신자별로 개별 내용을 전송하는 대량 전송을 지원합니다.

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Content-Type`	Y	요청 본문 형식 `application/json`
3	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
4	`Accept-Encoding`	N	응답 압축 방식 `gzip`
5	`X-PB-UserID`	N	팝빌회원 아이디

요청 본문

순번 변수명 타입 길이 필수 설명

templateCode

string

승인된 알림톡 템플릿 코드

emphasizeTitle

string

강조표기 타이틀

템플릿 예시 : 주문하신 #{상품}이 도착했습니다.

작성 예시 : 주문하신 노트북이 도착했습니다.

동보 전송인 경우 입력

content

string

1,300

조건부

알림톡 내용

최대 : 1,300자

템플릿 예시 : 주문하신 #{상품}이 도착했습니다.

작성 예시 : 주문하신 노트북이 도착했습니다.

동보 전송인 경우 필수

snd

string

조건부

발신번호

대체문자 전송인 경우 필수

팝빌에 등록되지 않은 발신번호를 입력하는 경우 오류 반환

altSubject

string

대체문자 제목

대체문자 내용이 90byte 초과한 경우에만 적용

단위 : byte

동보 전송인 경우 입력

altContent

string

2,000

대체문자 내용

메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송

단위 : byte

동보 전송인 경우 입력

altSendType

string

대체문자 유형

C 알림톡 내용 전송
A 대체문자 내용 전송

기본값 : 미전송

sndDT

string

전송 예약일시

형식 : yyyyMMddHHmmss

기본값 : 즉시전송

requestNum

string

요청번호

파트너가 접수 단위를 식별하기 위해 할당하는 관리번호

영문 대소문자, 숫자, 특수문자('-','_')만 이용 가능

array

버튼 목록

버튼링크를 변경해야할 경우 사용

최대 : 5개

기본값 : 승인된 템플릿의 버튼 목록

동보 전송인 경우 입력

btns

순번	변수명	타입	길이	필수	설명
1	`n`	string	14	Y	버튼명
2	`t`	string	2	Y	버튼유형 `WL` 웹링크 `AL` 앱링크 `TN` 전화걸기 `DS` 배송조회 `MD` 메시지전달 `BK` 봇키워드 `AC` 채널추가
3	`u1`	string	1,000	조건부	버튼링크 {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 {t} = "WL" or "AL" 경우 필수
4	`u2`	string	1,000	조건부	버튼링크 {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 {t} = "WL" or "AL" 경우 필수
5	`tg`	string	3	N	아웃 링크 `out` 디바이스 기본 브라우저 기본값 : 카카오톡 인앱 브라우저 사용
6	`telNum`	string	14	조건부	전화걸기 번호 숫자, 하이픈(-)만 입력 가능 {t} = "TN" 경우 필수

array

수신자 정보

msgs

순번 변수명 타입 길이 필수 설명

rcv

string

수신번호

rcvnm

string

수신자명

emphasizeTitle

string

강조표기 타이틀

템플릿 예시 : 주문하신 #{상품}이 도착했습니다.

작성 예시 : 주문하신 노트북이 도착했습니다.

대량 전송인 경우 입력

msg

string

1,300

조건부

알림톡 내용

최대 : 1,300자

템플릿 예시 : 주문하신 #{상품}이 도착했습니다.

작성 예시 : 주문하신 노트북이 도착했습니다.

대량 전송인 경우 필수

altsjt

string

대체문자 제목

대체문자 내용이 90byte 초과한 경우에만 적용

단위 : byte

대량 전송인 경우 입력

altmsg

string

2,000

대체문자 내용

메시지 길이에 따라 단문(90byte 이하) 또는 장문(90byte 초과)으로 전송

대량 전송인 경우 입력

interOPRefKey

string

파트너 지정키

카카오톡 대량/동보전송시 파트너가 개별건마다 입력할 수 있는 값

array

버튼 목록

버튼링크를 변경해야할 경우 사용

최대 : 5개

기본값 : 승인된 템플릿의 버튼 목록

대량 전송인 경우 입력

btns

순번	변수명	타입	길이	필수	설명
1	`n`	string	14	Y	버튼명
2	`t`	string	2	Y	버튼유형 `WL` 웹링크 `AL` 앱링크 `TN` 전화걸기 `DS` 배송조회 `MD` 메시지전달 `BK` 봇키워드 `AC` 채널추가
3	`u1`	string	1,000	조건부	버튼링크 {t} = "AL" 경우 iOS 앱링크 적용 {t} = "WL" 경우 Mobile 웹링크 적용 {t} = "WL" or "AL" 경우 필수
4	`u2`	string	1,000	조건부	버튼링크 {t} = "AL" 경우 Android 앱링크 적용 {t} = "WL" 경우 PC 웹링크 적용 {t} = "WL" or "AL" 경우 필수
5	`tg`	string	3	N	아웃 링크 `out` 디바이스 기본 브라우저 기본값 : 카카오톡 인앱 브라우저 사용
6	`telNum`	string	14	조건부	전화걸기 번호 숫자, 하이픈(-)만 입력 가능 {t} = "TN" 경우 필수

요청 예시 (단건)

curl --request POST \
  --url 'https://{domain}/ATS' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "templateCode": "025080000032",
    "content": "알림톡 내용",
    "msgs": [
        {
            "rcv": "01012345678",
            "rcvnm": "수신자명"
        }
    ],
    "btns": [
        {
            "n": "버튼명",
            "t": "WL",
            "u1": "https://www.popbill.com",
            "u2": "https://www.popbill.com"
        }
    ]
  }'

요청 예시 (대량)

curl --request POST \
  --url 'https://{domain}/ATS' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "templateCode": "025050001056",
    "msgs": [
        {
            "rcv": "01012345678",
            "msg": "알림톡 내용",
            "rcvnm": "수신자명",
            "btns": [
                {
                    "n": "버튼명",
                    "t": "WL",
                    "u1": "https://www.popbill.com",
                    "u2": "https://www.popbill.com"
                }
            ]
        }
    ]
}'

요청 예시 (동보)

curl --request POST \
  --url 'https://{domain}/ATS' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "templateCode": "025080000032",
    "content": "알림톡 내용",
    "msgs": [
        {
            "rcv": "01012345678",
            "rcvnm": "수신자명"
        }
    ],
    "btns": [
        {
            "n": "버튼명",
            "t": "WL",
            "u1": "https://www.popbill.com",
            "u2": "https://www.popbill.com"
        }
    ]
  }'

Response

응답 본문

순번	변수명	타입	길이	설명
1	`receiptNum`	string	18	접수번호

응답 예시

{
    "receiptNum": "025102015544100001"
}

2. CancelReserve - 예약전송 취소 (접수번호)

GET https://popbill-test.linkhub.co.kr/KakaoTalk/{receiptNum}/Cancel

팝빌에서 반환받은 접수번호로 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
3	`Accept-Encoding`	N	응답 압축 방식 `gzip`
4	`X-PB-UserID`	N	팝빌회원 아이디

Query 파라미터

순번	변수명	타입	길이	필수	설명
1	`receiptNum`	string	18	Y	팝빌에서 할당한 접수번호 카카오톡 예약전송 요청의 반환값

요청 예시

curl --request GET \
  --url 'https://{domain}/KakaoTalk/{receiptNum}/Cancel' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번	변수명	타입	길이	설명
1	`code`	number	-	API 처리에 대한 응답코드 `1` 성공
2	`message`	string	-	API 처리에 대한 응답메시지

응답 예시

{
    "code": 1,
    "message": "취소 완료"
}

3. CancelReservebyRCV - 예약전송 부분 취소 (접수번호)

POST https://popbill-test.linkhub.co.kr/KakaoTalk/{receiptNum}/Cancel

팝빌에서 반환받은 접수번호로 접수 건을 식별하여 수신번호에 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Content-Type`	Y	요청 본문 형식 `application/json`
3	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
4	`Accept-Encoding`	N	응답 압축 방식 `gzip`
5	`X-PB-UserID`	N	팝빌회원 아이디

Query 파라미터

순번	변수명	타입	길이	필수	설명
1	`receiptNum`	string	18	Y	팝빌에서 할당한 접수번호 카카오톡 예약전송 요청의 반환값

요청 본문

순번	변수명	타입	길이	필수	설명
1	`receiveNum`	string	20	Y	예약전송 수신번호

요청 예시

curl --request POST \
  --url 'https://{domain}/KakaoTalk/{receiptNum}/Cancel' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "receiveNum": "01012345678"
  }'

Response

응답 본문

순번	변수명	타입	길이	설명
1	`code`	number	-	API 처리에 대한 응답코드 `1` 성공
2	`message`	string	-	API 처리에 대한 응답메시지

응답 예시

{
    "code": 1,
    "message": "취소 완료"
}

4. CancelReserveRN - 예약전송 전체 취소 (요청번호)

GET https://popbill-test.linkhub.co.kr/KakaoTalk/Cancel/{requestNum}

파트너가 할당한 요청번호로 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
3	`Accept-Encoding`	N	응답 압축 방식 `gzip`
4	`X-PB-UserID`	N	팝빌회원 아이디

Query 파라미터

순번	변수명	타입	길이	필수	설명
1	`requestNum`	string	36	Y	파트너가 할당한 요청번호

요청 예시

curl --request GET \
  --url 'https://{domain}/KakaoTalk/Cancel/{requestNum}' \
  --header 'Authorization: Bearer {token}'

Response

응답 본문

순번	변수명	타입	길이	설명
1	`code`	number	-	API 처리에 대한 응답코드 `1` 성공
2	`message`	string	-	API 처리에 대한 응답메시지

응답 예시

{
    "code": 1,
    "message": "취소 완료"
}

5. CancelReserveRNbyRCV - 예약전송 부분 취소 (요청번호)

POST https://popbill-test.linkhub.co.kr/KakaoTalk/Cancel/{requestNum}

파트너가 할당한 요청번호로 접수 건을 식별하여 수신번호에 예약된 카카오톡을 전송 취소합니다. (예약시간 10분 전까지 가능)

Request

요청 헤더

순번	변수명	필수	설명
1	`Authorization`	Y	인증 토큰 [참고] 인증 및 헤더 설정
2	`Content-Type`	Y	요청 본문 형식 `application/json`
3	`Accept-Language`	N	응답 언어 설정 `ko-KR` 기본값 `en-US`
4	`Accept-Encoding`	N	응답 압축 방식 `gzip`
5	`X-PB-UserID`	N	팝빌회원 아이디

Query 파라미터

순번	변수명	타입	길이	필수	설명
1	`requestNum`	string	36	Y	파트너가 할당한 요청번호

요청 본문

순번	변수명	타입	길이	필수	설명
1	`receiveNum`	string	20	Y	예약전송 수신번호

요청 예시

curl --request POST \
  --url 'https://{domain}/KakaoTalk/Cancel/{requestNum}' \
  --header 'Authorization: Bearer {token}' \
  --header 'Content-Type: application/json' \
  --data '{
    "receiveNum": "01012345678"
  }'

Response

응답 본문

순번	변수명	타입	길이	설명
1	`code`	number	-	API 처리에 대한 응답코드 `1` 성공
2	`message`	string	-	API 처리에 대한 응답메시지

응답 예시

{
    "code": 1,
    "message": "취소 완료"
}