Image Upload API

API PLEX Image Upload API

Path variable

Please refer to the following information to ensure that path variables are not omitted when making calls

code	description
userId	API PLEX user ID

Single image upload

API PLEX regular Image upload API

POST https://tyrar0qvgf.apigw.ntruss.com/file/v1/FT/image/{userId}

Upload a regular image to use in KakaoTalk Friend Talk. Uploaded images will be deleted after 3 months.

Headers

Name	Type	Description
Content-Type*	string	multipart/form-data;charset=utf-8

Request Body

Name	Type	Description
image*	file	Image to upload: - Recommended size: 720px * 720px - Size limit: Less than 500px in width or aspect ratio less than 2:1 or greater than 3:4 - File format and size: jpg, png / Maximum 500KB

200: OK Response returned successfully

API PLEX Wide Image upload API

POST https://tyrar0qvgf.apigw.ntruss.com/file/v1/FT_WIDE/image/{userId}

Upload a wide image to use in KakaoTalk Wide. Uploaded images will be deleted after 3 months.

Headers

Name	Type	Description
Content-Type*	string	multipart/form-data;charset=utf-8

Request Body

Name	Type	Description
image*	file	Image to upload: - Size limit: 800px * 600px - File format and size: jpg, png / Maximum 2MB

200: OK Response returned successfully

Response Body

{
     "data": {
         "image_key": "string",
         "request_date": "string",
         "name": "string",
         "url": "string"
    }
}

key		type	description
data		object	upload result
	image_key	string	upload key
	request_date	string	requested upload date (In the YYYYMMDD format)
	name	string	upload file name
	url	string	upload image url (Enter in the request body when sending KakaoTalk Friend Talk)
errcode		string	error code
errmsg		string	error message

error codes

code	message	description
E600	FailedToUploadImageException	-
	InvalidImageMaxLengthException	Exceeded image size limit
	InvalidImageSizeException	Image size not allowed for sending
	InvalidImageFormatException	Unsupported image format
G900	Gateway system error occurred	GATEWAY error
CE400	필수값이 누락되었습니다. (%s)	required field is missing
CE500	System error	CJ ON system error
CE504	일시적인 시스템 오류입니다. (네트워크 타임아웃 to 카카오)	request/response network timeout (CJON <--> kakao)

Multiple image upload

Upload a image to use in KakaoTalk Friend Talk Wide Item List.

POST https://tyrar0qvgf.apigw.ntruss.com/file/v1/ft-wide-item-list/image/{userId}

Upload a wide image to use in KakaoTalk Wide Item List. Uploaded images will be deleted after 3 months.

Headers

Name	Type	Description
Content-Type*	String	multipart/form-data

Request Body

Name	Type	Description
image*	file[]	- Image for Friend Talk Wide Item List - maximun count: 4 - limit size: width 400px * height 400px ~ width 800px ~ height 400px - file format and size: jpg, png / maximum 2MB for each

200: OK Response returned successfully

Upload a image to use in KakaoTalk Friend Talk Carousel Feed.

POST https://tyrar0qvgf.apigw.ntruss.com/file/v1/ft-carousel-feed/image/{userId}

Upload a wide image to use in KakaoTalk Carousel Feed. Uploaded images will be deleted after 3 months.

Headers

Name	Type	Description
Content-Type*	String	multipart/form-data

Request Body

Name	Type	Description
image*	file[]	- Image for Friend Talk Carousel Feed - maximun count: 6 - limit size: minimum width 500px, width:height rate minimum 2:1, maximum 3:4 - file format and size: jpg, png / maximum 2MB for each

200: OK Response returned successfully

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"
}

키				타입	설명
code				string	결과 코드
result				object
	success			object array	성공 결과 목록
		formField		string	순번을 포함한 image field
		url		string	업로드된 이미지 url (친구톡 발송시 요청 body에 입력)
	failure			object array
		formField		string	순번을 포함한 image field
		error		object	에러 정보
			code	string	에러 코드
			message	string	에러 메세지

result codes

code	message	description
0000	-	success
6000	Result.failure[].error.message	several image upload failed
G900	Gateway 시스템 오류가 발생했습니다.	server internal error
CE400	필수값이 누락되었습니다. (%s)	required field is missing
CE500	System error	CJ ON system error
CE504	일시적인 시스템 오류입니다. (네트워크 타임아웃 to 카카오)	request/response network timeout (CJON <--> kakao)

error codes

code	message	설명
2001	InvalidImageLengthException	image size over
2002	InvalidImageShapeException	invalid image shape
2003	InvalidImageFormatException	invalid image file format
2004	FailedToUploadImageException	server internal error
413	Request Entity Too Large	image file size over