6.1개요
본 문서는 이미지를 포함한 카카오톡 비즈메시지를 전송하기 이전에, 이미지를 업로드하기 위해서 제공되는 API 문서다.
본 문서는 https 프로토콜을 통해 데이터를 multipart/form-data 형식으로 가공하여 POST method를 사용하여 전송하고, json형식의 결과 데이터를 parsing하여 처리할 수 있음을 전제로 작성되었다.
6.2용어 정의
6.2.1허브 파트너(Hub Partner)
제휴한 카카오톡 채널을 통해 상담을 요청한 사용자와의 메시지 수신/발신을 대행하는 사업자
6.3선결 조건
업로드 API를 사용하여 이미지를 업로드하기 위해 아래의 조건이 선결되어야 한다.
비즈메시지 센터에 이미지 업로드 시스템의 IP 정보를 업로드 API 서버에 접근할 수 있도록 접근 허용 요청을 해야 한다.
6.4API 스펙
6.4.1Host
[서버] 넥서스 알림톡 서버
6.4.2알림톡 템플릿 등록용 이미지 업로드 요청
강조유형이 이미지형 또는 아이템리스트형인 알림톡 템플릿 등록 시 사용될 이미지를 업로드 합니다.
제한 사이즈 - 가로 500px 이상, 가로:세로 비율 2:1
파일형식 및 크기 : jpg, png / 최대 500KB
- [Request]
POST /image/alimtalk/template
- [Parameter]
키 | 타입 | 필수 | 설명 |
---|---|---|---|
image | binary | Y | 업로드할 이미지 파일 |
- [Response] 응답 바디는 JSON객체로 아래 값을 참고 해주세요.
키 | 타입 | 설명 |
---|---|---|
code | text | 결과 코드 < 코드 정의 에서 확인 가능> |
image | text | 업로드된 이미지 url |
6.4.3알림톡 이미지 업로드 요청
이미지 알림톡 또는 아이템리스트 알림톡 발송 시 사용될 이미지를 업로드 합니다.
제한 사이즈 - 가로 500px 이상, 가로:세로 비율 2:1 이상 3:4 이하
파일형식 및 크기 : jpg, png / 최대 500KB
- [Request]
POST /image/alimtalk
- [Parameter]
키 | 타입 | 필수 | 설명 |
---|---|---|---|
image | binary | Y | 업로드할 이미지 파일 |
- [Response] 응답 바디는 JSON객체로 아래 값을 참고 해주세요.
키 | 타입 | 설명 |
---|---|---|
code | text | 결과 코드 < 코드 정의 에서 확인 가능> |
image | text | 업로드된 이미지 url |
6.4.4알림톡 하이라이트 이미지 업로드 요청
아이템리스트 알림톡 발송 시 사용될 아이템 하이라이트 이미지를 업로드 합니다.
제한 사이즈 - 가로 108px 이상, 가로:세로 비율이 1:1
파일형식 및 크기 : jpg, png / 최대 500KB
- [Request]
POST /image/alimtalk/itemHighlight
- [Parameter]
키 | 타입 | 필수 | 설명 |
---|---|---|---|
image | binary | Y | 업로드할 이미지 파일 |
- [Response] 응답 바디는 JSON객체로 아래 값을 참고 해주세요.
키 | 타입 | 설명 |
---|---|---|
code | text | 결과 코드 < 코드 정의 에서 확인 가능> |
image | text | 업로드된 이미지 url |
6.5코드 정의
code | message | 설명 |
---|---|---|
0000 | - | 요청 성공 |
1002 | InvalidHubPartnerKey | 허브 파트너 키가 유효하지 않음 |
1004 | MissingRequiredParameterException | 필수 파라미터가 없음 |
2001 | InvalidImageLengthException | 이미지 용량 초과 |
2002 | InvalidImageShapeException | 발송할 수 없는 이미지 사이즈 |
2003 | InvalidImageFormatException | 지원하지 않는 이미지 형식 |
2004 | FailedToUploadImageException | 내부 시스템 오류로 업로드 실패 |