Notification > Email > API v1.5 가이드

[API 도메인]

환경 도메인
Real https://api-mail.cloud.toast.com

[Header]

Content-Type: application/json;charset=UTF-8

[curl 예시 주의 사항]

  • Windows cmd 에서는 curl 예시가 정상적으로 요청되지 않을 수 있습니다.

메일 발송

일반 메일 발송

요청

[URL]

Http method URI
POST /email/v1.5/appKeys/{appKey}/sender/mail

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Request body]

타입 필수 설명
senderAddress String O 발신자 메일 주소 ( 최대 100자 )
senderName String X 발신자 이름 ( 최대 100자 )
requestDate String X 발송 일시 (yyyy-MM-dd HH:mm:ss)
현재 일시(기본값)
title String O 메일 제목 (최대 998자)
body String O 메일 내용
attachFileIdList List:Integer X 업로드한 첨부파일 id (파일 업로드 시 file id를 반환)
templateId String X 발송 템플릿 ID ( 최대 50자 )
templateType String X 템플릿 타입
DEFAULT(기본값), FREEMARKER)
templateParameter Object X 치환 파라미터 (메일 제목/내용 치환시 입력)
- key String X 치환 키 (##key##)
- value Object X 치환 키에 매핑되는 Value값
receiverList List O 수신자 리스트
최대 1000명까지 발송 가능(받는사람, 참조자 포함)
- receiveMailAddr String O 수신자 메일주소
- receiveName String X 수신자 명
- receiveType String O 수신자 타입 (MRT0 : 받는사람 , MRT1 : 참조, MRT2 : 숨은참조)
customHeaders Map X 사용자 지정 헤더
senderGroupingKey String X 발신자 그룹키 ( 최대 100자 )
userId String X 발송 구분자 ex)admin,system ( 최대 50자 )

[주의]

  • template을 사용할 경우 title, body는 필수 값이 아닙니다. (입력 시 입력된 값이 template보다 우선 적용)

[예시 1]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/sender/mail -d '{"senderAddress":"support@nhn.com","senderName":"발송자이름","title":"샘플 타이틀","body":"샘플 내용","receiverList":[{"receiveMailAddr":"customer1@nhn.com","receiveName":"고객1","receiveType":"MRT0"},{"receiveMailAddr":"customer2@nhn.com","receiveName":"고객2","receiveType":"MRT1"}],"userId":"USER"}'

[예시 2 - 템플릿 사용]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/sender/mail -d '{"templateId":"TEMPLATE1","templateParameter":{"key":"value"},"receiverList":[{"receiveMailAddr":"customer1@nhn.com","receiveName":"고객1","receiveType":"MRT0"},{"receiveMailAddr":"customer2@nhn.com","receiveName":"고객2","receiveType":"MRT1"}],"userId":"USER"}'

응답

{
    "header": {
        "resultCode": 0,
        "resultMessage": "success",
        "isSuccessful": true
    },
    "body": {
        "data": {
            "requestId": "20190101000000ABCDEFG0",
            "results": [
                {
                    "receiveMailAddr": "receiver@nhn.com",
                    "receiveName": "receiver",
                    "receiveType": "MRT0",
                    "resultCode": 0,
                    "resultMessage": "success"
                }
            ]
        }
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- data Object 데이터 영역
-- requestId String 요청 ID
-- results List 발송 결과
--- receiveMailAddr String 수신자 메일 주소
--- receiveName String 수신자 명
--- receiveType String 수신자 타입 (MRT0 : 받는사람 , MRT1 : 참조, MRT2 : 숨은참조)
--- resultCode Integer 수신자 발송 요청 결과 코드
--- resultMessage String 수신자 발송 요청 결과 메시지

v1.5에서 달라진 사항

  • 발신자 그룹키 필드가 추가되었습니다. 요청 단위로 설정할 수 있습니다.
  • 발송을 요청할 때 senderGroupingKey 필드를 지정하고, 요청 조회 시 활용할 수 있습니다.

개별 메일 발송

  • 수신자가 여러 명일 때 수신자 각각에게 메일을 발송하는 기능입니다. 여러 명에게 보내도 수신자에게는 본인만 표시됩니다.

요청

[URL]

Http method URI
POST /email/v1.5/appKeys/{appKey}/sender/eachMail

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Request body]

타입 필수 설명
senderAddress String O 발신자 메일 주소 ( 최대 100자 )
senderName String X 발신자 이름 ( 최대 100자 )
requestDate String X 발송 일시 (yyyy-MM-dd HH:mm:ss)
현재 일시(기본값)
title String O 메일 제목 (최대 998자)
body String O 메일 내용
attachFileIdList List:Integer X 업로드한 첨부파일 id (파일 업로드 시 file id를 반환)
templateId String X 발송 템플릿 ID ( 최대 50자 )
templateType String X 템플릿 타입
DEFAULT(기본값), FREEMARKER)
receiverList List O 수신자 리스트
최대 1000명까지 발송 가능
- receiveMailAddr String O 수신자 메일주소
- receiveName String X 수신자 명
- templateParameter Object X 치환 파라미터 (메일 제목/내용 치환시 입력)
-- #key# String X 치환 키 (##key##)
-- #value# Object X 치환 키에 매핑되는 Value값
customHeaders Map X 사용자 지정 헤더
senderGroupingKey String X 발신자 그룹키 ( 최대 100자 )
userId String X 발송 구분자 ex)admin,system ( 최대 50자 )

[주의]

  • template을 사용할 경우 title, body는 필수 값이 아닙니다. (입력 시 입력된 값이 template 보다 우선적용)

[예시 1]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/sender/eachMail -d '{"senderAddress":"support@nhn.com","senderName":"발송자이름","title":"샘플 타이틀","body":"샘플 내용","attachFileIdList":[1,2],"receiverList":[{"receiveMailAddr":"customer1@nhn.com","receiveName":"고객1"}],"userId":"USER"}'

[예시 2 - 템플릿 사용]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/sender/mail -d '{"templateId":"TEMPLATE1","receiverList":[{"receiveMailAddr":"customer1@nhn.com","receiveName":"고객1","templateParameter":{"key":"value"}}],"userId":"USER"}'

응답

