이미지 업로드 API
API PLEX 이미지 업로드 API
Path variable
Path variable은 아래 내용을 참고하여 호출 시 누락되지 않도록 해주세요.
userId
API PLEX 사용자ID
단일 이미지 업로드
친구톡 일반 이미지 업로드 API
POST
https://tyrar0qvgf.apigw.ntruss.com/file/v1/FT/image/{userId}
친구톡 발송 시 사용할 일반 이미지를 업로드합니다.
업로드된 이미지는 3 개월 후 삭제됩니다.
Headers
Content-Type*
string
multipart/form-data
Request Body
image*
file
업로드할 이미지
- 권장 사이즈 : 720px * 720px
- 제한 사이즈 : 가로 500px 미만 또는 가로:세로 비율이 2:1 미만 또는 3:4 초과
- 파일 형식 및 크기 : jpg, png / 최대 500KB
친구톡 와이드 이미지 업로드 API
POST
https://tyrar0qvgf.apigw.ntruss.com/file/v1/FT_WIDE/image/{userId}
친구톡 발송 시 사용할 와이드 이미지를 업로드합니다.
업로드된 이미지는 3 개월 후 삭제됩니다.
Headers
Content-Type*
string
multipart/form-data
Request Body
image*
file
업로드할 이미지
- 제한 사이즈 : 800px * 600px
- 가로:세로 비율 2:1 이상, 1:1 이하
- 파일 형식 및 크기 : jpg, png / 최대 2MB
Response Body
{
"data": {
"image_key": "string",
"request_date": "string",
"name": "string",
"url": "string"
},
"errcode": "string",
"errmsg": "string"
}
data
object
업로드 결과
image_key
string
업로드키
request_date
string
업로드요청날짜 (YYYYMMDD 형식)
name
string
업로드 파일명
url
string
업로드된 이미지 url (친구톡 발송시 요청 body에 입력)
errmsg
string
에러 메세지
에러 코드
E600
FailedToUploadImageException
-
InvalidImageMaxLengthException
이미지 용량 초과
InvalidImageSizeException
발송할 수 없는 이미지 사이즈
InvalidImageFormatException
지원하지 않는 이미지 형식
G900
Gateway 시스템 오류가 발생했습니다.
GATEWAY 오류
CE400
필수값이 누락되었습니다. (%s)
요청 데이터 누락
CE500
일시적인 시스템 오류입니다. 잠시 후 다시 이용해주세요.
CJON 시스템 오류
CE504
일시적인 시스템 오류입니다. (네트워크 타임아웃 to 카카오)
CJON <--> 카카오 간 요청/응답 시 네트워크 타임아웃
다중 이미지 업로드
친구톡 와이드 아이템 리스트 이미지 업로드 API
POST
https://tyrar0qvgf.apigw.ntruss.com/file/v1/ft-wide-item-list/image/{userId}
친구톡 와이드 아이템 리스트 발송 시 사용할 이미지를 업로드합니다.
업로드된 이미지는 3 개월 후 삭제됩니다.
Headers
Content-Type*
String
multipart/form-data
Request Body
image*
file[]
- 친구톡 와이드 아이템 리스트 발송 시 사용할 와이드 이미지
- 4개까지 업로드 가능
- 제한 사이즈: 가로 400 ~ 800px, 세로 400px 고정 - 가로:세로 비율 2:1 이상, 1:1 이하
- 파일 형식 및 크기: jpg, png / 각 파일 최대 2MB
친구톡 캐러셀 피드 이미지 업로드 API
POST
https://tyrar0qvgf.apigw.ntruss.com/file/v1/ft-carousel-feed/image/{userId}
친구톡 캐러셀 피드 발송 시 사용할 이미지를 업로드합니다.
업로드된 이미지는 3 개월 후 삭제됩니다.
Headers
Content-Type*
String
multipart/form-data
Request Body
image*
file[]
- 친구톡 캐러셀 발송 시 사용될 이미지
- 6개까지 업로드
- 권장 사이즈 : 800x600px 또는 800x400px, 가로 500px이상
- 가로:세로 비율 2:1 이상 3:4 이하
- 파일 형식 및 크기 : jpg, png / 각 파일 최대 2MB
- 업로드된 이미지는 3개월 후 삭제
Response Body
{
"result": {
"success": [
"formField": "string",
"url": "string"
],
"failure": [
"formField": "string",
"error": {
"code": "string",
"message": "string"
}
]
"request_date": "string",
"name": "string",
"url": "string"
},
"code": "string"
}
결과 코드
0000
-
성공
6000
Result.failure[].error.message 참고
일부 이미지 업로드 실패
G900
Gateway 시스템 오류가 발생했습니다.
GATEWAY 오류
CE400
필수값이 누락되었습니다. (%s)
요청 데이터 누락
CE500
일시적인 시스템 오류입니다. 잠시 후 다시 이용해주세요.
CJON 시스템 오류
CE504
일시적인 시스템 오류입니다. (네트워크 타임아웃 to 카카오)
CJON <--> 카카오 간 요청/응답 시 네트워크 타임아웃
에러 코드
2001
InvalidImageLengthException
이미지 용량 초과
2002
InvalidImageShapeException
발송할 수 없는 이미지 사이즈
2003
InvalidImageFormatException
지원하지 않는 이미지 형식
2004
FailedToUploadImageException
내부 시스템오류로 업로드 실패
413
Request Entity Too Large
이미지 용량 초과
Last updated
Was this helpful?