파일을 업로드합니다. Base64로 인코딩된 파일 데이터를 전송합니다. 파일 타입에 따라 크기, 확장자, 해상도 제한이 적용됩니다.
파일 타입
업로드 시 파일 타입에 따라 허용되는 확장자, 크기, 해상도 제한이 다릅니다.
| 타입 | 설명 | 크기 제한 | 허용 확장자 | 해상도 제한 |
|---|
| DOCUMENT | 증빙서류 등 일반 문서 (기본값) | 5MB | png, gif, jpg, pdf, tif | - |
| MMS | MMS 메시지용 이미지 | 200KB | jpg | 최대 1500×1440px |
| KAKAO | 카카오 알림톡 이미지 | 500KB | png, jpg | 최소 500×250px, 가로:세로 비율 2:1~1:1.5 |
| ATA | 카카오 알림톡 첨부 이미지 | 500KB | png, jpg | 최소 너비 500px, 가로:세로 비율 정확히 2:1 |
| KAKAO_HIGHLIGHT | 카카오 하이라이트 이미지 | 1000KB | png, jpg | 최소 너비 108px, 가로:세로 비율 정확히 1:1 |
| RCS | RCS 메시지용 이미지 | 1000KB | jpg, png | - |
| FAX | 팩스 발송용 문서 | 20MB | bmp, gif, jpg, tif, tiff, doc, docx, xls, xlsx, ppt, pptx, htm, html, hwp, pdf | - |
| BMS | 브랜드 메시지 이미지 | 5MB | jpg, png | 권장 800×400px, 가로:세로 비율 2:1~3:4 |
| BMS_WIDE | 브랜드 메시지 와이드 이미지 | 5MB | jpg, png | 권장 800×600px, 가로:세로 비율 2:1~1:1 |
Body Params
| Name | Type | Required | Description |
|---|
| file | string | * | 업로드할 파일 데이터. Base64 인코딩. 타입별 크기 제한 적용 |
| type | string | | 파일 타입 |
| name | string | | 파일 별칭. 최대 100자 |
| link | string | | 파일 연결 URL. 카카오 이미지 클릭 시 이동할 링크. 유효한 URL 형식 |
Response
| Name | Type | Required | Description |
|---|
| fileId | string | * | 파일 고유 ID (접두사: ST01FZ, 32자) |
| accountId | string | * | 계정 고유 ID |
| name | string | * | 파일명 |
| originalName | string | | 원본 파일명 |
| url | string | * | 파일 접근 URL (S3) |
| type | string | * | 파일 타입 |
| link | string|null | | 파일 연결 URL |
| width | number | | 이미지 가로 크기 (px) |
| height | number | | 이미지 세로 크기 (px) |
| fileSize | number | * | 파일 크기 (bytes) |
| references | array | * | 파일 참조 목록 (업로드 직후에는 빈 배열) |
| dateCreated | string | * | 생성일시 (ISO 8601) |
| dateUpdated | string | * | 수정일시 (ISO 8601) |
Structure
Request
{
"file": "iVBORw0KGgoAAAANSUhEUgAA...(base64 인코딩된 파일 데이터)",
"type": "KAKAO",
"name": "프로모션 배너",
"link": "https://example.com/promotion"
}
Response
{
"fileId": "ST01FZ_abc12345678901234567890",
"accountId": "12345678901234",
"name": "프로모션 배너",
"originalName": "NyT7u.jpg",
"url": "https://coolsms-storage.s3.ap-northeast-2.amazonaws.com/12345678901234/ST01FZ_abc12345678901234567890",
"type": "KAKAO",
"link": "https://example.com/promotion",
"width": 800,
"height": 400,
"fileSize": 102400,
"references": [],
"dateCreated": "2024-07-01T12:00:00.000Z",
"dateUpdated": "2024-07-01T12:00:00.000Z"
}