{
    "header": {
        "resultCode": 0,
        "resultMessage": "success",
        "isSuccessful": true
    },
    "body": {
        "data": {
            "requestId": "20190101000000ABCDEFG0",
            "results": [
                {
                    "receiveMailAddr": "receiver@nhn.com",
                    "receiveName": "receiver",
                    "receiveType": "MRT0",
                    "resultCode": 0,
                    "resultMessage": "success"
                }
            ]
        }
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- data Object 데이터 영역
-- requestId String 요청 ID
-- results List 발송 결과
--- receiveMailAddr String 수신자 메일 주소
--- receiveName String 수신자 명
--- receiveType String 수신자 타입 (MRT0 : 받는사람 , MRT1 : 참조, MRT2 : 숨은참조)
개별 발송은 이 필드를 요청하지 않으므로 null을 반환.
--- resultCode Integer 수신자 발송 요청 결과 코드
--- resultMessage String 수신자 발송 요청 결과 메시지

v1.5에서 달라진 사항

  • 발신자 그룹키 필드가 추가되었습니다. 요청 단위로 설정할 수 있습니다.
  • 발송을 요청할 때 senderGroupingKey 필드를 지정하고, 요청 조회 시 활용할 수 있습니다.

광고성 일반 메일 발송

  • 요청, 응답 정보는 일반 메일 발송과 동일합니다.

광고메일 전송 시 유의 사항

  • 제목에 반드시 (광고) 문구를 삽입하도록 강제하고 있습니다.
  • 자세한 내용은 [광고성 메일 발송]를 참고해주세요.

[URL]

Http method URI
POST /email/v1.5/appKeys/{appKey}/sender/ad-mail

[예시 1]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/sender/ad-mail -d '{"senderAddress":"support@nhn.com","senderName":"발송자이름","title":"(광고) 샘플 타이틀","body":"샘플 내용 \n##BLOCK_RECEIVER_LINK## \n##EN_BLOCK_RECEIVER_LINK##","receiverList":[{"receiveMailAddr":"customer1@nhn.com","receiveName":"고객1","receiveType":"MRT0"},{"receiveMailAddr":"customer2@nhn.com","receiveName":"고객2","receiveType":"MRT1"}],"userId":"USER"}'

[예시 2 - 템플릿 사용]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/sender/ad-mail -d '{"templateId":"TEMPLATE1","templateParameter":{"key":"value"},"receiverList":[{"receiveMailAddr":"customer1@nhn.com","receiveName":"고객1","receiveType":"MRT0"},{"receiveMailAddr":"customer2@nhn.com","receiveName":"고객2","receiveType":"MRT1"}],"userId":"USER"}'

광고성 개별 메일 발송

  • 요청, 응답 정보는 개별 메일 발송과 동일합니다.

[URL]

Http method URI
POST /email/v1.5/appKeys/{appKey}/sender/ad-eachMail

[예시 1]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/sender/ad-eachMail -d '{"senderAddress":"support@nhn.com","senderName":"발송자이름","title":"(광고) 샘플 타이틀","body":"샘플 내용 \n##BLOCK_RECEIVER_LINK## \n##EN_BLOCK_RECEIVER_LINK##","attachFileIdList":[1,2],"receiverList":[{"receiveMailAddr":"customer1@nhn.com","receiveName":"고객1"}],"userId":"USER"}'

[예시 2 - 템플릿 사용]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/sender/ad-eachMail -d '{"templateId":"TEMPLATE1","receiverList":[{"receiveMailAddr":"customer1@nhn.com","receiveName":"고객1","templateParameter":{"key":"value"}}],"userId":"USER"}'

인증 메일 발송

요청

[URL]

Http method URI
POST /email/v1.5/appKeys/{appKey}/sender/auth-mail

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Request body]

타입 필수 설명
senderAddress String O 발신자 메일 ( 최대 100자 )
senderName String X 발신자 이름 ( 최대 100자 )
requestDate String X 발송 일시 (yyyy-MM-dd HH:mm:ss)
현재 일시(기본값)
title String O 제목 ( 최대 998자 )
body String O 내용
templateId String X 발송 템플릿 ID
receiver Object O 수신자
- receiveMailAddr String O 수신자 메일주소
- receiveName String X 수신자 명
- templateParameter Object X 치환 파라미터 (메일 제목/내용 치환시 입력)
-- #key# String X 치환 키 (##key##)
-- #value# Object X 치환 키에 매핑되는 Value값
customHeaders Map X 사용자 지정 헤더 ( 최대 100자 )
userId String X 발송 구분자 ex)admin,system ( 최대 50자 )

[주의]

  • template을 사용할 경우 title, body는 필수 값이 아닙니다. (입력 시 입력된 값이 template 보다 우선적용)

일반 메일과 다른 점

인증 메일 성격상 다음과 같이 다른 특성들이 있습니다.

  • 단건 발송(1명의 수신자)만 가능합니다.
  • 첨부 파일 기능을 지원하지 않습니다. 첨부 파일이 포함된 템플릿은 지원하지 않습니다.

[예시 1]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/sender/auth-mail -d '{"senderAddress":"support@nhn.com","senderName":"발송자이름","title":"샘플 타이틀","body":"샘플 내용","receiver":{"receiveMailAddr":"customer1@nhn.com","receiveName":"고객1"},"userId":"USER"}'

[예시 2 - 템플릿 사용]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/sender/auth-mail -d '{"templateId":"TEMPLATE1","receiver":{"receiveMailAddr":"customer1@nhn.com","receiveName":"고객1","templateParameter":{"key":"value"}},"userId":"USER"}'

응답

{
    "header": {
        "resultCode": 0,
        "resultMessage": "success",
        "isSuccessful": true
    },
    "body": {
        "data": {
            "requestId": "20190101000000ABCDEFG0",
            "results": [
                {
                    "receiveMailAddr": "receiver@nhn.com",
                    "receiveName": "receiver",
                    "receiveType": "MRT0",
                    "resultCode": 0,
                    "resultMessage": "success"
                }
            ]
        }
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- data Object 데이터 영역
-- requestId String 요청 ID
-- results List 발송 결과
--- receiveMailAddr String 수신자 메일 주소
--- receiveName String 수신자 명
--- receiveType String 수신자 타입 (MRT0 : 받는사람 , MRT1 : 참조, MRT2 : 숨은참조)
개별 발송은 이 필드를 요청하지 않으므로 null을 반환.
--- resultCode Integer 수신자 발송 요청 결과 코드
--- resultMessage String 수신자 발송 요청 결과 메시지

태그 메일 발송

요청

[URL]

Http method URI
POST /email/v1.5/appKeys/{appKey}/sender/tagMail

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Request body]

타입 필수 설명
senderAddress String O 발신자 메일 ( 최대 100자 )
senderName String X 발신자 이름 ( 최대 100자 )
requestDate String X 발송 일시 (yyyy-MM-dd HH:mm:ss)
현재 일시(기본값)
title String O 제목 ( 최대 998자 )
body String O 내용
templateId String X 템플릿 ID
adYn String X 광고 여부 'N'(기본값)
autoSendYn String X 자동 발송 여부 'Y'(기본값)
attachFileIdList List:Integer X 첨부파일 리스트
tagExpression List:String O 태그 표현식
customHeaders Map X 사용자 지정 헤더
userId String X 발송 구분자 ex)admin,system

[주의]

  • template을 사용할 경우 title, body는 필수 값이 아닙니다. (입력 시 입력된 값이 template보다 우선 적용)

[예시 1]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/sender/tagMail -d '{"senderAddress":"support@nhn.com","senderName":"발송자이름","title":"샘플 타이틀","body":"샘플 내용","attachFileIdList":[1, 2],"tagExpression":["tag1","AND","tag2"],"userId":"USER"}'

