카카오 API 연동 안내
- PI는 Full rest api 방식으로 제공되므로 별도 모듈 설치를 필요로 하지 않습니다.
- API 사용을 위해 [API 토큰 관리] 페이지에서 token 발급을 해야 합니다.
- API 토큰 관리에 등록된 토큰과 서버 ip에서만 발송 가능합니다.
- 카카오 발송을 위해 사전에 '카카오 비즈니스센터'에서 채널 설정 및 템플릿 검수가 완료 되어야 합니다.
발송 및 내역
- API Request 공통사항
- 알림톡 발송하기
- 친구톡 발송하기
- 잔여 포인트 조회
- 알림톡 발송 내역 리스트
- 알림톡 예약 발송 내역 리스트
- 친구톡 발송 내역 리스트
- 친구톡 예약 발송 내역 리스트
- 템플릿 신규 등록
- 템플릿 코드 유효성 검증
- 템플릿 목록 조회
- 템플릿 상세 조회
- 템플릿 수정
- 템플릿 삭제
- 템플릿 카테고리 전체 조회
- 템플릿 카테고리 조회
- 템플릿 검수 요청
- 템플릿 검수 요청 (파일 첨부)
- 템플릿 검수 요청 취소
- 템플릿 사용 중지
- 템플릿 사용 중지 해제
- 템플릿 승인 취소
- 템플릿 휴면 해제
- 친구톡 기본/와이드 이미지 등록
- 친구톡 와이드 아이템 리스트 이미지 업로드
- 친구톡 캐러셀 피드 이미지 업로드
- 친구톡 이미지 조회
- 친구톡 이미지 삭제
- 알림톡 템플릿 등록용 이미지 업로드
- 알림톡 이미지 업로드
- 알림톡 하이라이트 이미지 업로드
API Request 공통사항
Request URL
https://apis.ssodaa.com{API POST URL}
아래 제공되는 api 호출시 사용되는 URL 입니다. api별 POST URL을 조합하여 request 합니다.
필수 요청 Header
https://apis.ssodaa.com{API POST URL} 아래 제공되는 api 호출시 사용되는 URL 입니다. api별 POST URL을 조합하여 request 합니다.
| 키 | 값 | 설명 |
|---|---|---|
| x-api-key | 쏘다에서 발급받은 api키 | [API 토큰 관리] 에서 tokey_key 와 api_key 를 발급받을 수 있습니다. |
| Content-Type | 아래 안내된 Content-Type | Content-Type과 Charset을 반드시 확인해주세요. |
알림톡 발송하기
사전에 등록된 템플릿으로 발송 가능합니다.템플릿에서 설정된 항목과 동일한 내용으로 요청해야 정상 처리됩니다.
편의를 위해 '알림톡 템플릿 관리 - 템플릿 상세' 화면에서 발송용 json코드를 복사할 수 있는 기능을 제공합니다.
Failover 설정된 경우 발송 실패건에 대해 LMS로 자동 발송됩니다. (최대 2,000자까지 대체 발송 / 첨부된 이미지는 발송 안됨 / LMS는 단가표에 따름)
| POST URL | /kakao/send/alimtalk |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
알림톡 템플릿 변수는 최대 40자까지 허용합니다.| 키 | 타입 | 필수 | 설명 | ||
|---|---|---|---|---|---|
| token_key | String | O | 회원 토큰 | ||
| dest_phone | String | O | 수신번호 (파이프로 구분하여 다량 발송 가능) | ||
| sender_key | String | O | '카카오톡 채널 관리'에서 등록시 발급 받은 프로필key | ||
| template_code | String | O | '알림톡 템플릿 관리'에서 등록하여 검수된 템플릿 코드 | ||
| msg_body | String | O | 템플릿 내용 | ||
| button | Array | X |
버튼 목록 아래 [button, quick_reply 배열 속성 값] 테이블 참조 |
||
| item_highlight | Json | X | 아이템 하이라이트 | ||
| title | String(30) | O | 타이틀 (이미지가 있는 경우 최대 21자) | ||
| description | String(19) | O | 부가정보 | ||
| item | Json | X | 아이템리스트 및 요약정보 | ||
| list | Array | O | 아이템리스트 | ||
| title | String(6) | O | 타이틀 | ||
| description | String(23) | O | 부가정보 | ||
| summary | Json | X | 아이템 요약정보 | ||
| title | String(6) | O | 타이틀 | ||
| description | String(14) | O | 부가정보 | ||
| extra | Json | X | 추가 기능 | ||
| msg_type | String | X |
카카오 발송 유형 '강조 유형'이 '이미지'인 경우에만 'ai'로 설정 |
||
| title | String(50) | X | 템플릿 내용중 강조 표기할 핵심 정보 | ||
| supplement | Json | X | 메시지에 첨부할 채널옵션 | ||
| quick_reply | Array | N |
바로연결 목록 아래 [button, quick_reply 배열 속성 값] 테이블 참조 |
||
| header | String(16) | X | 메시지 상단에 표기할 제목 | ||
| price | Integer | X | 모먼트 광고 전환 최적화 전용 메시지 내 포함된 가격/금액/결제금액 |
||
| currency_type | String(3) | X | 모먼트 광고 전환 최적화 전용 메시지 내 포함된 가격/금액/결제금액의 통화 단위 입력 (KRW, USD, EUR 등 국제 통화 코드 사용) |
||
| send_time | String | X | 예약 발송시 발송 원하는 시간 입력 (ex: 2023-04-09 16:30:00) | ||
| failover | Json | X |
Failover 설정 '카카오톡채널 관리'에서 failover 발송 번호 설정시에만 활성화 가능 |
||
| use | String | X | 활성화 여부 (Y/N 으로 입력. Failover 설정되어 있는 경우 기본 값: Y) | ||
| msg_body | String | X | 대체 메시지 내용. 입력하지 않는 경우 알림톡의 msg_body로 대체 | ||
button, quick_reply 배열 속성 값
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| name | String(14) | O | 버튼 제목 'AC' 버튼 타입인 경우 '채널 추가'로 고정 |
| type | String(2) | O |
[button, quick_reply 공통 타입] - AC - 웹링크(WL) : url_mobile(모바일 링크), url_pc(PC 링크) 속성 값 필요 - 앱링크(AL) : scheme_ios(Ios 링크), scheme_android(Android 링크) 속성 값 필요 - 배송조회(DS) - 봇키워드(BK) - 채널추가(AC) : '메시지 유형 > 채널추가형 or 복합형'인 경우 '채널추가'로 고정 노출 - 상담톡전환(BC) : chat_extra(전달할 메타정보) 속성 값 필요 - 봇전환(BT) : chat_extra(전달할 메타정보), chat_event(전달할 이벤트명) 있는 경우 속성 값 추가 가능 - 비즈니스폼(BF) : 비즈폼 사용하는 경우 비즈폼명으로 버튼명 고정 [button 타입] - 메시지전달(MD) - 이미지 보안전송 플러그인(P1) : plugin_id(플러그인ID) 속성 값 필요 - 개인정보이용 플러그인(P2) : plugin_id(플러그인ID) 속성 값 필요 |
| url_mobile | String | X | Mobile 환경에서 버튼 클릭시 이동할 URL |
| url_pc | String | X | PC 환경에서 버튼 클릭시 이동할 URL |
| scheme_ios | String | X | Mobile Ios 환경에서 버튼 클릭시 실행할 Application Custom Scheme |
| scheme_android | String | X | Mobile Android 환경에서 버튼 클릭시 실행할 Application Custom Scheme |
| chat_extra | String(50) | X | 상담톡/봇 전환시 전달할 메타정보 |
| chat_event | String(50) | X | 봇 전환시 연결할 봇 이벤트명 |
| plugin_id | String | X | P1, P2 플러그인 사용시 플러그인ID |
| biz_form_id | String | X | 비즈니스폼 사용시 비즈니스폼ID |
Response
| 키 | 타입 | 설명 | ||
|---|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | ||
| error | String | 실패시 오류 메시지 | ||
| content | message | String | API Request 성공 메시지 | |
| sent_messages | Array | 수신 메시지 정보 | ||
| msg_id | String | 발송된 메시지 고유 코드 | ||
| dest_phone | String | 메시지 수신 번호 | ||
| reserv | String | 예약여부 (Y/N) | ||
| sent_time | String | 예약시간 | ||
| send_phone | String | 발신번호 (등록된 발신번호만 사용 가능) | ||
친구톡 발송하기
채널을 추가한 친구에게만 발송 가능합니다.친구톡 발송 타입은 FT(텍스트), FL(이미지), FW(와이드 이미지) 타입을 지원합니다.
이미지 첨부는 '친구톡이미지 관리'에서 업로드 후 URL을 복사하여 첨부 가능합니다.
Failover 설정된 경우 발송 실패건에 대해 LMS로 자동 발송됩니다. (최대 2,000자까지 대체 발송 / 첨부된 이미지는 발송 안됨 / LMS는 단가표에 따름)
| POST URL | /kakao/send/friendtalk |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 | |
|---|---|---|---|---|
| token_key | String | O | 회원 토큰 | |
| dest_phone | String | O | 수신번호 (파이프로 구분하여 다량 발송 가능) | |
| sender_key | String | O | '카카오톡 채널 관리'에서 등록시 발급 받은 프로필key | |
| msg_body | String | O |
메시지 본문 내용 - FT: 텍스트형 (텍스트 최대 1,000자) - FI: 이미지형 (텍스트 최대 400) - FW: 와이드이미지형 (텍스트 최대 76자) |
|
| button | Array | X |
버튼 목록 - FT: 텍스트형 (버튼 최대 5개) - FI: 이미지형 (버튼 최대 5개) - FW: 와이드이미지형 (버튼 최대 1개) - FL: 와이드아이템리스트 (버튼 최대 2개, 가로정렬) - FC: 캐러셀피드 (버튼 최대 2개, 가로정렬) - 아래 [button 배열 속성 값] 테이블 참조 |
|
| image | Json | X | 친구톡 이미지 ('친구톡이미지 관리'에서 업로드하여 URL 획득 가능) | |
| img_url | String | O | 노출할 이미지 (와이드 이미지 발송시 필수 입력) | |
| img_link | String | O | 이미지 클릭시 이동할 URL | |
| item | Json | X |
아이템리스트와 아이템 요약정보. 와이드아이템리스트(FL) 사용시 필수 - 아래 [item 배열 속성 값] 테이블 참조 |
|
| coupon | Json | X | 쿠폰형 메시지 발송 (FT, FI, FW인 경우 사용 가능) | |
| title | String | O |
쿠폰 제목의 경우 아래 5가지 형식으로 제한함 - "${숫자}원 할인 쿠폰" 숫자는 1이상 99,999,999 이하 - "${숫자}% 할인 쿠폰" 숫자는 1이상 100 이하 - "배송비 할인 쿠폰" - "${7자 이내} 무료 쿠폰" - "${7자 이내} UP 쿠폰" |
|
| description | String | O | 쿠폰 상세 설명 (FT, FI - 12자 / FW - 18자 제한) | |
| url_mobile | String | O |
mobile 환경에서 이미지 클릭 시 이동할 url - url_pc, url_mobile, scheme_android, scheme_ios의 경우 필수값이 두가지 케이스로 구분 - 기본 - url_mobile 필수값 나머지 옵션값 - 채널 쿠폰 URL(포멧: alimtalk=coupon://) 사용 - scheme_android 혹은 scheme_ios 둘 중 하나 필수값 나머지 옵션값 |
|
| url_pc | String | X | pc 환경에서 이미지 클릭 시 이동할 url | |
| scheme_android | String | X | mobile android 환경에서 쿠폰 클릭 시 실행할 application custom scheme | |
| scheme_ios | String | X | mobile ios 환경에서 쿠폰 클릭 시 실행할 application custom scheme | |
| extra | Json | X | 추가 기능 | |
| header | String(25) | X | 와이드아이템리스트(FL) 사용시 필수 | |
| carousel | Json | X |
캐러셀피드(FC) 사용시 필수 캐러셀 2~6개 구성 필수 - 아래 [Carousel 배열 속성 값] 테이블 참조 |
|
| msg_type | String | O |
카카오 친구톡 발송 유형 - FT: 텍스트형 (텍스트 최대 1,000자 + 버튼 최대 5개) - FI: 이미지형 (텍스트 최대 400자 + 이미지 1장(500KB) + 버튼 최대 5개) - FW: 와이드이미지형 (텍스트 최대 76자 + 이미지 1장(2MB) + 버튼 최대 1개) - FL: 와이드아이템리스트 (리스트 3~4개 + 리스트당 텍스트 최대 25자 + 이미지 1장(2MB) + 버튼 최대 2개(가로 정렬)) - FC: 캐러셀피드 (캐러셀 2~6개 + 캐러셀당 제목 최대 20자, 본문 최대 80자 + 이미지 1장(2MB) + 버튼 최대 2개(가로정렬)) |
|
| send_time | String | X | 예약 발송시 발송 원하는 시간 입력 (ex: 2023-04-09 16:30:00) | |
| failover | Json | X |
Failover 설정 '카카오톡채널 관리'에서 failover 발송 번호 설정시에만 활성화 가능 광고성 메시지를 '광고표기의무'를 준수하지 않고 발송한 경우 발송이 제한될 수 있으니 유의 바랍니다. |
|
| use | String | X | 활성화 여부 (Y/N 으로 입력. Failover 설정되어 있는 경우 기본 값: N) | |
| msg_body | String | X | 대체 메시지 내용. 입력하지 않는 경우 알림톡의 msg_body로 대체 | |
button 배열 속성 값
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| name | String(14) | O | 버튼 제목 'AC' 버튼 타입인 경우 '채널 추가'로 고정 |
| type | String(2) | O |
버튼 타입 - AC - 웹링크(WL) : url_mobile(모바일 링크), url_pc(PC 링크) 속성 값 필요 - 앱링크(AL) : scheme_ios(Ios 링크), scheme_android(Android 링크) 속성 값 필요 - 배송조회(DS) - 봇키워드(BK) - 채널추가(AC) : '메시지 유형 > 채널추가형 or 복합형'인 경우 '채널추가'로 고정 노출 - 상담톡전환(BC) : chat_extra(전달할 메타정보) 속성 값 필요 - 봇전환(BT) : chat_extra(전달할 메타정보), chat_event(전달할 이벤트명) 있는 경우 속성 값 추가 가능 - 비즈니스폼(BF) : 비즈폼 사용하는 경우 비즈폼명으로 버튼명 고정 |
| url_mobile | String | X | Mobile 환경에서 버튼 클릭시 이동할 URL |
| url_pc | String | X | PC 환경에서 버튼 클릭시 이동할 URL |
| scheme_ios | String | X | Mobile Ios 환경에서 버튼 클릭시 실행할 Application Custom Scheme |
| scheme_android | String | X | Mobile Android 환경에서 버튼 클릭시 실행할 Application Custom Scheme |
| biz_form_id | String | X | 비즈니스폼 사용시 비즈니스폼ID |
item 배열 속성 값
| 키 | 타입 | 필수 | 설명 | |
|---|---|---|---|---|
| list | Array | O | 리스트 3~4개 구성 필수 |
|
| title | String | O | 타이틀. 텍스트 최대 25자 | |
| img_url | String | O | 아이템 이미지 URL 친구톡 이미지 ('친구톡이미지 관리'에서 업로드하여 URL 획득 가능) |
|
| scheme_android | String | X | Mobile Android 환경에서 이미지 클릭시 실행할 application custom scheme | |
| scheme_ios | String | X | Mobile Ios 환경에서 이미지 클릭시 실행할 application custom scheme | |
| url_mobile | String | O | Mobile 환경에서 이미지 클릭시 이동할 url | |
| url_pc | String | X | PC 환경에서 이미지 클릭시 이동할 url | |
Carousel 배열 속성 값
| 키 | 타입 | 필수 | 설명 | |||
|---|---|---|---|---|---|---|
| list | Array | O | Carousel Item List | |||
| header | String | O | 캐러셀 아이템 제목. 텍스트 최대 20자 | |||
| message | String | O | 캐러셀 아이템 메시지. 텍스트 최대 80자 | |||
| attachment | Json | X | 캐러셀 아이템 이미지, 버튼 정보 | |||
| button | Array | O | 버튼 목록(버튼 없을시 empty array) | |||
| name | String(28) | - | 버튼 제목 | |||
| type | String(2) | - | 버튼 타입 - 버튼 타입은 위 [button 배열 속성 값 - type] 참조 |
|||
| scheme_android | String | - | Mobile Android 환경에서 버튼 클릭시 실행할 Application Custom Scheme | |||
| scheme_ios | String | - | Mobile Ios 환경에서 버튼 클릭시 실행할 Application Custom Scheme | |||
| url_mobile | String | - | Mobile 환경에서 버튼 클릭시 이동할 URL | |||
| url_pc | String | - | PC 환경에서 버튼 클릭시 이동할 URL | |||
| image | Json | O | 캐러셀 썸네일 이미지 | |||
| img_url | String | O | 캐러셀 썸네일 이미지 주소 친구톡 이미지 ('친구톡이미지 관리'에서 업로드하여 URL 획득 가능) |
|||
| img_pc | String | X | 캐러셀 썸네일 링크 주소 | |||
| tail | Json | X | 더보기 버튼 정보 | |||
| scheme_android | String | X | Mobile Android 환경에서 버튼 클릭시 실행할 Application Custom Scheme | |||
| scheme_ios | String | X | Mobile Ios 환경에서 버튼 클릭시 실행할 Application Custom Scheme | |||
| url_mobile | String | O | Mobile 환경에서 버튼 클릭시 이동할 URL | |||
| url_pc | String | X | PC 환경에서 버튼 클릭시 이동할 URL | |||
Response
| 키 | 타입 | 설명 | ||
|---|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | ||
| error | String | 실패시 오류 메시지 | ||
| content | message | String | API Request 성공 메시지 | |
| sent_messages | Array | 수신 메시지 정보 | ||
| msg_id | String | 발송된 메시지 고유 코드 | ||
| dest_phone | String | 메시지 수신 번호 | ||
| reserv | String | 예약여부 (Y/N) | ||
| sent_time | String | 예약시간 | ||
| send_phone | String | 발신번호 (등록된 발신번호만 사용 가능) | ||
잔여 포인트 조회
| POST URL | /kakao/remaining/amount |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
| point | Integer | 현재 보유 포인트 | |
| at_amount | Integer | 알림톡 발송 가능 건수 | |
| ft_text_amount | Integer | 친구톡 텍스트형 발송 가능 건수 | |
| ft_image_amount | Integer | 친구톡 이미지형 발송 가능 건수 | |
| ft_wide_amount | Integer | 친구톡 와이드 이미지형 발송 가능 건수 | |
| ft_itemlist_amount | Integer | 친구톡 와이드아이템리스트형 발송 가능 건수 | |
| ft_carousel_amount | Integer | 친구톡 캐러셀형 발송 가능 건수 | |
알림톡 발송 내역 리스트
| POST URL | /kakao/alimtalk/sent/list |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| page | String | X | 노출 페이지 번호 (기본값: 1) |
| status | Integer | X | 상태값 (0: 대기 / 1: 성공 / 2: 실패) |
| where | String | X | 검색 조건 설정 (dest_phone: 수신번호 / send_phone: 발송번호 / msg_body: 내용) |
| keyword | String | X | 검색 키워드 |
| start_date | String | X | 조회 시작일 (yyyy-mm-dd) |
| end_date | String | X | 조회 종료일 (yyyy-mm-dd) |
| limit | Integer | X | 페이지당 노출 개수 (기본값: 15) |
Response
| 키 | 타입 | 설명 | ||
|---|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | ||
| error | String | 실패시 오류 메시지 | ||
| content | message | String | API Request 성공 메시지 | |
| totalResult | Integer | 확인된 전체 발송 수 | ||
| paging | Object | 페이징 정보 | ||
| thisPageTotalResult | Integer | 현재 페이지의 전체 데이터 개수 | ||
| displayPageAnchor | String | 하단 페이징에 노출될 페이지 번호 (','로 구분된 String) | ||
| nowPage | Integer | 현재 페이지 번호 | ||
| totalPage | Integer | 전체 페이지 번호 | ||
| firstPage | Integer | 첫번째 페이지 번호 | ||
| prevPage | Integer | 이전 페이지 번호 | ||
| nextPage | Integer | 다음 페이지 번호 | ||
| lastPage | Integer | 마지막 페이지 번호 | ||
| result | Array | 발송 목록 | ||
| number | String | 노출될 데이터의 고유 번호 | ||
| msg_id | String | 메시지의 고유 코드 | ||
| datetime | String | 발송 요청일 | ||
| msg_type | String | 메시지 타입 (알림톡 / 친구톡) | ||
| status | String | 상태 (대기중 / 성공 / 실패) | ||
| error_msg | String | 발송 실패한 경우 오류 메시지 | ||
| failover_msg | String | failover 상태 메시지 | ||
| dest_phone | String | 수신 번호 | ||
| send_phone | String | 발신 번호 | ||
| msg_body | String | 메시지 본문 | ||
알림톡 예약 발송 내역 리스트
| POST URL | /kakao/alimtalk/sent/reserved/list |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| page | String | X | 노출 페이지 번호 (기본값: 1) |
| status | Integer | X | 상태값 (0: 대기 / 1: 성공 / 2: 실패) |
| where | String | X | 검색 조건 설정 (dest_phone: 수신번호 / send_phone: 발송번호 / msg_body: 내용) |
| keyword | String | X | 검색 키워드 |
| start_date | String | X | 조회 시작일 (yyyy-mm-dd) |
| end_date | String | X | 조회 종료일 (yyyy-mm-dd) |
| limit | Integer | X | 페이지당 노출 개수 (기본값: 15) |
Response
| 키 | 타입 | 설명 | ||
|---|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | ||
| error | String | 실패시 오류 메시지 | ||
| message | message | String | API Request 성공 메시지 | |
| totalResult | Integer | 확인된 전체 발송 수 | ||
| paging | Object | 페이징 정보 | ||
| thisPageTotalResult | Integer | 현재 페이지의 전체 데이터 개수 | ||
| displayPageAnchor | String | 하단 페이징에 노출될 페이지 번호 (','로 구분된 String) | ||
| nowPage | Integer | 현재 페이지 번호 | ||
| totalPage | Integer | 전체 페이지 번호 | ||
| firstPage | Integer | 첫번째 페이지 번호 | ||
| prevPage | Integer | 이전 페이지 번호 | ||
| nextPage | Integer | 다음 페이지 번호 | ||
| lastPage | Integer | 마지막 페이지 번호 | ||
| result | Array | 발송 목록 | ||
| number | String | 노출될 데이터의 고유 번호 | ||
| msg_id | String | 메시지의 고유 코드 | ||
| datetime | String | 발송 요청일 | ||
| msg_type | String | 메시지 타입 (알림톡 / 친구톡) | ||
| status | String | 상태 (대기중 / 성공 / 실패) | ||
| error_msg | String | 발송 실패한 경우 오류 메시지 | ||
| failover_msg | String | failover 상태 메시지 | ||
| dest_phone | String | 수신 번호 | ||
| send_phone | String | 발신 번호 | ||
| sendtime | String | 발송 예약 시간 | ||
| msg_body | String | 메시지 본문 | ||
친구톡 발송 내역 리스트
| POST URL | /kakao/friendtalk/sent/list |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| page | String | X | 노출 페이지 번호 (기본값: 1) |
| status | Integer | X | 상태값 (0: 대기 / 1: 성공 / 2: 실패) |
| where | String | X | 검색 조건 설정 (dest_phone: 수신번호 / send_phone: 발송번호 / msg_body: 내용) |
| keyword | String | X | 검색 키워드 |
| start_date | String | X | 조회 시작일 (yyyy-mm-dd) |
| end_date | String | X | 조회 종료일 (yyyy-mm-dd) |
| limit | Integer | X | 페이지당 노출 개수 (기본값: 15) |
Response
| 키 | 타입 | 설명 | ||
|---|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | ||
| error | String | 실패시 오류 메시지 | ||
| content | message | String | API Request 성공 메시지 | |
| totalResult | Integer | 확인된 전체 발송 수 | ||
| paging | Object | 페이징 정보 | ||
| thisPageTotalResult | Integer | 현재 페이지의 전체 데이터 개수 | ||
| displayPageAnchor | String | 하단 페이징에 노출될 페이지 번호 (','로 구분된 String) | ||
| nowPage | Integer | 현재 페이지 번호 | ||
| totalPage | Integer | 전체 페이지 번호 | ||
| firstPage | Integer | 첫번째 페이지 번호 | ||
| prevPage | Integer | 이전 페이지 번호 | ||
| nextPage | Integer | 다음 페이지 번호 | ||
| lastPage | Integer | 마지막 페이지 번호 | ||
| result | Array | 발송 목록 | ||
| number | String | 노출될 데이터의 고유 번호 | ||
| msg_id | String | 메시지의 고유 코드 | ||
| datetime | String | 발송 요청일 | ||
| msg_type | String | 메시지 타입 (알림톡 / 친구톡) | ||
| status | String | 상태 (대기중 / 성공 / 실패) | ||
| error_msg | String | 발송 실패한 경우 오류 메시지 | ||
| failover_msg | String | failover 상태 메시지 | ||
| dest_phone | String | 수신 번호 | ||
| send_phone | String | 발신 번호 | ||
| msg_body | String | 메시지 본문 | ||
친구톡 예약 발송 내역 리스트
| POST URL | /kakao/friendtalk/sent/reserved/list |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| page | String | X | 노출 페이지 번호 (기본값: 1) |
| status | Integer | X | 상태값 (0: 대기 / 1: 성공 / 2: 실패) |
| where | String | X | 검색 조건 설정 (dest_phone: 수신번호 / send_phone: 발송번호 / msg_body: 내용) |
| keyword | String | X | 검색 키워드 |
| start_date | String | X | 조회 시작일 (yyyy-mm-dd) |
| end_date | String | X | 조회 종료일 (yyyy-mm-dd) |
| limit | Integer | X | 페이지당 노출 개수 (기본값: 15) |
Response
| 키 | 타입 | 설명 | ||
|---|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | ||
| error | String | 실패시 오류 메시지 | ||
| content | message | String | API Request 성공 메시지 | |
| totalResult | Integer | 확인된 전체 발송 수 | ||
| paging | Object | 페이징 정보 | ||
| thisPageTotalResult | Integer | 현재 페이지의 전체 데이터 개수 | ||
| displayPageAnchor | String | 하단 페이징에 노출될 페이지 번호 (','로 구분된 String) | ||
| nowPage | Integer | 현재 페이지 번호 | ||
| totalPage | Integer | 전체 페이지 번호 | ||
| firstPage | Integer | 첫번째 페이지 번호 | ||
| prevPage | Integer | 이전 페이지 번호 | ||
| nextPage | Integer | 다음 페이지 번호 | ||
| lastPage | Integer | 마지막 페이지 번호 | ||
| result | Array | 발송 목록 | ||
| number | String | 노출될 데이터의 고유 번호 | ||
| msg_id | String | 메시지의 고유 코드 | ||
| datetime | String | 발송 요청일 | ||
| msg_type | String | 메시지 타입 (알림톡 / 친구톡) | ||
| status | String | 상태 (대기중 / 성공 / 실패) | ||
| error_msg | String | 발송 실패한 경우 오류 메시지 | ||
| failover_msg | String | failover 상태 메시지 | ||
| dest_phone | String | 수신 번호 | ||
| send_phone | String | 발신 번호 | ||
| sendtime | String | 발송 예약 시간 | ||
| msg_body | String | 메시지 본문 | ||
인증토큰 요청
발신프로필 등록을 위한 카카오톡 채널 인증 토큰을 요청합니다.인증토큰은 입력한 phoneNumber 로 발송됩니다.
| POST URL | /kakao/profile/token |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| phoneNumber | String | O | 토큰을 수신할 휴대폰번호 (Yellow ID의 핸드폰번호와 일치) |
| yellowId | String | O | 카카오톡 채널명(@ID) |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
발신프로필 카테고리 전체 조회
발신프로필 등록시 사용할 카테고리 목록 전체를 조회합니다.| POST URL | /kakao/profile/category/all |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
Response
| 키 | 타입 | 설명 | ||
|---|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | ||
| error | String | 실패시 오류 메시지 | ||
| content | message | String | API Request 성공 메시지 | |
| category | Array | 성공시 템플릿 목록 | ||
| code | String | 카테고리 코드 | ||
| name | String | 카테고리 이름 | ||
발신프로필 카테고리 조회
카테고리 코드에 해당하는 특정 카테고리를 조회합니다.| POST URL | /kakao/profile/category |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| categoryCode | String | O | 카테고리 코드 |
Response
| 키 | 타입 | 설명 | ||
|---|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | ||
| error | String | 실패시 오류 메시지 | ||
| content | message | String | API Request 성공 메시지 | |
| category | Array | 성공시 템플릿 목록 | ||
| code | String | 카테고리 코드 | ||
| name | String | 카테고리 이름 | ||
발신프로필 등록
발신프로필을 신규 등록합니다.| POST URL | /kakao/profile/create |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| token | String | O | 수신받은 인증토큰 |
| phoneNumber | String | O | 토큰을 수신할 휴대폰번호 (Yellow ID의 핸드폰번호와 일치) |
| yellowId | String | O | 카카오톡 채널명(@ID) |
| categoryCode | String | O | 카테고리 코드 |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
| senderKey | String | 발신프로필 senderKey | |
발신프로필 조회
발신프로필 정보를 조회합니다.| POST URL | /kakao/profile |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 등록된 발신프로필의 키 |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
| senderKey | String | 발신프로필 senderKey | |
| uuid | String | 카카오톡 채널 | |
| name | String | 카카오톡 채널 발신프로필 명 | |
| status | String | 발신프로필 상태 | |
| block | Boolean | 발신프로필 차단 여부 | |
| dormant | Boolean | 발신프로필 휴면 여부 | |
| profileStatus | String |
카카오톡 채널 상태 (A: activated, C: deactivated, B: block, E: deleting, D: deleted) |
|
| createdAt | String | 발신프로필 등록일 | |
| modifiedAt | String | 최종 수정일 | |
| categoryCode | String | 발신프로필 카테고리코드 | |
| alimtalk | Boolean | 알림톡 사용 여부 | |
| bizchat | Boolean | 상담톡 사용 여부 | |
| brandtalk | Boolean | 브랜드톡 사용 여부 | |
| committalCompanyName | String | 위탁사 이름 (상담톡 관련) | |
| chennelKey | String | 메시지 전송 결과 수신 채널키 | |
| businessprofile | Boolean | 카카오톡 채널 비즈니스 인증 여부 | |
| businessType | String | 카카오톡 채널 비즈니스 인증 타입 | |
| failover | String | failover(대체발송)이 설정된 경우 설정된 발신번호 | |
발신프로필 리스트 조회
발신프로필 리스트를 조회합니다.| POST URL | /kakao/profile/list |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
Response
| 키 | 타입 | 설명 | |||
|---|---|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |||
| error | String | 실패시 오류 메시지 | |||
| content | message | String | API Request 성공 메시지 | ||
| success | Array | 성공케이스에 대한 리스트 | |||
| senderKey | String | 발신프로필 키 | |||
| uuid | String | 발신프로필 상태 | |||
| name | String | 카카오톡 채널 프로필 명 | |||
| status | String | 상태 (A: 정상) | |||
| block | Boolean | 발신 프로필 차단 여부 | |||
| dormant | Boolean | 발신프로필 휴면 여부 | |||
| profileStatus | String |
카카오톡 채널 상태 (A: activated, C: deactivated, B: block, E: deleting, D: deleted) |
|||
| createdAt | String | 발신프로필 등록일 | |||
| modifiedAt | String | 최종 수정일 | |||
| categoryCode | String | 발신프로필 카테고리코드 | |||
| alimtalk | Boolean | 알림톡 사용 여부 | |||
| bizchat | Boolean | 상담톡 사용 여부 | |||
| brandtalk | Boolean | 브랜드톡 사용 여부 | |||
| committalCompanyName | String | 위탁사 이름 (상담톡 관련) | |||
| chennelKey | String | 메시지 전송 결과 수신 채널키 | |||
| businessprofile | Boolean | 카카오톡 채널 비즈니스 인증 여부 | |||
| businessType | String | 카카오톡 채널 비즈니스 인증 타입 | |||
| groups | Array | 발신 프로필 그룹 정보 | |||
| groupKey | String | 발신 프로필 그룹 키 | |||
| name | String | 이름 | |||
| createdAt | String | 등록일 | |||
| fail | Array | 실패케이스에 대한 리스트 | |||
| senderKey | String | 발신 프로필 키 | |||
| code | String | 실패 결과 코드 | |||
| message | String | 실패 메시지 | |||
미사용 프로필 휴면 해제
장기 미사용으로 인해 휴면 상태인 발신 프로필을 차단 해제합니다.| POST URL | /kakao/profile/recover |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 등록된 발신프로필의 키 |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
템플릿 신규 등록
템플릿을 신규 등록합니다. 사전에 발신프로필 또는 발신 프로필 그룹이 등록 되어있어야 합니다.| POST URL | /kakao/template/add |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 | ||
|---|---|---|---|---|---|
| token_key | String | O | 회원 토큰 | ||
| senderKey | String | O | 등록된 발신프로필의 키 | ||
| templateCode | String | O | 템플릿 코드 (영문, 숫자, 언더바(_), 하이픈(-)만 입력 가능, 최대 30자) |
||
| templateName | String | O | 템플릿 이름 | ||
| templateMessageType | String | O |
템플릿 메시지 유형 (BA: 기본형, EX: 부가정보형, AD: 광고추가형, MI: 복합형) - EX: templateExtra 필드 필수 - AD: templateAd 필드 필수 - MI: templateExtra, templateAd 필드 필수 |
||
| templateEmphasizeType | String | O |
템플릿 강조 유형 (NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형, ITEM_LIST: 아이템리스트형) - TEXT: templateTitle, templateSubtitle 필수 - ITEM_LIST: templateItem.list 필드 필수, templateImate(Name, Url), templateHeader, templateItemHighlight 필드 중 1개 이상 필수, templateItem.summary 필드 사용 가능 - IMAGE: templateImageName, templateImageUrl 필드 필수 |
||
| templateContent | String | O | 템플릿 내용 | ||
| templateExtra | String | X |
부가정보 - templateMessageType 'EX', 'MI' 선택시 필수 |
||
| templateAd | String | X |
광고성메시지 - templateMessageType 'AD', 'MI' 선택시 필수 |
||
| templateImageName | String | X |
템플릿 이미지 파일명 - templateEmphasizeType 'IMAGE' 선택시 필수 |
||
| templateImageUrl | String | O |
템플릿 이미지 링크 - templateEmphasizeType 'IMAGE' 선택시 필수 |
||
| templateTitle | String | X |
템플릿 내용중 강조 표기할 핵심 정보 - templateEmphasizeType 'TEXT' 선택시 필수 |
||
| templateSubtitle | String | X |
강조 표기 보고 문구 - templateEmphasizeType 'TEXT' 선택시 필수 |
||
| templateHeader | String | X | 헤더 | ||
| templateItemHighlight | Object | X | 아이템 하이라이트 | ||
| title | String | O | 타이틀 (최대 30자까지 입력 가능, 썸네일 이미지가 있는 경우 21자까지 입력 가능) | ||
| description | String | O | 상세 설명 (최대 19자까지 입력 가능, 썸네일 이미지가 있는 경우 13자까지 입력 가능) | ||
| imageUrl | String | X | 썸네일 이미지 주소 (최대 500자까지 입력 가능) | ||
| templateItem | Object | X | 아이템 정보 | ||
| list | Array | O |
아이템 리스트 (최소 2개, 최대 10개) - templateEmphasizeType 'ITEM_LIST' 선택시 필수 |
||
| title | String | O | 타이틀 (최대 6자까지 입력 가능) | ||
| description | String | O | 디스크립션 (최대 23자까지 입력 가능) | ||
| summary | String | X | 아이템 요약 정보 | ||
| title | String | O | 타이틀 (최대 6자까지 입력 가능) | ||
| description | String | O | 디스크립션 (변수만 입력 가능, 최대 14자까지 입력 가능) | ||
| categoryCode | String | O | 템플릿 카테고리 코드 | ||
| securityFlag | Boolean | X |
보안 템플릿 여부, OPT등 보안 메시지인 경우 설정 발신 당시의 메인 디바이스를 제외한 모든 디바이스에 메시지 텍스트 미노출 (true: 설정, false: 미설정) |
||
| buttons | Array | X | 버튼 정보 (최대 5개 등록 가능, 바로 연결과 함께 사용시 최대 2개로 제한) | ||
| name | String | O |
버튼명 - linkType 'AC' 선택시 버튼명은 '채널추가'로 고정 |
||
| linkType | String | O |
버튼 링크타입 (DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달, AC: 채널추가, BC: 상담톡전환, BT: 봇전환, P1: 이미지 보안전송 플러그인, P2: 개인정보이용 플러그인, BF: 비즈니스폼) |
||
| linkAnd | String | X |
Android 앱 링크 주소 (AL 사용시 필수) - linkIos, linkAnd, linkMo 중 2가지 필수 입력 |
||
| linkIos | String | X | IOS 앱 링크 주소 (AL 사용시 필수) | ||
| linkMo | String | X | 모바일 웹 링크 주소 (WL 사용시 필수) | ||
| linkPc | String | X | PC 웹 링크 주소 (WL 사용시 필수) | ||
| pluginId | String | X | 플러그인ID (P1, P2 사용시 필수) | ||
| bizFormId | String | X | 비즈니스폼ID (BF 사용시 필수) | ||
| quickReplies | Array | X |
바로연결 정보 (최대 10개 등록 가능) - 상담톡 이용 채널에 한해 바로연결 기능 사용이 가능 |
||
| name | String | O | 바로연결명 | ||
| linkType | String | O |
바로연결 링크타입 (WL: 웹링크, AL: 앱링크, BK: 봇키워드, AC: 채널추가, BC: 상담톡전환, BT: 봇전환, BF: 비즈니스폼) |
||
| linkAnd | String | X |
Android 앱 링크 주소 (AL 사용시 필수) - linkIos, linkAnd, linkMo 중 2가지 필수 입력 |
||
| linkIos | String | X | IOS 앱 링크 주소 (AL 사용시 필수) | ||
| linkMo | String | X | 모바일 웹 링크 주소 (WL 사용시 필수) | ||
| linkPc | String | X | PC 웹 링크 주소 (WL 사용시 필수) | ||
| bizFormId | String | X | 비즈니스폼ID (BF 사용시 필수) | ||
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
| 성공시 반환되는 템플릿 정보는 [템플릿 상세 조회] Response 명세 참조 | |||
템플릿 코드 유효성 검증
등록하려는 템플릿 코드의 유효성을 검증합니다.| POST URL | /kakao/template/codeCheck |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 등록된 발신프로필의 키 |
| templateCode | String | O |
템플릿 코드 (영문, 숫자, 언더바(_), 하이픈(-)만 입력 가능, 최대 30자) |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
템플릿 목록 조회
발신프로필에 등록된 템플릿 목록을 조회합니다.| POST URL | /kakao/template/list |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 등록된 발신프로필의 키 |
| templateStatus | String | X |
템플릿 상태 (REG: 등록, REQ: 검수요청, REJ: 반려, STP: 차단, RDY: 발송전, ACT: 정상, DMT: 휴면, BLK: 차단) |
| page | String | X | 요청 페이지 (기본값: 1) |
| count | String | X | 페이지별 템플릿 개수 (기본값: 30) |
| keyword | String | X | 검색 키워드 (글자수 2자 ~ 50자 제한) |
| startDate | String | X | 생성일자 기준 시작일자 (yyyyMMddHHmmss) |
| endDate | String | X | 생성일자 기준 종료일자 (yyyyMMddHHmmss) |
| categoryCodeList | Array | X | 검색 대상의 템플릿 카테고리 코드 목록 |
| String | X | 카테고리 코드 |
Response
| 키 | 타입 | 설명 | ||
|---|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | ||
| error | String | 실패시 오류 메시지 | ||
| content | message | String | API Request 성공 메시지 | |
| totalCount | Integer | 총 개수 | ||
| totalPage | Integer | 총 페이지 수 | ||
| currentPage | String | 현재 페이지 | ||
| list | Array | 성공시 템플릿 목록 | ||
| senderKey | String | 발신프로필 키 | ||
| senderKeyType | String | 발신프로필 키 타입 | ||
| templateCode | String | 템플릿 코드 | ||
| templateName | String | 템플릿 이름 | ||
| categoryCode | String | 템플릿 카테고리 코드 | ||
| createdAt | String | 등록일 | ||
| modifiedAt | String | 수정일 | ||
| serviceStatus | String |
템플릿 상태 (REG: 등록, REQ: 검수요청, REJ: 반려, STP: 차단, RDY: 발송전, ACT: 정상, DMT: 휴면, BLK: 차단) |
||
템플릿 상세 조회
템플릿을 조회 합니다.| POST URL | /kakao/template/detail |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 등록된 발신프로필의 키 |
| templateCode | String | O | 템플릿 코드 |
Response
code, error 키는 명세표에서 생략. 아래 항목은 content 하위 키에 해당.ex) 'templateCode' 의 경우 'content->templateCode'로 response 됨.
| 키 | 타입 | 설명 | ||
|---|---|---|---|---|
| templateCode | String | 템플릿 코드 (영문, 숫자, 언더바(_), 하이픈(-)만 입력 가능, 최대 30자) |
||
| templateName | String | 템플릿 이름 | ||
| templateMessageType | String |
템플릿 메시지 유형 (BA: 기본형, EX: 부가정보형, AD: 광고추가형, MI: 복합형) |
||
| templateEmphasizeType | String |
템플릿 강조 유형 (NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형, ITEM_LIST: 아이템리스트형) |
||
| templateContent | String | 템플릿 내용 | ||
| templateExtra | String | 부가정보 | ||
| templateAd | String | 광고성메시지 | ||
| templateImageName | String | 템플릿 이미지 파일명 | ||
| templateImageUrl | String | 템플릿 이미지 링크 | ||
| templateTitle | String | 템플릿 내용중 강조 표기할 핵심 정보 | ||
| templateSubtitle | String | 강조 표기 보고 문구 | ||
| templateHeader | String | 헤더 | ||
| templateItemHighlight | Object | 아이템 하이라이트 | ||
| title | String | 타이틀 | ||
| description | String | 상세 설명 | ||
| imageUrl | String | 썸네일 이미지 주소 | ||
| templateItem | Object | 아이템 정보 | ||
| list | Array | 아이템 리스트 | ||
| title | String | 타이틀 | ||
| description | String | 디스크립션 | ||
| summary | String | 아이템 요약 정보 | ||
| title | String | 타이틀 | ||
| description | String | 디스크립션 | ||
| categoryCode | String | 템플릿 카테고리 코드 | ||
| securityFlag | Boolean | 보안 템플릿 여부 (true: 설정, false: 미설정) | ||
| inspectionStatus | String |
검수 상태 (REG: 등록, REQ: 검수요청, REJ: 반려, APR: 승인) |
||
| buttons | Array | 버튼 정보 | ||
| name | String | 버튼명 | ||
| linkType | String |
버튼 링크타입 (DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달, AC: 채널추가, BC: 상담톡전환, BT: 봇전환, P1: 이미지 보안전송 플러그인, P2: 개인정보이용 플러그인, BF: 비즈니스폼) |
||
| linkAnd | String | Android 앱 링크 주소 | ||
| linkIos | String | IOS 앱 링크 주소 | ||
| linkMo | String | 모바일 웹 링크 주소 | ||
| linkPc | String | PC 웹 링크 주소 | ||
| pluginId | String | 플러그인ID | ||
| bizFormId | String | 비즈니스폼ID | ||
| quickReplies | Array | 바로연결 정보 | ||
| name | String | 바로연결명 | ||
| linkType | String | 바로연결 링크타입 | ||
| linkAnd | String | Android 앱 링크 주소 | ||
| linkIos | String | IOS 앱 링크 주소 | ||
| linkMo | String | 모바일 웹 링크 주소 | ||
| linkPc | String | PC 웹 링크 주소 | ||
| bizFormId | String | 비즈니스폼ID | ||
| comments | Array | 검수 댓글 목록 | ||
| content | String | 댓글 본문 | ||
| createdAt | String | 댓글 생성일 | ||
| status | String |
댓글 상태 (REQ: 등록, INQ: 문의, APR: 승인, REJ: 반려, REP: 답변) |
||
| userName | String | 댓글 작성자 | ||
| attarhment | Array | 첨부파일 | ||
| originalFileName | String | 업로드한 파일 원본 이름 | ||
| filePath | String | 파일 다운로드 경로 | ||
| createdAt | String | 등록일 | ||
| modifiedAt | String | 수정일 | ||
템플릿 수정
등록된 템플릿을 수정합니다. 템플릿 상태가 대기(R)이고 템플릿 검수상태가 등록(REG) 또는 반려(REJ)인 경우에만 수정 가능합니다.| POST URL | /kakao/template/update |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 | ||
|---|---|---|---|---|---|
| token_key | String | O | 회원 토큰 | ||
| senderKey | String | O | 등록된 발신프로필의 키 | ||
| templateCode | String | O | 템플릿 코드 (영문, 숫자, 언더바(_), 하이픈(-)만 입력 가능, 최대 30자) |
||
| newTemplateCode | String | X | 수정하려는 템플릿 코드 (영문, 숫자, 언더바(_), 하이픈(-)만 입력 가능, 최대 30자) |
||
| templateName | String | O | 템플릿 이름 | ||
| templateMessageType | String | O |
템플릿 메시지 유형 (BA: 기본형, EX: 부가정보형, AD: 광고추가형, MI: 복합형) - EX: templateExtra 필드 필수 - AD: templateAd 필드 필수 - MI: templateExtra, templateAd 필드 필수 |
||
| templateEmphasizeType | String | O |
템플릿 강조 유형 (NONE: 선택안함, TEXT: 강조표기형, IMAGE: 이미지형, ITEM_LIST: 아이템리스트형) - TEXT: templateTitle, templateSubtitle 필수 - ITEM_LIST: templateItem.list 필드 필수, templateImate(Name, Url), templateHeader, templateItemHighlight 필드 중 1개 이상 필수, templateItem.summary 필드 사용 가능 - IMAGE: templateImageName, templateImageUrl 필드 필수 |
||
| templateContent | String | O | 템플릿 내용 | ||
| templateExtra | String | X |
부가정보 - templateMessageType 'EX', 'MI' 선택시 필수 |
||
| templateAd | String | X |
광고성메시지 - templateMessageType 'AD', 'MI' 선택시 필수 |
||
| templateImageName | String | X |
템플릿 이미지 파일명 - templateEmphasizeType 'IMAGE' 선택시 필수 |
||
| templateImageUrl | String | O |
템플릿 이미지 링크 - templateEmphasizeType 'IMAGE' 선택시 필수 |
||
| templateTitle | String | X |
템플릿 내용중 강조 표기할 핵심 정보 - templateEmphasizeType 'TEXT' 선택시 필수 |
||
| templateSubtitle | String | X |
강조 표기 보고 문구 - templateEmphasizeType 'TEXT' 선택시 필수 |
||
| templateHeader | String | X | 헤더 | ||
| templateItemHighlight | Object | X | 아이템 하이라이트 | ||
| title | String | O | 타이틀 (최대 30자까지 입력 가능, 썸네일 이미지가 있는 경우 21자까지 입력 가능) | ||
| description | String | O | 상세 설명 (최대 19자까지 입력 가능, 썸네일 이미지가 있는 경우 13자까지 입력 가능) | ||
| imageUrl | String | X | 썸네일 이미지 주소 (최대 500자까지 입력 가능) | ||
| templateItem | Object | X | 아이템 정보 | ||
| list | Array | O |
아이템 리스트 (최소 2개, 최대 10개) - templateEmphasizeType 'ITEM_LIST' 선택시 필수 |
||
| title | String | O | 타이틀 (최대 6자까지 입력 가능) | ||
| description | String | O | 디스크립션 (최대 23자까지 입력 가능) | ||
| summary | String | X | 아이템 요약 정보 | ||
| title | String | O | 타이틀 (최대 6자까지 입력 가능) | ||
| description | String | O | 디스크립션 (변수만 입력 가능, 최대 14자까지 입력 가능) | ||
| categoryCode | String | O | 템플릿 카테고리 코드 | ||
| securityFlag | Boolean | X |
보안 템플릿 여부, OPT등 보안 메시지인 경우 설정 발신 당시의 메인 디바이스를 제외한 모든 디바이스에 메시지 텍스트 미노출 (true: 설정, false: 미설정) |
||
| buttons | Array | X | 버튼 정보 (최대 5개 등록 가능, 바로 연결과 함께 사용시 최대 2개로 제한) | ||
| name | String | O |
버튼명 - linkType 'AC' 선택시 버튼명은 '채널추가'로 고정 |
||
| linkType | String | O |
버튼 링크타입 (DS: 배송조회, WL: 웹링크, AL: 앱링크, BK: 봇키워드, MD: 메시지전달, AC: 채널추가, BC: 상담톡전환, BT: 봇전환, P1: 이미지 보안전송 플러그인, P2: 개인정보이용 플러그인, BF: 비즈니스폼) |
||
| linkAnd | String | X |
Android 앱 링크 주소 (AL 사용시 필수) - linkIos, linkAnd, linkMo 중 2가지 필수 입력 |
||
| linkIos | String | X | IOS 앱 링크 주소 (AL 사용시 필수) | ||
| linkMo | String | X | 모바일 웹 링크 주소 (WL 사용시 필수) | ||
| linkPc | String | X | PC 웹 링크 주소 (WL 사용시 필수) | ||
| pluginId | String | X | 플러그인ID (P1, P2 사용시 필수) | ||
| bizFormId | String | X | 비즈니스폼ID (BF 사용시 필수) | ||
| quickReplies | Array | X |
바로연결 정보 (최대 10개 등록 가능) - 상담톡 이용 채널에 한해 바로연결 기능 사용이 가능 |
||
| name | String | O | 바로연결명 | ||
| linkType | String | O |
바로연결 링크타입 (WL: 웹링크, AL: 앱링크, BK: 봇키워드, AC: 채널추가, BC: 상담톡전환, BT: 봇전환, BF: 비즈니스폼) |
||
| linkAnd | String | X |
Android 앱 링크 주소 (AL 사용시 필수) - linkIos, linkAnd, linkMo 중 2가지 필수 입력 |
||
| linkIos | String | X | IOS 앱 링크 주소 (AL 사용시 필수) | ||
| linkMo | String | X | 모바일 웹 링크 주소 (WL 사용시 필수) | ||
| linkPc | String | X | PC 웹 링크 주소 (WL 사용시 필수) | ||
| bizFormId | String | X | 비즈니스폼ID (BF 사용시 필수) | ||
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
| 성공시 반환되는 템플릿 정보는 [템플릿 상세 조회] Response 명세 참조 | |||
템플릿 삭제
등록된 템플릿을 삭제합니다. 템플릿 상태가 대기(R)이고 템플릿 검수상태가 등록(REG) 또는 반려(REJ)인 경우에만 삭제 가능합니다.| POST URL | /kakao/template/delete |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 등록된 발신프로필의 키 |
| templateCode | String | O | 템플릿 코드 |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
템플릿 카테고리 전체 조회
템플릿 등록시 사용할 카테고리 목록 전체를 조회합니다.| POST URL | /kakao/template/category/all |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
Response
| 키 | 타입 | 설명 | ||
|---|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | ||
| error | String | 실패시 오류 메시지 | ||
| content | message | String | API Request 성공 메시지 | |
| category | Array | 성공 시 카테고리 목록 | ||
| code | String | 카테고리 코드 | ||
| name | String | 카테고리 이름 | ||
| groupName | String | 카테고리 그룹 이름 | ||
| Inclusion | String | 카테고리 적용 대상 템플릿 설명 | ||
| exclusion | String | 카테고리 제외 대상 템플릿 설명 | ||
템플릿 카테고리 조회
카테고리 코드에 해당하는 특정 템플릿 카테고리를 조회합니다.| POST URL | /kakao/template/category |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| categoryCode | String | O | 카테고리 코드 |
Response
| 키 | 타입 | 설명 | ||
|---|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | ||
| error | String | 실패시 오류 메시지 | ||
| content | message | String | API Request 성공 메시지 | |
| category | Array | 성공 시 카테고리 목록 | ||
| code | String | 카테고리 코드 | ||
| name | String | 카테고리 이름 | ||
| groupName | String | 카테고리 그룹 이름 | ||
| Inclusion | String | 카테고리 적용 대상 템플릿 설명 | ||
| exclusion | String | 카테고리 제외 대상 템플릿 설명 | ||
템플릿 검수 요청
등록된 템플릿을 검수 요청합니다. 템플릿 상태가 대기(R)이고 템플릿 검수상태가 등록(REG)인 경우에만 요청 가능합니다.| POST URL | /kakao/template/request |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 발신 프로필 키 |
| templateCode | String | O | 템플릿 코드 |
| comment | String | X | 의견 또는 문의사항 (최대 500자까지 입력 가능) |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
템플릿 검수 요청 (파일 첨부)
등록된 템플릿을 검수 요청합니다. 템플릿 상태가 대기(R)이고 템플릿 검수상태가 등록(REG)인 경우에만 요청 가능합니다.파일과 함께 문의 또는 의견을 남길수 있습니다. 파일 형식은 png, jpg, jpge, gif, pdf, hwp, doc, docx만 가능하며 개당 50MB까지 첨부할 수 있습니다.
| POST URL | /kakao/template/request/withfile |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 발신 프로필 키 |
| templateCode | String | O | 템플릿 코드 |
| comment | String | X | 의견 또는 문의사항 (최대 500자까지 입력 가능) |
| attachment | String | X |
업로드할 파일을 base64로 인코딩하여 전달 다수의 이미지 첨부하는 경우 콤마(',')로 구분하여 전달 |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
템플릿 검수 요청 취소
검수 요청 상태의 템플릿을 취소 요청합니다. 템플릿 상태가 대기(R)이고 템플릿 검수상태가 검수 요청(REQ)인 경우에만 요청 가능합니다.| POST URL | /kakao/template/request/cancel |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 발신 프로필 키 |
| templateCode | String | O | 템플릿 코드 |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
템플릿 사용 중지
등록된 템플릿을 중지 상태로 변경합니다. 템플릿 상태가 대기(R) 또는 정상(A) 이고 템플릿 검수상태가 승인(APR)인 경우에만 요청 가능합니다.| POST URL | /kakao/template/stop |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 발신 프로필 키 |
| templateCode | String | O | 템플릿 코드 |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
템플릿 사용 중지 해제
등록된 템플릿을 정상 상태로 되돌립니다. 템플릿 상태가 중지(S) 이고 템플릿 검수상태가 승인(APR)인 경우에만 요청 가능합니다.| POST URL | /kakao/template/reuse |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 발신 프로필 키 |
| templateCode | String | O | 템플릿 코드 |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
템플릿 승인 취소
승인된 템플릿이 대기(R) 상태 일 때 승인 취소할 수 있습니다. 승인 취소시 등록(REG) 상태로 변경되며 재 검수 요청 가능합니다.| POST URL | /kakao/template/approval/cancel |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 발신 프로필 키 |
| templateCode | String | O | 템플릿 코드 |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
템플릿 휴면 해제
장기간 미사용으로 휴면된 템플릿을 해제합니다. 해제 후 30일간 사용하지 않는 경우 재 휴면 처리 됩니다.| POST URL | /kakao/template/release |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 발신 프로필 키 |
| templateCode | String | O | 템플릿 코드 |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
친구톡 기본/와이드 이미지 등록
친구톡 기본/와이드 이미지를 등록합니다.| POST URL | /kakao/image/upload |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 발신 프로필 키 |
| image | String | O |
이미지 파일 (jpg, png) 을 base64로 인코딩하여 전달 [기본형] - 파일 규격: jpg, jpeg, png 가능 / 용량: 500kb 까지 가능 - 권장 사이즈 : 720x720px (가로 500px 이상 / 가로:세로 비율 2:1 ~ 3:4) [와이드형] - 파일 규격: jpg, jpeg, png 가능 / 용량: 2mb 까지 가능 - 권장 사이즈 : 800x600px |
| imageType | String | O | 이미지 타입 (기본: I, 와이드: W) |
| title | String | O | 이미지 제목 |
| link | String | O | 이미지 클릭시 이동할 URL (http:// 또는 https:// 포함) |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
| image | String | 성공 시 이미지가 등록된 카카오 서버 URL | |
친구톡 와이드 아이템 리스트 이미지 업로드
친구톡 와이드 아이템 리스트 이미지를 등록합니다.| POST URL | /kakao/image/friendtalk/wideItemList |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 | |
|---|---|---|---|---|
| token_key | String | O | 회원 토큰 | |
| senderKey | String | O | 발신 프로필 키 | |
| itemList | Array | O | 이미지 정보 리스트 | |
| image | String | O |
이미지 파일 (jpg, png) 을 base64로 인코딩하여 전달 - 파일 규격: jpg, jpeg, png 가능 / 용량: 2mb 까지 가능 - 권장 사이즈 : 400x400px (가로 400~800px / 세로 400px) |
|
| title | String | O | 이미지 제목 | |
| link | String | O | 이미지 클릭시 이동할 URL (http:// 또는 https:// 포함) | |
Response
| 키 | 타입 | 설명 | |||
|---|---|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |||
| error | String | 실패시 오류 메시지 | |||
| content | message | String | API Request 성공 메시지 | ||
| success | Array | 성공 결과 목록 | |||
| formField | String | 업로드 Field | |||
| url | String | 이미지가 등록된 카카오 서버 URL | |||
| failure | Array | 실패 결과 목록 | |||
| formField | String | 업로드 Field | |||
| error | Object | 에러 정보 | |||
| code | String | 에러 코드 | |||
| message | String | 에에러 메시지 | |||
친구톡 캐러셀 피드 이미지 업로드
친구톡 캐러셀 피드 이미지를 등록합니다.| POST URL | /kakao/image/friendtalk/carousel |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 | |
|---|---|---|---|---|
| token_key | String | O | 회원 토큰 | |
| senderKey | String | O | 발신 프로필 키 | |
| itemList | Array | O | 이미지 정보 리스트 | |
| image | String | O |
이미지 파일 (jpg, png) 을 base64로 인코딩하여 전달 - 파일 규격: jpg, jpeg, png 가능 / 용량: 2mb 까지 가능 - 권장 사이즈 : 720x720px (가로:세로 비율 2:1 ~ 3:4) |
|
| title | String | O | 이미지 제목 | |
| link | String | O | 이미지 클릭시 이동할 URL (http:// 또는 https:// 포함) | |
Response
| 키 | 타입 | 설명 | |||
|---|---|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |||
| error | String | 실패시 오류 메시지 | |||
| content | message | String | API Request 성공 메시지 | ||
| success | Array | 성공 결과 목록 | |||
| formField | String | 업로드 Field | |||
| url | String | 이미지가 등록된 카카오 서버 URL | |||
| failure | Array | 실패 결과 목록 | |||
| formField | String | 업로드 Field | |||
| error | Object | 에러 정보 | |||
| code | String | 에러 코드 | |||
| message | String | 에에러 메시지 | |||
친구톡 이미지 조회
친구톡 이미지 목록을 조회 합니다.| POST URL | /kakao/image/list |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 발신 프로필 키 |
| imageType | String | O | 이미지 타입 (I: 기본, W: 와이드, L: 와이드아이템리스트, C: 캐러셀) |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
| title | String | 이미지 제목 | |
| link | String | 이미지 클릭 시 이동할 URL (http:// 또는 https:// 포함) | |
| imageUrl | String | 이미지가 등록된 카카오 서버 URL | |
| createdAt | String | 이미지 등록일 | |
| imageType | String | 이미지 타입 (I: 기본, W: 와이드, L: 와이드아이템리스트, C: 캐러셀) | |
친구톡 이미지 삭제
등록된 친구톡 이미지를 삭제합니다.| POST URL | /kakao/image/delete |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 발신 프로필 키 |
| imageUrl | String | O | 삭제할 이미지 URL 정보 |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
알림톡 템플릿 등록용 이미지 업로드
이미지 알림톡 또는 아이템리스트 알림톡 템플릿 등록 시 사용될 이미지를 업로드 합니다.| POST URL | /kakao/image/alimtalk/template |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| image | String | O |
이미지 파일 (jpg, png) 을 base64로 인코딩하여 전달 - 파일 규격: jpg, jpeg, png 가능 / 용량: 500kb 까지 가능 - 제한 사이즈: width 500px 이상, 비율 2:1 |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
| image | String | 성공시 카카오 서버에 업로드된 이미지 URL | |
알림톡 이미지 업로드
이미지 알림톡 또는 아이템리스트 알림톡 발송 시 사용될 이미지를 업로드 합니다.| POST URL | /kakao/image/alimtalk |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| image | String | O |
이미지 파일 (jpg, png) 을 base64로 인코딩하여 전달 - 파일 규격: jpg, jpeg, png 가능 / 용량: 500kb 까지 가능 - 제한 사이즈: width 500px 이상, 비율 2:1 이상 3:4 이하 |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
| image | String | 성공시 카카오 서버에 업로드된 이미지 URL | |
알림톡 하이라이트 이미지 업로드
아이템리스트 알림톡 발송 시 사용될 아이템 하이라이트 이미지를 업로드 합니다.| POST URL | /kakao/image/alimtalk/itemHighlight |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| image | String | O |
이미지 파일 (jpg, png) 을 base64로 인코딩하여 전달 - 파일 규격: jpg, jpeg, png 가능 / 용량: 500kb 까지 가능 - 제한 사이즈: width 108px 이상, 비율 1:1 |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
| image | String | 성공시 카카오 서버에 업로드된 이미지 URL | |
플러그인 콜백 URL 조회
발신프로필 키로 해당 카카오톡 채널에 등록된 플러그인 콜백 URL을 조회합니다.| POST URL | /kakao/plugin/callbackUrl/list |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 발신프로필 |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
| pluginId | String | 플러그인 아이디 | |
| pluginType | String | 플러그인 타입 (SECURE_IMAGE: 보안이미지전송, ONE_TIME_PROFILE: 개인정보이용) |
|
| pluginTypeName | String | 플러그인 타입 이름 | |
| callbackUrl | String | Callback Url | |
| modifiable | Boolean | 수정 가능 여부 (다른 허브파트너에서 등록한 경우 수정 불가) |
|
| deletable | Boolean | 삭제 가능 여부 (다른 허브파트너에서 등록한 경우 삭제 불가) |
|
플러그인 콜백 URL 등록
발신프로필 키로 해당 카카오톡 채널에 플러그인 콜백 URL을 등록합니다.| POST URL | /kakao/plugin/callbackUrl/create |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 발신프로필 |
| pluginType | String | O | 플러그인 타입 (SECURE_IMAGE, ONE_TIME_PROFILE) |
| pluginId | String | O | 플러그인 아이디 |
| callbackUrl | String | O | 콜백 URL |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
플러그인 콜백 URL 수정
발신프로필 키로 해당 카카오톡 채널에 등록된 플러그인 콜백 URL을 수정합니다.| POST URL | /kakao/plugin/callbackUrl/update |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 발신프로필 |
| pluginId | String | O | 플러그인 아이디 |
| callbackUrl | String | O | 콜백 URL |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |
플러그인 콜백 URL 삭제
발신프로필 키로 해당 카카오톡 채널에 등록된 플러그인 콜백 URL을 삭제합니다.| POST URL | /kakao/plugin/callbackUrl/delete |
|---|---|
| Content-Type | application/json; charset=utf-8 |
Request
| 키 | 타입 | 필수 | 설명 |
|---|---|---|---|
| token_key | String | O | 회원 토큰 |
| senderKey | String | O | 발신프로필 |
| pluginId | String | O | 플러그인 아이디 |
Response
| 키 | 타입 | 설명 | |
|---|---|---|---|
| code | String | 결과 코드 (성공시: 200) | |
| error | String | 실패시 오류 메시지 | |
| content | message | String | API Request 성공 메시지 |