# 알림톡 템플릿

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

![알림톡 템플릿 등록 팝업 URL 미리보기](https://developers.popbill.com/images/reference/kakaotalk/getATSTemplateMgtURL.png)

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

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

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

### 요청

**Parameters**

- corpnum `type: string` `length: 10` `required: Y` `description: 팝빌회원 사업자번호 ('-' 제외)`
- userid `type: string` `length: 50` `required: N` `description: 팝빌회원 아이디`

### 응답

string - 요청에 대한 응답 URL

### 예외

**PopbillException**

- code `type: long` `length: -` `description: API 처리 실패에 대한 오류코드`
  - 음의 정수 8자리 숫자값 [\[참고\] 오류코드](https://developers.popbill.com/error-code)
- message `type: string` `length: -` `description: API 처리 실패에 대한 오류메시지`

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

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

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

### 요청

**Parameters**

- corpnum `type: string` `length: 10` `required: Y` `description: 팝빌회원 사업자번호 ('-' 제외)`
- templatecode `type: string` `length: 12` `required: Y` `description: 템플릿 코드`
- userid `type: string` `length: 50` `required: N` `description: 팝빌회원 아이디`

### 응답

**ATSTemplate**

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

### 예외

**PopbillException**

- code `type: long` `length: -` `description: API 처리 실패에 대한 오류코드`
  - 음의 정수 8자리 숫자값 [\[참고\] 오류코드](https://developers.popbill.com/error-code)
- message `type: string` `length: -` `description: API 처리 실패에 대한 오류메시지`

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

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

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

### 요청

**Parameters**

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

### 응답

**ATSTemplate**

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

### 예외

**PopbillException**

- code `type: long` `length: -` `description: API 처리 실패에 대한 오류코드`
  - 음의 정수 8자리 숫자값 [\[참고\] 오류코드](https://developers.popbill.com/error-code)
- message `type: string` `length: -` `description: API 처리 실패에 대한 오류메시지`