[예시 2 - 템플릿 사용]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/sender/tagMail -d '{"templateId":"TEMPLATE1","tagExpression":["tag1","AND","tag2"],"userId":"USER"}'

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "requestId": "20190101000000ABCDEFG0"
        }
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- data Object 데이터 영역
-- requestId String 요청 ID

첨부파일 업로드

요청

[URL]

Http method URI
POST /email/v1.5/appKeys/{appKey}/attachfile/binaryUpload

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Request body]

타입 필수 설명
fileName String O 파일이름
fileBody Byte[] O 파일의 Byte[] 값
createUser String O 파일 업로드 유저 정보

[예시]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/attachfile/binaryUpload -d '{"fileName":"file.csv","createUser":"USER","fileBody":[]}'

응답

{
  "header": {
    "isSuccessful":  Boolean,
    "resultCode": Integer,
    "resultMessage": String
  },
  "body": {
    "data": {
      "fileId": Integer,
      "fileName": String
    }
  }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- data Object 데이터 영역
-- fileId String 파일 ID
-- fileName String 파일명

제목/본문 치환

기본 타입

  • (##치환 Key##) 형식으로 입력하면 사용자가 입력한 templateParameter로 치환할 수 있습니다.
* title : ##title_name##님 안녕하세요 !!
* body : ##body_content## 발송합니다.
->
* title : 클라우드고객1님 안녕하세요!!
* body : test2 발송합니다.

FreeMarker 타입

  • FreeMarker 템플릿 엔진을 지원합니다.
  • 템플릿 언어를 사용하여 사용자가 입력한 templateParameter로 치환할 수 있습니다.
* title : ${title_name}님 안녕하세요 !!
* body : ${body_content} 발송합니다.
->
* title : 클라우드고객1님 안녕하세요!!
* body : test2 발송합니다.

일반 메일요청 예시

{
    "senderAddress" : "support@nhn.com",
    "templateId": "template1",
    "templateParameter" : {"title_name": "클라우드고객1", "body_content": "test1"},
    "receiverList" : [
        {
            "receiveMailAddr" : "customer1@nhn.com",
            "receiveType" : "MRT0"
        }

    ],
    "userId" : "tester"
}

개별 메일요청 예시

{
    "senderAddress" : "support@nhn.com",
    "templateId": "template1",
    "receiverList" : [
        {
            "receiveMailAddr" : "customer1@nhn.com",
            "templateParameter" : {"title_name": "클라우드고객1", "body_content": "test1"}
        },
        {
            "receiveMailAddr" : "customer2@nhn.com",
            "templateParameter" : {"title_name": "클라우드고객2", "body_content": "test2"}
        }

    ],
    "userId" : "tester"
}

메일 조회

메일 발송 리스트 조회

요청

[URL]

Http method URI
GET /email/v1.5/appKeys/{appKey}/sender/mails

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Query parameter]

타입 필수 설명
requestId String O 요청 ID
startSendDate String O 발송 날짜 시작 값(yyyy-MM-dd HH:mm:ss)
endSendDate String O 발송 날짜 종료 값(yyyy-MM-dd HH:mm:ss)
startReceiveDate String X 수신 날짜 시작 값(yyyy-MM-dd HH:mm:ss)
endReceiveDate String X 수신 날짜 종료 값(yyyy-MM-dd HH:mm:ss)
senderAddress String X 발신메일 주소
senderName String X 발신자 이름
receiveMailAddr String X 수신 메일 주소
templateId String X 템플릿 ID
mailStatusCode String X 발송 상태 코드
SST0:발송준비, SST1:발송중,
SST2:발송완료, SST3 : 발송실패
isReceived Boolean X 수신 여부
isOpened Boolean X 읽음 여부
senderGroupingKey String X 발신자 그룹키
pageNum Integer X 페이지 번호 1(기본값)
pageSize Integer X 조회 건수 15(기본값)
  • requestId 또는 startSendDate, endSendDate 요청 필드가 필수입니다.

[예시]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/sender/mails?startSendDate=2018-03-01+00%3A00&endSendDate=2018-03-07+23%3A59&pageSize=10"

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "pageNum": 1,
        "pageSize": 10,
        "totalCount": 1,
        "data": [
            {
                "requestId": "20190101000000ABCDEFG0",
                "mailSeq": 0,
                "requestDate": "2019-01-01 00:00:00",
                "templateId": "Template",
                "templateName": "Template Name",
                "senderName": "Sender",
                "senderAddress": "sender@nhn.com",
                "title": "Title",
                "mailStatusCode": "SST2",
                "mailStatusName": "발송완료",
                "isReceived": true,
                "resultDate": "2019-01-01 00:00:00",
                "isOpened": true,
                "openedDate": "2019-01-01 00:00:00",
                "receiveMailAddr": "receiver@nhn.com",
                "receiveType": "MRT0",
                "receiveTypeName": "받는사람",
                "receiveName": "Receiver",
                "senderGroupingKey": "A_GROUP"
            }
        ]
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- pageNum Integer 현재 페이지 번호
- pageSize Integer 조회된 데이터 건수
- totalCount Integer 총 데이터 건수
- data List 데이터 영역
-- requestId String 요청 ID
-- mailSeq Integer 한 요청에 여러 메일을 보낸 경우, 각 메일에 부여되는 순번
-- requestDate String 발신일시
-- templateId String 템플릿ID
-- templateName String 템플릿명
-- senderName String 발신자 이름
-- senderAddress String 발신자 메일주소
-- title String 메일 제목
-- mailStatusCode String 발송 상태 코드
SST0:발송준비, SST1:발송중,
SST2:발송완료, SST3 : 발송실패
-- mailStatusName String 발송 상태 명
-- isReceived Boolean 수신 여부
-- resultDate String 수신 일시
-- isOpened Boolean 읽음 여부
-- openedDate String 읽은 일시
-- receiveMailAddr String 수신자 메일주소
-- receiveType String 수신자 타입
MRT0 : 받는사람 , MRT1 : 참조, MRT2 : 숨은참조
-- receiveTypeName String 수신자 타입 이름
-- receiveName String 수신자 이름
-- senderGroupingKey String 발신자 그룹키

v1.5에서 달라진 사항

  • 발신자 그룹키 필드 senderGroupingKey가 추가되었습니다.
  • 수신 여부 필드 isReceived가 추가되었습니다.
  • 읽음 여부 필드 isOpened가 추가되었습니다.
  • 읽은 일시 필드 openedDate가 추가되었습니다.
  • 요청 필드 중 발송 상태 코드를 나타내는 필드 이름이 mailStatusCode로 변경되었습니다.
  • 수신자 메일 주소를 나타내는 필드 이름이 receiveMailAddr로 변경되었습니다.
  • 발신자 메일 주소를 나타내는 필드 이름이 senderAddress로 변경되었습니다.

메일 발송 상세 조회

요청

[URL]

Http method URI
GET /email/v1.5/appKeys/{appKey}/sender/mail/{requestId}/{mailSeq}

[Path parameter]

타입 설명
appKey String 고유의 appKey
requestId String 요청ID
mailSeq Integer 메일 순번 (메일 리스트 조회 시 반환되는 mailSeq 값)

[예시]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/sender/mail/{requestId}/{mailSeq}"

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "requestId": "20190101000000ABCDEFG0",
            "mailSeq": 0,
            "requestIp": "127.0.0.1",
            "requestDate": "2019-01-01 00:00:00",
            "mailStatusCode": "SST2",
            "mailStatusName": "발송완료",
            "templateId": "Template",
            "templateName": "Template Name",
            "senderName": "Sender",
            "senderAddress": "sender@nhn.com",
            "resultId": "<20190101000000ABCDEFG0@test>",
            "title": "Title",
            "body": "Body",
            "receiverList": [
                {
                    "requestId": "20190101000000ABCDEFG0",
                    "mailSeq": 0,
                    "receiveType": "MRT0",
                    "receiveTypeName": "받는사람",
                    "receiveName": "Receiver",
                    "receiveMailAddr": "receiver@nhn.com",
                    "isReceived": true,
                    "resultDate": "2019-01-01 00:00:00",
                    "isOpened": true,
                    "openedDate": "2019-01-01 00:00:00"
                }
            ],
            "attachFileList": [
                {
                    "fileType": "MAIL",
                    "fileId": 1,
                    "fileName": "test.jpg",
                    "filePath": "file/path",
                    "fileSize": 1,
                    "createDate": "2019-01-01 00:00:00"
                }
            ],
            "customHeaders": {
                "Content-Type": "text/html"
            },
            "senderGroupingKey": "A_GROUP"
        }
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- data Object 데이터 영역
-- requestId String 요청 ID
-- mailSeq Integer 메일 순번
-- requestIp String 요청 IP
-- requestDate String 요청 일시
-- mailStatusCode String 발송 상태 코드
SST0:발송준비, SST1:발송중,
SST2:발송완료, SST3 : 발송실패
-- mailStatusName String 발송 상태 명
-- templateId String 템플릿 ID
-- templateName String 템플릿 명
-- senderName String 발신자 이름
-- senderAddress String 발신자 메일주소
-- resultId String 메일 발송 ID
-- title String 메일 제목
-- body String 메일 내용
-- receiverList List 수신자 리스트
--- requestId String 요청 ID
--- mailSeq Integer 메일 순번
--- receiveType String 수신자 타입
MRT0 : 받는사람 , MRT1 : 참조, MRT2 : 숨은참조
--- receiveTypeName String 수신자 타입 명
--- receiveName String 수신자 이름
--- receiveMailAddr String 수신자 메일 주소
--- isReceived Boolean 수신 여부
--- resultDate String 수신 일시
--- isOpened Boolean 읽음 여부
--- openedDate String 읽은 일시
-- attachFileList List 첨부파일 리스트
--- fileType String 첨부파일 타입
MAIL: 메일에 첨부된 파일, TEMPLATE: 템플릿에 첨부된 파일
--- fileId Integer 파일 ID
--- fileName String 첨부파일 이름
--- filePath String 첨부파일 경로
--- fileSize Integer 첨부파일 크기 (byte)
--- createDate String 생성 일시
-- customHeaders Map 사용자 지정 헤더
-- senderGroupingKey String 발신자 그룹키

