알림톡 수신자 엑셀 업로드

아래의 템플릿으로 제공되는 수신자 대량 업로드 엑셀 파일을 이용하여 엑셀 업로드 API를 호출하면 fileId 값을 리턴한다.

10KB

talk_alimtalk_sample.xlsx

수신자 엑셀 입력 규칙은 엑셀 파일에서 확인 가능합니다.

API 목록

No	Method	API	Description
1	POST	/v1/openapi/alimtalk/excel/validation	수신자 엑셀파일 유효성 검사 API
2	POST	/v1/openapi/alimtalk/excel/upload	수신자 엑셀파일 업로드

1. 수신자 엑셀파일 유효성 검사

POST https://api.megabird.co.kr:8080/v1/openapi/alimtalk/excel/validation

1.1 Request Body Parameter

Name	Type	Required	Description
file	MultipartFile	필수	Excel 파일 (xls, xlxs 확장자)

1.2 Response Body

파라미터명	타입	설명
success	boolean	성공여부
code	String	결과 코드
message	String	결과 메시지
data	Json	결과 데이터
timestamp	LocalDateTime	현재 시간

1.3 Response Example

200: OK

{
    "success": true,
    "code": "200",
    "message": "성공",
    "data": {
        "totalCnt": 1,
        "errorCnt": 0,
        "errors": []
    },
    "timestamp": "2024-01-01T15:58:04.307338"
}

400: Bad Request

{
    "status": 400,
    "code": 3100,
    "message": "유효성 검사에 실패하였습니다.",
    "success": false,
    "timestamp": "2024-01-01T16:33:47.079061",
    "description": [
        {
            "errorType": "excel upload",
            "results": {
                "totalCnt": 1,
                "errorCnt": 1,
                "errors": [
                    {
                        "row": "3",
                        "message": "[{3}행의 #{이름} 컬럼은 최대 30 글자입니다.]"
                    }
                ]
            }
        }
    ]
}

2. 수신자 엑셀파일 업로드

POST https://api.megabird.co.kr:8080/v1/openapi/alimtalk/excel/upload

2.1 Request Body Parameter

Name	Type	Required	Description
file	MultipartFile	필수	Excel 파일 (xls, xlxs 확장자)

2.2 Response Body

파라미터명	타입	설명
success	boolean	성공여부
code	String	결과 코드
message	String	결과 메시지
data	Json	결과 데이터
fileId	String	엑셀파일 아이디
fileNm	String	엑셀파일명
timestamp	LocalDateTime	현재 시간

2.3 Response Example

200: OK

{
    "success": true,
    "code": "200",
    "message": "성공",
    "data": {
        "fileId": "aaaaaaaaaaaaaaa",
        "fileNm": "talk_alimtalk_sample.xlsx"
    },
    "timestamp": "2024-01-01T16:39:10.434845"
}

400: Bad Request

{
    "status": 400,
    "code": 3100,
    "message": "유효성 검사에 실패하였습니다.",
    "success": false,
    "timestamp": "2024-01-01T16:33:47.079061",
    "description": [
        {
            "errorType": "excel upload",
            "results": {
                "totalCnt": 1,
                "errorCnt": 1,
                "errors": [
                    {
                        "row": "3",
                        "message": "[{3}행의 #{이름} 컬럼은 최대 30 글자입니다.]"
                    }
                ]
            }
        }
    ]
}

3. Error code

2001, "엑셀파일 확장자는 xls, xlxs만 허용됩니다."
2002, "업로드 허용사이즈는 최대 100,000건입니다."
2003, "전체 컬럼의 데이터 총 개수가 일치하지 않습니다."
3100, "유효성 검사에 실패하였습니다."