v1.5에서 달라진 사항

  • 발신자 그룹키 필드 senderGroupingKey가 추가되었습니다.
  • 수신자 목록를 나타내는 필드 이름이 receiverList로 변경되었습니다.
  • 수신자의 수신 여부 필드 isReceived가 추가되었습니다.
  • 수신자의 읽음 여부 필드 이름이 isOpened로 변경되었습니다.
  • 수신자의 읽은 일시 필드 이름이 openedDate로 변경되었습니다.
  • 발신자 메일 주소를 나타내는 필드 이름이 senderAddress로 변경되었습니다.

태그 메일 발송 요청 조회

요청

[URL]

Http method URI
GET /email/v1.5/appKeys/{appKey}/tagMails

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Query parameter]

타입 필수 설명
requestId String O 요청 ID
startSendDate String O 발송 날짜 시작 값(yyyy-MM-dd HH:mm:ss)
endSendDate String O 발송 날짜 종료 값(yyyy-MM-dd HH:mm:ss)
senderMail String X 발신메일 주소
senderName String X 발신자 이름
templateId String X 템플릿 ID
sendStatus String X 발송상태 코드
WAIT: 대기, READY: 발송준비,
SENDREADY: 발송준비완료, SENDWAIT: 발송대기,
SENDING: 발송중, COMPLETE: 발송완료,
FAIL: 발송실패, CANCEL: 발송취소
pageNum Integer X 페이지 번호 1(기본값)
pageSize Integer X 조회 건수 15(기본값)

[주의]

  • requestId가 있는 경우, startSendDate와 endSendDate는 필수 값이 아닙니다.
  • startSendDate와 endSendDate가 있는 경우, requestId는 필수 값이 아닙니다.

[예시]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/tagMails?startSendDate=2018-03-01+00%3A00&endSendDate=2018-03-07+23%3A59&pageSize=10"

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "pageNum": 1,
        "pageSize": 15,
        "totalCount": 1,
        "data": [
            {
                "requestId": "20190101000000ABCDEFG0",
                "requestIp": "127.0.0.1",
                "requestDate": "2019-01-01 00:00:00.0",
                "tagSendStatus": "COMPLETE",
                "tagSendStatusName": "발송완료",
                "tagExpression": [
                    "ABCD1234"
                ],
                "templateId": "TEMPLATE",
                "templateName": "Template",
                "senderName": "sender",
                "senderMailAddress": "sender@nhn.com",
                "title": "Title",
                "body": "Body",
                "attachYn": "N",
                "adYn": "N",
                "createUser": "USER",
                "createDate": "2019-09-24 09:33:25.0",
                "updateUser": "USER",
                "updateDate": "2019-09-24 09:35:15.0"
            }
        ]
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- pageNum Integer 현재 페이지 번호
-pageSize Integer 조회된 데이터 건수
- totalCount Integer 총 데이터 건수
- data List 데이터 영역
-- requestId String 요청 ID
-- requestIp String 요청 아이피
-- requestDate String 요청 시간
-- tagSendStatus String 발송상태 코드
WAIT: 대기, READY: 발송준비,
SENDREADY: 발송준비완료, SENDWAIT: 발송대기,
SENDING: 발송중, COMPLETE: 발송완료,
FAIL: 발송실패, CANCEL: 발송취소
-- tagExpression List:String 태그 표현식
-- templateId String 템플릿 ID
-- templateName String 템플릿명
-- senderName String 발신자명
-- senderMail String 발신자주소
-- title String 제목
-- body String 내용
-- attachYn String 첨부파일여부
-- adYn String 광고여부
-- createUser String 생성자
-- createDate String 생성 일시
-- updateUser String 수정자
-- updateDate String 수정 일시

태그 메일 발송 수신자 조회

요청

[URL]

Http method URI
GET /email/v1.5/appKeys/{appKey}/tagMails/{requestId}

[Path parameter]

타입 설명
appKey String 고유의 appKey
requestId String 요청 ID

[Query parameter]

타입 필수 설명
receiveMail String X 수신 메일 주소
startReceiveDate String X 수신 날짜 시작 값(yyyy-MM-dd HH:mm:ss)
endReceiveDate String X 수신 날짜 종료 값(yyyy-MM-dd HH:mm:ss)
receiveStatus String X 발송상태 코드
SST0:발송준비, SST1:발송중,
SST2:발송완료, SST3 : 발송실패
pageNum Integer X 페이지 번호 1(기본값)
pageSize Integer X 조회 건수 15(기본값)

[예시]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/tagMails/{requestId}?startReceiveDate=2018-03-01+00%3A00&endReceiveDate=2018-03-07+23%3A59&pageSize=10"

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "pageNum": 1,
        "pageSize": 15,
        "totalCount": 1,
        "data": [
            {
                "requestId": "20190101000000ABCDEFG0",
                "receiveMail": "receiver@nhn.com",
                "mailStatusCode": "SST2",
                "mailStatusName": "발송완료",
                "resultId": "<20190101000000ABCDEFG0@mail>",
                "resultDate": "2019-01-01 00:00:00.0",
                "readYn": "Y",
                "readDate": "2019-01-01 00:00:00.0",
                "createUser": "USER",
                "createDate": "2019-01-01 00:00:00.0",
                "updateUser": "USER",
                "updateDate": "2019-01-01 00:00:00.0",
                "mailSequence": 0
            }
        ]
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- pageNum Integer 현재 페이지 번호
-pageSize Integer 조회된 데이터 건수
- totalCount Integer 총 데이터 건수
- data List 데이터 영역
-- requestId String 요청 ID
-- mailSequence Integer 메일 순번
-- receiveMail String 수신자주소
-- mailStatusCode String 메일 상태 코드
SST0:발송준비, SST1:발송중,
SST2:발송완료, SST3 : 발송실패
-- mailStatusName String 메일 상태명
-- resultId String SMTP ID
-- resultDate String 실제 발송 시간
-- readYn String 읽음 여부
-- readDate String 읽은 시간
-- createUser String 생성자
-- createDate String 생성 일시
-- updateUser String 수정자
-- updateDate String 수정 일시

태그 메일 발송 상세 조회

요청

[URL]

Http method URI
GET /email/v1.5/appKeys/{appKey}/tagMails/{requestId}/{mailSequence}

[Path parameter]

타입 설명
appKey String 고유의 appKey
requestId String 요청 ID
mailSequence Integer 메일 순번

[예시]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/tagMails/{requestId}/{mailSequence}"

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "requestId": "20190101000000ABCDEFG0",
            "requestIp": "127.0.0.1",
            "templateId": "TEMPLATE",
            "templateName": "Template",
            "mailStatusCode": "SST2",
            "mailStatusName": "발송완료",
            "requestDate": "2019-01-01 00:00:00.0",
            "senderName": "sender",
            "senderMail": "sender@nhn.com",
            "resultId": "<20190101000000ABCDEFG0@mail>",
            "resultDate": "2019-01-01 00:00:00.0",
            "title": "Title",
            "body": "Body",
            "customHeaders": {
                "Content-Type": "text/html"
            },
            "receivers": [
                {
                    "requestId": "20190101000000ABCDEFG0",
                    "receiveType": "MRT0",
                    "receiveTypeName": "받는사람",
                    "receiveMailAddr": "receiver@nhn.com",
                    "readYn": "Y",
                    "readDate": "2019-01-01 00:00:00.0",
                    "mailSequence": "0"
                }
            ],
            "attachFileList": [
                {
                    "fileType": "MAIL",
                    "fileId": 12345,
                    "fileName": "test.csv",
                    "filePath": "file/path",
                    "fileSize": 10,
                    "createDate": "2019-01-01 00:00:00.0"
                }
            ]
        }
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- pageNum Integer 현재 페이지 번호
-pageSize Integer 조회된 데이터 건수
- totalCount Integer 총 데이터 건수
- data List 데이터 영역
-- requestId String 요청 ID
-- requestIp String 요청 IP
-- templateId String 템플릿 ID
-- templateName String 템플릿 명
-- mailStatusCode String 메일 상태 코드
SST0:발송준비, SST1:발송중,
SST2:발송완료, SST3 : 발송실패
-- mailStatusName String 메일 상태 명
-- requestDate String 요청 시간
-- resultDate String 결과 시간
-- senderName String 발신자 명
-- senderMail String 발신자 주소
-- resultId String SMTP ID
-- title String 제목
-- body String 내용
-- receivers List 수신자 리스트
--- requestId String 요청 ID
--- mailSequence Integer 메일 순번
--- receiveType String 수신자 타입 (MRT0 : 받는사람 , MRT1 : 참조, MRT2 : 숨은참조)
--- receiveTypeName String 수신자 타입명
--- receiveMailAddr String 수신자 메일 주소
--- readYn String 읽음 여부
--- readDate String 읽은 시간
-- attachFileList List 첨부파일 리스트
--- fileType String 첨부파일 타입 (MAIL: 메일에 첨부된 파일, TEMPLATE: 템플릿에 첨부된 파일)
--- fileId String 파일 ID
--- fileName String 첨부파일 이름
--- filePath String 첨부파일 경로
--- fileSize Integer 첨부파일 크기 (byte)
--- createDate String 생성 일시
-- customHeaders Map 사용자 지정 헤더

카테고리 관리

카테고리 목록 조회

요청

[URL]

Http method URI
GET /email/v1.5/appKeys/{appKey}/categories

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Query parameter]

타입 필수 설명
useYn String X 사용 여부 Y, N
categoryParentId Integer X 부모 카테고리 ID
pageNum Integer X 페이지 번호 1(기본값)
pageSize Integer X 조회 건수 15(기본값)

[예시]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/categories?useYn=Y&categoryParentId=1&pageNum=1&pageSize=10"

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "pageNum": 1,
        "pageSize": 15,
        "totalCount": 3,
        "data": [
            {
                "categoryId": 12345,
                "categoryParentId": 0,
                "depth": 0,
                "categoryName": "Category",
                "categoryDesc": "Top Category",
                "useYn": "Y",
                "createUser": "user",
                "createDate": "2019-07-23 00:00:00.0",
                "updateUser": "user",
                "updateDate": "2019-07-23 00:00:00.0",
            }
        ]
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- pageNum Integer 현재 페이지 번호
- pageSize Integer 조회된 데이터 건수
- totalCount Integer 총 데이터 건수
- data List 데이터 영역
-- categoryId Integer 카테고리 ID
-- categoryParentId Integer 부모 카테고리 ID(최상위 카테고리인 경우 0)
-- depth Integer depth (최상위 카테고리인 경우 0)
-- categoryName String 카테고리 이름
-- categoryDesc String 카테고리 설명
-- useYn String 사용 여부
-- createUser String 생성자
-- createDate String 생성 일시
-- updateUser String 수정자
-- updateDate String 수정 일시

카테고리 상세 조회

요청

[URL]

Http method URI
GET /email/v1.5/appKeys/{appKey}/categories/{categoryId}

[Path parameter]

타입 설명
appKey String 고유의 appKey
categoryId String 카테고리 ID

[예시]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/categories/{categoryId}"

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "categoryId": 12345,
            "categoryParentId": 0,
            "depth": 0,
            "categoryName": "Category",
            "categoryDesc": "Top Category",
            "useYn": "Y",
            "createUser": "user",
            "createDate": "2019-07-23 00:00:00.0",
            "updateUser": "user",
            "updateDate": "2019-07-23 00:00:00.0"
        }
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- data List 데이터 영역
-- categoryId Integer 카테고리 ID
-- categoryParentId Integer 부모 카테고리 ID(최상위 카테고리인 경우 0)
-- depth Integer depth (최상위 카테고리인 경우 0)
-- categoryName String 카테고리 이름
-- categoryDesc String 카테고리 설명
-- useYn String 사용 여부
-- createUser String 생성자
-- createDate String 생성 일시
-- updateUser String 수정자
-- updateDate String 수정 일시

카테고리 등록

요청

[URL]

Http method URI
POST /email/v1.5/appKeys/{appKey}/categories

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Request body]

타입 최대 길이 필수 설명
categoryParentId Integer - X 부모 카테고리 ID
최상위 카테고리 ID(기본값)
categoryName String 200 O 카테고리 이름
categoryDesc String 1000 X 카테고리 설명
useYn String 1 X 사용 여부 Y(기본값), N
userId String 50 X 사용자 ID

[예시]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/categories -d '{"categoryParentId":12345,"categoryName":"Category","categoryDesc":"Top Category","useYn":"Y","userId":"USER"}'

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "categoryId": 12346
        }
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- data Object 데이터 영역
-- categoryId Integer 카테고리 ID

카테고리 수정

요청

[URL]

Http method URI
PUT /email/v1.5/appKeys/{appKey}/categories/{categoryId}

[Path parameter]

타입 설명
appKey String 고유의 appKey
categoryId Integer 카테고리 ID

[Request body]

타입 최대 길이 필수 설명
categoryName String 200 X 카테고리 이름
categoryDesc String 1000 X 카테고리 설명
useYn String 1 X 사용 여부 Y, N
userId String 50 X 사용자 ID

[예시]

curl -X PUT -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/categories/{categoryId} -d '{"categoryName":"Category","categoryDesc":"Top Category","useYn":"Y","userId":"USER"}'

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지

카테고리 삭제

요청

[URL]

Http method URI
DELETE /email/v1.5/appKeys/{appKey}/categories/{categoryId}

[Path parameter]

타입 설명
appKey String 고유의 appKey
categoryId Integer 카테고리 ID

[예시]

curl -X DELETE -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/categories/{categoryId}

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지

템플릿 관리

템플릿 리스트 조회

요청

[URL]

Http method URI
GET /email/v1.5/appKeys/{appKey}/templates

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Query parameter]

타입 필수 설명
categoryId Integer X 카테고리 ID
useYn String X 사용 여부(Y/N)
pageNum Integer X 페이지 번호 1(기본값)
pageSize Integer X 조회 건수 15(기본값)

[예시]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/templates?useYn=Y&pageNum=1&pageSize=10"

응답

{
    "header": {
        "resultCode": 0,
        "resultMessage": "success",
        "isSuccessful": true
    },
    "body": {
        "pageNum": 1,
        "pageSize": 15,
        "totalCount": 1,
        "data": [
            {
                "templateId": "TEMPLATE",
                "categoryId": 12345,
                "categoryName": "Category",
                "templateName": "Template",
                "templateDesc": "Template",
                "useYn": "Y",
                "delYn": "N",
                "title": "Title",
                "createDate": "2019-01-01 00:00:00.0",
                "updateDate": "2019-01-01 00:00:00.0"
            }
        ]
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- pageNum Integer 현재 페이지 번호
- pageSize Integer 조회된 데이터 건수
- totalCount Integer 총 데이터 건수
- data List 데이터 영역
-- templateId String 템플릿 ID
-- categoryId Integer 카테고리 ID
-- categoryName String 카테고리 명
-- templateName String 템플릿 명
-- templateDesc String 템플릿 설명
-- useYn String 사용여부
-- delYn String 삭제 여부
-- title String 메일 제목
-- createDate String 생성 일시
-- updateDate String 수정 일시

템플릿 상세 조회

요청

[URL]

Http method URI
GET /email/v1.5/appKeys/{appKey}/templates/{templateId}

[Path parameter]

타입 설명
appKey String 고유의 appKey
templateId String 템플릿 ID

[예시]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/templates/{templateId}"

응답

{
    "header": {
        "resultCode": 0,
        "resultMessage": "success",
        "isSuccessful": true
    },
    "body": {
        "data": {
            "templateId": "TEMPLATE",
            "categoryId": 12345,
            "categoryName": "Category",
            "templateName": "Template",
            "templateDesc": "Template",
            "useYn": "Y",
            "delYn": "N",
            "sendMailAddress": "test@nhn.com",
            "title": "Title",
            "templateType": "DEFAULT",
            "body": "Body",
            "createDate": "2019-01-01 00:00:00.0",
            "updateDate": "2019-01-01 00:00:00.0",
            "attachFileList": [
                {
                    "fileType": "TEMPLATE",
                    "fileId": 12345,
                    "fileName": "test.csv",
                    "filePath": "file/path",
                    "fileSize": 10,
                    "createDate": "2019-01-01 00:00:00.0"
                }
            ]
        }
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- data List 데이터 영역
-- templateId String 템플릿 ID
-- categoryId Integer 카테고리 ID
-- categoryName String 카테고리명
-- templateName String 템플릿명
-- templateDesc String 템플릿 설명
-- useYn String 사용여부 (Y= 사용중, N= 사용안함)
-- delYn String 삭제 여부(Y= 삭제, N= 삭제 아님)
-- sendMailAddress String 발신메일주소
-- title String 메일 주소
-- templateType String 템플릿 타입
DEFAULT(기본값), FREEMARKER)
-- body String 메일 내용
-- createDate String 생성 일시
-- updateDate String 수정 일시
-- attachFileList List 첨부파일 리스트
--- fileType String 첨부파일 타입 (MAIL: 메일에 첨부된 파일, TEMPLATE: 템플릿에 첨부된 파일)
--- fileId String 파일 ID
--- fileName String 첨부파일 이름
--- filePath String 첨부파일 경로
--- fileSize Integer 첨부파일 크기 (byte)
--- createDate String 생성 일시

템플릿 등록

요청

[URL]

Http method URI
POST /email/v1.5/appKeys/{appKey}/templates

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Request body]

타입 최대 길이 필수 설명
categoryId Integer - O 카테고리 ID
templateId String 50 O 템플릿 ID
templateName String 200 O 템플릿명
templateDesc String 4000 X 템플릿 설명
useYn String 1 X 사용 여부 Y(기본값), N
sendMailAddress String 300 O 발신 메일 주소
title String 500 O 메일 제목
templateType String 10 X 템플릿 타입
DEFAULT(기본값), FREEMARKER)
body String - O 메일 본문
attachFileIdList List - X 첨부 파일 ID(fileId)
userId String 50 X 사용자 ID

[예시]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/templates -d '{"categoryId":1,"templateId":"TEAMPLTE_ID","templateName":"템플릿 이름","templateDesc":"템플릿 설명","useYn":"Y","sendMailAddress":"test@nhn.com","title":"메일 제목","templateType":"DEFAULT","body":"메일 내용","attachFileIdList":[1,2,3],"userId":"USER"}'

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지

템플릿 첨부 파일 업로드

요청

[URL]

Http method URI
POST /email/v1.5/appKeys/{appKey}/templates/attachfile/binaryUpload

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Request body]

타입 최대 길이 필수 설명
fileName String 100 O 파일이름
fileBody Byte[] - O 파일의 Byte[] 값
userId String 50 X 유저 ID

[예시]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/templates/attachfile/binaryUpload -d '{"fileName":"file.csv","userId":"USER","fileBody":[]}'

응답

{
  "header": {
    "isSuccessful":  true,
    "resultCode": 0,
    "resultMessage": "SUCCESS"
  },
  "body": {
    "data": {
      "fileId": 1,
      "fileName": "file.csv"
    }
  }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- data Object 데이터 영역
-- fileId String 파일 ID
-- fileName String 파일 이름

[주의]

  • 파일을 업로드한 다음 템플릿에 첨부하면, 다른 템플릿에 그 파일을 첨부할 수 없습니다. 첨부된 파일을 수정하거나 새로 업로드한 후 첨부해야 합니다.

템플릿 수정

요청

[URL]

Http method URI
PUT /email/v1.5/appKeys/{appKey}/templates/{templateId}

[Path parameter]

타입 설명
appKey String 고유의 appKey
templateId String 템플릿 ID

[Request body]

타입 최대 길이 필수 설명
templateName String 200 X 템플릿명
templateDesc String 4000 X 템플릿 설명
useYn String 1 X 사용 여부 Y, N
sendMailAddress String 300 X 발신 메일 주소
title String 500 X 메일 제목
templateType String 10 X 템플릿 타입
DEFAULT(기본값), FREEMARKER
body String - X 메일 본문
attachFileIdList List - X 첨부 파일 ID(fileId)
userId String 50 X 사용자 ID

[예시]

curl -X PUT -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/templates/{templateId} -d '{"templateName":"템플릿 이름","templateDesc":"템플릿 설명","useYn":"Y","sendMailAddress":"test@nhn.com","title":"메일 제목","templateType":"DEFAULT","body":"메일 내용","attachFileIdList":[1,2,3],"userId":"USER"}'

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지

템플릿 삭제

요청

[URL]

Http method URI
DELETE /email/v1.5/appKeys/{appKey}/templates/{templateId}

[Path parameter]

타입 설명
appKey String 고유의 appKey
templateId String 템플릿 ID

[예시]

curl -X DELETE -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/templates/{templateId}

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지

태그 관리

태그 조회

요청

[URL]

Http method URI
GET /email/v1.5/appKeys/{appKey}/tags

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Query parameter]

타입 필수 설명
pageNum Integer X 페이지 번호 1(기본값)
pageSize Integer X 조회 건수 15(기본값)

[예시]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/tags?pageNum=1&pageSize=10"

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "pageNum": 1,
        "pageSize": 1,
        "totalCount": 1,
        "data": [
            {
                "tagId": "ABCD1234",
                "tagName": "TAG",
                "createdDate": "2019-01-01 00:00:00",
                "updatedDate": "2019-01-01 00:00:00"
            }
        ]
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- data List 데이터 영역
-- tagId String 태그 ID
-- tagName String 태그 이름
-- createdDate String 생성 일시
-- updatedDate String 수정 일시

태그 등록

요청

[URL]

Http method URI
POST /email/v1.5/appKeys/{appKey}/tags

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Request body]

타입 필수 설명
tagName String O 태그 이름

[예시]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/tags -d '{"tagName":"샘플태그"}'

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "tagId": "ABCD1234"
        }
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- data List 데이터 영역
-- tagId String 태그 ID

태그 수정

요청

[URL]

Http method URI
PUT /email/v1.5/appKeys/{appKey}/tags/{tagId}

[Path parameter]

타입 설명
appKey String 고유의 appKey
tagId String 태그 ID

[Request body]

타입 필수 설명
tagName String O 태그 이름

[예시]

curl -X PUT -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/tags/{tagId} -d '{"tagName":"샘플태그2"}'

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": null
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지

태그 삭제

요청

[URL]

Http method URI
DELETE /email/v1.5/appKeys/{appKey}/tags/{tagId}

[Path parameter]

타입 설명
appKey String 고유의 appKey
tagId String 태그 ID

[예시]

curl -X DELETE -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/tags/{tagId}

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": null
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지

UID 관리

UID 조회

요청

[URL]

Http method URI
GET /email/v1.5/appKeys/{appKey}/uids

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Query parameter]

타입 필수 설명
wheres List:String X 조회 조건.
알파뱃, 숫자, 괄호로 이루어진 문자열 배열.
괄호는 1개, AND, OR은 3개까지 사용할 수 있다.
(예시) tagId1,AND,tagId2
offsetUid String X offset UID
offset Integer X offset 0(기본값)
limit Integer X 조회 건수 15(기본값)

[예시]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/uids?wheres=tagId1,OR,tagId2&offset=0&limit=10"

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "uids": [
                {
                    "uid": "UID",
                    "tags": [
                        {
                            "tagId": "ABCD1234",
                            "tagName": "TAG",
                            "createdDate": "2019-01-01 00:00:00",
                            "updatedDate": "2019-01-01 00:00:00"
                        }
                    ],
                    "contacts": [
                        {
                            "contactType": "EMAIL_ADDRESS",
                            "contact": "test@nhn.com",
                            "createdDate": "2019-01-01 00:00:00"
                        }
                    ]
                }
            ],
            "isLast": false,
            "totalCount": 5
        }
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- data List 데이터 영역
-- uids List UID 목록
--- uid String UID
--- tags List 태그 정보 리스트
---- tagId String 태그 ID
---- tagName String 태그 이름
---- createDate String 태그 생성 일시
---- updateDate String 태그 수정 일시
--- contacts List 연락처 리스트
---- contactType String 연락처 타입 (EMAIL_ADDRESS)
---- contact String 연락처 (메일 주소))
---- createDate String 연락처 생성 일시
-- isLast Boolean 마지막 리스트 여부
-- totalCount Integer 총 데이터 건수

UID 단건 조회

요청

[URL]

Http method URI
GET /email/v1.5/appKeys/{appKey}/uids/{uid}

[Path parameter]

타입 설명
appKey String 고유의 appKey
uid String UID

[예시]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/uids/{uid}"

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": {
            "uid": "UID",
            "tags": [
                {
                    "tagId": "ABCD1234",
                    "tagName": "TAG",
                    "createdDate": "2019-01-01 00:00:00",
                    "updatedDate": "2019-01-01 00:00:00"
                }
            ],
            "contacts": [
                {
                    "contactType": "EMAIL_ADDRESS",
                    "contact": "test@nhn.com",
                    "createdDate": "2019-01-01 00:00:00"
                }
            ]
        }
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- data List 데이터 영역
-- uid String UID
-- tags List 태그 정보 리스트
--- tagId String 태그 ID
--- tagName String 태그 이름
--- createDate String 태그 생성 일시
--- updateDate String 태그 수정 일시
-- contacts List 연락처 리스트
--- contactType String 연락처 타입
--- contact String 연락처 (메일 주소))
--- createDate String 연락처 생성 일시

UID 등록

요청

[URL]

Http method URI
POST /email/v1.5/appKeys/{appKey}/uids

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Request body]

타입 필수 설명
uid String O UID
tagIds List:String O 태그 ID 목록
contacts List O 메일 주소 목록
- contactType String O 연락처 타입
- contact String O 연락처 (메일 주소)

[주의]

  • tagIds가 주어지는 경우 contacts는 필수 값이 아닙니다.
  • contacts가 주어지는 경우 tagIds는 필수 값이 아닙니다.
  • 본 상품의 경우, contactType은 반드시 "EMAIL_ADDRESS" 값으로 요청해야 합니다.

[예시]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/uids -d '{"uids":[{"uid":"sample-uid","tagIds":["tagId1"],"contacts":[{"contactType":"EMAIL_ADDRESS","contact":"customer1@nhn.com"},{"contactType":"EMAIL_ADDRESS","contact":"customer2@nhn.com"}]}]}'

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": null
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지

UID 삭제

요청

[URL]

Http method URI
DELETE /email/v1.5/appKeys/{appKey}/uids/{uid}

[Path parameter]

타입 설명
appKey String 고유의 appKey
uid String UID

[예시]

curl -X DELETE -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/uids/{uid}

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": null
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지

메일 주소 등록

요청

[URL]

Http method URI
POST /email/v1.5/appKeys/{appKey}/uids/{uid}/email-addresses

[Path parameter]

타입 설명
appKey String 고유의 appKey
uid String UID

[Request body]

타입 필수 설명
emailAddress String O 메일 주소

[예시]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/uids/{uid}/email-addresses -d '{"emailAddress" : "customer1@nhn.com"}'

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": null
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지

메일 주소 삭제

요청

[URL]

Http method URI
DELETE /email/v1.5/appKeys/{appKey}/uids/{uid}/email-addresses/{emailAddress}

[Path parameter]

타입 설명
appKey String 고유의 appKey
uid String UID
emailAddress String 메일 주소

[예시]

curl -X DELETE -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/uids/{uid}/email-addresses/customer1@nhn.com

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": null
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지

통계 조회

통합 통계 조회

요청

[URL]

Http method URI
GET /email/v1.5/appKeys/{appKey}/statistics/view

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Query parameter]

타입 필수 설명
from String O 통계 조회 시작 날짜
yyyy-mm-dd HH:mm
to String O 통계 조회 종료 날짜
yyyy-mm-dd HH:mm
searchType String O 통계 구분
DATE:날짜별, TIME:시간별, DAY:요일별
mailTypes String X 메일 타입
NORMAL:일반, MASS:대량
복수 입력 가능(mailTypes=NORMAL&mailTypes=MASS)
adYn String X 광고 여부
Y:광고, N:광고 아님
입력하지 않으면 전체
templateId String X 템플릿 ID

[예시]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/statistics/view?from=2018-03-21+00%3A00&to=2018-03-23+00%3A00&searchType=DATE&mailTypes=NORMAL&adYn=Y&templateId=templateId1"

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "data": [
            {
                "divisionName": "Tue",
                "requestedCount": 1,
                "sentCount": 1,
                "receivedCount": 1,
                "openedCount": 0,
                "sentRate": "100.00",
                "receivedRate": "100.00",
                "openedRate": "0.00"
            }
        ]
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- data List 데이터 영역
-- divisionName String 통계 기준(날짜/시간/요일)
-- requestedCount Long 발송 요청 카운트
-- sentCount Long 발송 카운트
-- receivedCount Long 수신 카운트
-- openedCount Long 오픈 카운트
-- sentRate String 발송율
-- receivedRate String 수신율
-- openedRate String 오픈율

수신 거부 관리

수신 거부 조회

요청

[URL]

Http method URI
GET /email/v1.5/appKeys/{appKey}/block-receivers

[Path parameter]

타입 설명
appKey String 고유의 appKey

[Query parameter]

타입 필수 설명
mailAddress String X 수신거부 목록에 등록되어 있는 이메일 주소
pageNum Integer X 페이지 번호 1(기본값)
pageSize Integer X 조회 건수 15(기본값)

[예시]

curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/block-receivers?mailAddress=customer1@nhn.com&pageNum=1&pageSize=10"

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": {
        "totalCount": 1,
        "data": [
            {
                "mailAddress": "block@nhn.com",
                "blockDate": "2019-01-01 00:00:00.0"
            }
        ]
    }
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
body Object 본문 영역
- pageNum Integer 현재 페이지 번호
-pageSize Integer 조회된 데이터 건수
- totalCount Integer 총 데이터 건수
- data List 데이터 영역
-- mailAddress String 수신거부 이메일 주소
-- blockDate String 수신거부 날짜 (yyyy-MM-dd HH:mm:ss.S)

수신 거부 등록

요청

[URL]

Http method URI
POST /email/v1.5/appKeys/{appKey}/block-receivers

[Request body]

타입 필수 설명
blockReceiverList ㅣList O 수신거부 리스트
- mailAddress String O 수신거부 이메일 주소
- blockDate String X 수신 거부 날짜 (yyyy-MM-dd HH:mm:ss)

[예시]

curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/block-receivers -d '{"blockReceiverList":[{"mailAddress":"customer1@nhn.com","blockDate":"2018-03-01 00:00:00"}]}'

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": null
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지

수신 거부 삭제

요청

[URL]

Http method URI
PUT /email/v1.5/appKeys/{appKey}/block-receivers

[Request body]

타입 필수 설명
deleted Boolean O 수신 거부 삭제를 명시하는 필드
blockReceiverList ㅣList O 수신거부 리스트
- mailAddress String O 수신거부 이메일 주소

[예시]

curl -X PUT -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.5/appKeys/{appKey}/block-receivers -d '{"deleted":true,"blockReceiverList":[{"mailAddress":"customer1@nhn.com"}]}'

응답

{
    "header": {
        "isSuccessful": true,
        "resultCode": 0,
        "resultMessage": "SUCCESS"
    },
    "body": null
}
타입 설명
header Object 헤더 영역
- isSuccessful Boolean 성공 여부
- resultCode Integer 실패 코드
- resultMessage String 실패 메시지
TOP