[API 도메인]
환경 | 도메인 |
---|---|
Real | https://api-mail.cloud.toast.com |
[Header]
Content-Type: application/json;charset=UTF-8
[curl 예시 주의 사항]
[URL]
Http method | URI |
---|---|
POST | /email/v1.2/appKeys/{appKey}/sender/mail |
[Path parameter]
값 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 appKey |
[Request body]
값 | 타입 | 필수 | 설명 |
---|---|---|---|
senderAddress | String | O | 발신자 메일 |
senderName | String | X | 발신자 이름 |
requestDate | String | X | 발송 일자 미입력시 : 현재 시간으로 발송 (yyyy-MM-dd HH:mm:ss) |
title | String | O | 제목 |
body | String | O | 내용 |
attachFileIdList | List:Integer | X | 업로드한 첨부파일 id |
templateId | String | X | 발송 템플릿 아이디 |
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 | 사용자 지정 헤더 |
userId | String | X | 발송 구분자 ex)admin,system |
[주의]
[예시 1]
curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.2/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"}],"customHeaders":{"X-Sample":"sample","Content-Type":"text/html; charset=utf-8"},"userId":"XXXXX"}'
[예시 2 - 템플릿 사용]
curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.2/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"}],"customHeaders":{"X-Sample":"sample","Content-Type":"text/html; charset=utf-8"},"userId":"XXXXX"}'
{
"header": {
"isSuccessful":boolean,
"resultCode":Integer,
"resultMessage":String
},
"body": {
"data": {
"requestId":String,
"statusCode":String
}
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
body | Object | 본문 영역 |
- data | Object | 데이터 영역 |
-- requestId | String | 요청 아이디 |
-- statusCode | String | 요청 상태 코드 (Y: 발송준비 , N : 발송준비실패) |
[URL]
Http method | URI |
---|---|
POST | /email/v1.2/appKeys/{appKey}/sender/eachMail |
[Path parameter]
값 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 appKey |
[Request body]
값 | 타입 | 필수 | 설명 |
---|---|---|---|
senderAddress | String | O | 발신자 메일 |
senderName | String | X | 발신자 이름 |
requestDate | String | X | 발송 일자, 미입력시 : 현재 시간으로 발송 (yyyy-MM-dd HH:mm:ss) |
title | String | O | 제목 |
body | String | O | 내용 |
attachFileIdList | List:Integer | X | 업로드한 첨부파일 id |
templateId | String | X | 발송 템플릿 아이디 |
receiverList | List | O | 수신자 리스트 최대 1000명까지 발송 가능 |
- receiveMailAddr | String | O | 수신자 메일주소 |
- receiveName | String | X | 수신자 명 |
- templateParameter | Object | X | 치환 파라미터 (메일 제목/내용 치환시 입력) |
-- #key# | String | X | 치환 키 (##key##) |
-- #value# | Object | X | 치환 키에 매핑되는 Value값 |
customHeaders | Map | X | 사용자 지정 헤더 |
userId | String | X | 발송 구분자 ex)admin,system |
[주의]
[예시 1]
curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/sender/eachMail -d '{"senderAddress":"support@nhn.com","senderName":"발송자이름","title":"샘플 타이틀","body":"샘플 내용","attachFileIdList":[1, 2],"receiverList":[{"receiveMailAddr":"customer1@nhn.com","receiveName":"고객1"}],"customHeaders":{"X-Sample":"sample","Content-Type":"text/html; charset=utf-8"},"userId":"XXXXX"}'
[예시 2 - 템플릿 사용]
curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/sender/mail -d '{"templateId":"TEMPLATE1","receiverList":[{"receiveMailAddr":"customer1@nhn.com","receiveName":"고객1","templateParameter":{"key":"value"}}],"customHeaders":{"X-Sample":"sample","Content-Type":"text/html; charset=utf-8"},"userId":"XXXXX"}'
{
"header": {
"isSuccessful":boolean,
"resultCode":Integer,
"resultMessage":String
},
"body": {
"data": {
"requestId":String,
"statusCode":String
}
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
body | Object | 본문 영역 |
- data | Object | 데이터 영역 |
-- requestId | String | 요청 아이디 |
-- statusCode | String | 요청 상태 코드 (Y: 발송준비 , N : 발송준비실패) |
[URL]
Http method | URI |
---|---|
POST | /email/v1.2/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.2/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"}],"customHeaders":{"X-Sample":"sample","Content-Type":"text/html; charset=utf-8"},"userId":"XXXXX"}'
[예시 2 - 템플릿 사용]
curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.2/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"}],"customHeaders":{"X-Sample":"sample","Content-Type":"text/html; charset=utf-8"},"userId":"XXXXX"}'
[URL]
Http method | URI |
---|---|
POST | /email/v1.2/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.2/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"}],"customHeaders":{"X-Sample":"sample","Content-Type":"text/html; charset=utf-8"},"userId":"XXXXX"}'
[예시 2 - 템플릿 사용]
curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/sender/ad-eachMail -d '{"templateId":"TEMPLATE1","receiverList":[{"receiveMailAddr":"customer1@nhn.com","receiveName":"고객1","templateParameter":{"key":"value"}}],"customHeaders":{"X-Sample":"sample","Content-Type":"text/html; charset=utf-8"},"userId":"XXXXX"}'
[URL]
Http method | URI |
---|---|
POST | /email/v1.2/appKeys/{appKey}/sender/auth-mail |
[Path parameter]
값 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 appKey |
[Request body]
값 | 타입 | 필수 | 설명 |
---|---|---|---|
senderAddress | String | O | 발신자 메일 |
senderName | String | X | 발신자 이름 |
requestDate | String | X | 발송 일자, 미입력시 : 현재 시간으로 발송 (yyyy-MM-dd HH:mm:ss) |
title | String | O | 제목 |
body | String | O | 내용 |
templateId | String | X | 발송 템플릿 아이디 |
receiver | Object | O | 수신자 |
- receiveMailAddr | String | O | 수신자 메일주소 |
- receiveName | String | X | 수신자 명 |
- templateParameter | Object | X | 치환 파라미터 (메일 제목/내용 치환시 입력) |
-- #key# | String | X | 치환 키 (##key##) |
-- #value# | Object | X | 치환 키에 매핑되는 Value값 |
customHeaders | Map | X | 사용자 지정 헤더 |
userId | String | X | 발송 구분자 ex)admin,system |
[주의]
인증 메일 성격상 다음과 같이 다른 특성들이 있습니다.
[예시 1]
curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/sender/auth-mail -d '{"senderAddress":"support@nhn.com","senderName":"발송자이름","title":"샘플 타이틀","body":"샘플 내용","receiver":{"receiveMailAddr":"customer1@nhn.com","receiveName":"고객1"},"customHeaders":{"X-Sample":"sample","Content-Type":"text/html; charset=utf-8"},"userId":"XXXXX"}'
[예시 2 - 템플릿 사용]
curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/sender/auth-mail -d '{"templateId":"TEMPLATE1","receiver":{"receiveMailAddr":"customer1@nhn.com","receiveName":"고객1","templateParameter":{"key":"value"}},"customHeaders":{"X-Sample":"sample","Content-Type":"text/html; charset=utf-8"},"userId":"XXXXX"}'
{
"header": {
"isSuccessful":boolean,
"resultCode":Integer,
"resultMessage":String
},
"body": {
"data": {
"requestId":String,
"statusCode":String
}
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
body | Object | 본문 영역 |
- data | Object | 데이터 영역 |
-- requestId | String | 요청 아이디 |
-- statusCode | String | 요청 상태 코드 (Y: 발송준비 , N : 발송준비실패) |
[URL]
Http method | URI |
---|---|
POST | /email/v1.2/appKeys/{appKey}/sender/tagMail |
[Path parameter]
값 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 appKey |
[Request body]
{
"senderAddress": String,
"senderName": String,
"requestDate": String,
"title": String,
"body": String,
"templateId": String,
"adYn": String,
"autoSendYn": String,
"attachFileIdList": List:String,
"tagExpression": List:String,
"userId": String
}
값 | 타입 | 필수 | 설명 |
---|---|---|---|
senderAddress | String | O | 발신자 주소 |
senderName | String | X | 발신자명 |
requestDate | String | X | 발송 일자 미입력시 : 현재 시간으로 발송 (yyyy-MM-dd HH:mm:ss) |
title | String | O | 제목 |
body | String | O | 내용 |
templateId | String | X | 템플릿 아이디 |
adYn | String | X | 광고 여부 (default 'N') |
autoSendYn | String | X | 자동 발송 여부 (default 'Y') |
attachFileIdList | List:Integer | X | 첨부파일 리스트 |
tagExpression | List:String | O | 태그 표현식 |
customHeaders | Map | X | 사용자 지정 헤더 |
userId | String | X | 발송 구분자 ex)admin,system |
[주의]
[예시 1]
curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/sender/tagMail -d '{"senderAddress":"support@nhn.com","senderName":"발송자이름","title":"샘플 타이틀","body":"샘플 내용","attachFileIdList":[1, 2],"tagExpression":["tag1","AND","tag2"],"customHeaders":{"X-Sample":"sample","Content-Type":"text/html; charset=utf-8"},"userId":"XXXXX"}'
[예시 2 - 템플릿 사용]
curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/sender/tagMail -d '{"templateId":"TEMPLATE1","tagExpression":["tag1","AND","tag2"],"customHeaders":{"X-Sample":"sample","Content-Type":"text/html; charset=utf-8"},"userId":"XXXXX"}'
{
"header": {
"isSuccessful":boolean,
"resultCode":Integer,
"resultMessage":String
},
"body": {
"data": {
"requestId":String
}
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
body | Object | 본문 영역 |
- data | Object | 데이터 영역 |
-- requestId | String | 요청 아이디 |
[URL]
Http method | URI |
---|---|
POST | /email/v1.2/appKeys/{appKey}/attachfile/binaryUpload |
[Path parameter]
값 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 appKey |
[Request body]
{
"fileName": String,
"createUser": String,
"fileBody": Byte[]
}
값 | 타입 | 필수 | 설명 |
---|---|---|---|
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.2/appKeys/{appKey}/attachfile/binaryUpload -d '{"fileName":"file.csv","createUser":"XXXXX","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 | 파일명 |
* title : ##title_name## 님 안녕하세요 !!
* body : ##body_content## 발송 합니다.
{
"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"
}
* title : 클라우드고객1 님 안녕하세요!!
* body : test2 발송 합니다.
[URL]
Http method | URI |
---|---|
GET | /email/v1.2/appKeys/{appKey}/sender/mails |
[Path parameter]
값 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 appKey |
[Query parameter]
값 | 타입 | 필수 | 설명 |
---|---|---|---|
requestId | String | O | 요청 아이디 |
startSendDate | String | O | 발송 날짜 시작 값(yyyy-MM-dd HH:mm:ss) |
endSendDate | String | X | 발송 날짜 종료 값(yyyy-MM-dd HH:mm:ss) |
startReceiveDate | String | X | 수신 날짜 시작 값(yyyy-MM-dd HH:mm:ss) |
endReceiveDate | String | X | 수신 날짜 종료 값(yyyy-MM-dd HH:mm:ss) |
senderMail | String | X | 발신메일 주소 |
senderName | String | X | 발신자 이름 |
receiveMail | String | X | 수신메일 주소 |
templateId | String | X | 템플릿번호 |
sendStatus | String | X | 발송상태 코드 SST0:발송준비, SST1:발송중, SST2:발송완료, SST3 : 발송실패 |
pageNum | Integer | X | 페이지 번호(Default : 1) |
pageSize | Integer | X | 조회 건수(Default : 15) |
[예시]
curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/sender/mails?startSendDate=2018-03-01+00%3A00&endSendDate=2018-03-07+23%3A59&pageSize=10"
{
"header": {
"isSuccessful": boolean,
"resultCode": Integer,
"resultMessage": String
},
"body": {
"pageNum": Integer,
"pageSize": Integer,
"totalCount": Integer,
"data": [{
"requestId": String,
"requestIp": String,
"templateId": String,
"templateName": String,
"masterStatusCode": String,
"mailSeq": String,
"senderName": String,
"senderMail": String,
"title": String,
"body": String,
"resultId": String,
"resultDate": String,
"mailStatusCode": String,
"mailStatusName": String,
"requestDate": String,
"receiverMail": String,
"receiveType": String
}]
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
body | Object | 본문 영역 |
- pageNum | Integer | 현재 페이지 번호 |
-pageSize | Integer | 조회된 데이터 건수 |
- totalCount | Integer | 총 데이터 건수 |
- data | List | 데이터 영역 |
-- requestId | String | 요청 아이디 |
-- requestDate | String | 발신일시 |
-- requestIp | String | 발신서버 IP |
-- resultDate | String | 수신일시 |
-- templateId | String | 템플릿아이디 |
-- templateName | String | 템플릿명 |
-- masterStatusCode | String | 메일 발송 준비 상태코드 ( "Y" : 발송준비 , "N" : 발송실패) |
-- mailSeq | String | 메일 순번 |
-- body | String | 본문내용 |
-- title | String | 메일 제목 |
-- senderMail | String | 발신자 메일주소 |
-- senderName | String | 발신자 이름 |
-- receiverMail | String | 수신자 메일주소 |
-- receiveType | String | 수신자 타입 (MRT0 : 받는사람 , MRT1 : 참조, MRT2 : 숨은참조) |
-- resultId | String | 발송결과 ID |
-- resultDate | String | 발송 완료 일시 |
-- mailStatusCode | String | 발송상태 코드 SST0:발송준비, SST1:발송중, SST2:발송완료, SST3 : 발송실패 |
-- mailStatusName | String | 발송상태명 |
-- requestDate | String | 발송 요청일시 |
[URL]
Http method | URI |
---|---|
GET | /email/v1.2/appKeys/{appKey}/sender/mail/{requestId}/{mailSeq} |
[Path parameter]
값 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 appKey |
requestId | String | 요청아이디 |
mailSeq | Integer | 메일 순번 |
[예시]
curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/sender/mail/{requestId}/{mailSeq}"
{
"header": {
"isSuccessful": boolean,
"resultCode": Integer,
"resultMessage": String
},
"body": {
"data": {
"requestId": String,
"requestIp": String,
"requestDate": String,
"masterStatusCode": String,
"mailStatusCode": String,
"mailStatusName": String,
"templateId": String,
"templateName": String,
"senderName": String,
"senderMail": String,
"title": String,
"body": String,
"attachFileYn": String,
"resultId": String,
"resultDate": String,
"receivers": [{
"requestId": String,
"mailSequence": Integer,
"receiveType": String,
"receiveTypeName": String,
"receiveName": String,
"receiveMailAddr": String,
"readYn": String,
"readDate": String
}],
"attachFileList": [{
"fileType": String,
"fileId": Integer,
"fileName": String,
"filePath": String,
"fileSize": Integer,
"createDate": String
}],
"customHeaders": Map
}
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
body | Object | 본문 영역 |
- data | Object | 데이터 영역 |
-- mailStatusCode | String | 발송상태 |
-- mailStatusName | String | 발송상태명 |
-- templateId | String | 템플릿ID |
-- templateName | String | 템플릿 명 |
-- senderName | String | 발신자 이름 |
-- senderMail | String | 발신 메일주소 |
-- title | String | 메일 제목 |
-- body | String | 메일 내용 |
-- attachFileYn | String | 첨부파일 여부 |
-- resultId | String | 메일 발송 ID |
-- resultDate | String | 발송완료일시 |
-- receivers | List | 수신자 리스트 |
--- requestId | String | 요청ID |
--- mailSequence | Integer | 메일 순번 |
--- receiveType | String | 수신자 타입 |
--- receiveTypeName | String | 수신자 타입명 |
--- receiveName | String | 수신자 이름 |
--- receiveMailAddr | String | 수신 메일 주소 |
--- readYn | String | 수신 여부 |
--- readDate | String | 수신 날짜(yyyy-MM-dd HH:mm:ss.SSS) |
-- 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.2/appKeys/{appKey}/tagMails |
[Path parameter]
값 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 appKey |
[Query parameter]
값 | 타입 | 필수 | 설명 |
---|---|---|---|
requestId | String | O | 요청 아이디 |
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 | 페이지 번호(Default : 1) |
pageSize | Integer | X | 조회 건수(Default : 15) |
[주의]
[예시]
curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/tagMails?startSendDate=2018-03-01+00%3A00&endSendDate=2018-03-07+23%3A59&pageSize=10"
{
"header": {
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
},
"body": {
"pageNum": Integer,
"pageSize": Integer,
"totalCount": Integer,
"data": [
{
"requestId": String,
"requestIp": String,
"requestDate": String,
"tagSendStatus": String,
"tagExpression": List:String,
"templateId": String,
"templateName": String,
"senderName": String,
"senderMailAddress": String,
"title": String,
"body": String,
"attachYn": String,
"adYn": String,
"createUser": String,
"createDate": String,
"updateUser": String,
"updateDate": String
}
]
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
body | Object | 본문 영역 |
- pageNum | Integer | 현재 페이지 번호 |
-pageSize | Integer | 조회된 데이터 건수 |
- totalCount | Integer | 총 데이터 건수 |
- data | List | 데이터 영역 |
-- requestId | String | 요청 아이디 |
-- requestIp | String | 요청 아이피 |
-- requestDate | String | 요청 시간 |
-- tagSendStatus | String | 발송상태 코드 WAIT: 대기, READY: 발송준비, SENDREADY: 발송준비완료, SENDWAIT: 발송대기, SENDING: 발송중, COMPLETE: 발송완료, FAIL: 발송실패, CANCEL: 발송취소 |
-- tagExpression | List:String | 태그 표현식 |
-- templateId | String | 템플릿 아이디 |
-- 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.2/appKeys/{appKey}/tagMails/{requestId} |
[Path parameter]
값 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 appKey |
requestId | String | 요청 아이디 |
[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 | 페이지 번호(Default : 1) |
pageSize | Integer | X | 조회 건수(Default : 15) |
[예시]
curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/tagMails/{requestId}?startReceiveDate=2018-03-01+00%3A00&endReceiveDate=2018-03-07+23%3A59&pageSize=10"
{
"header": {
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
},
"body": {
"pageNum": Integer,
"pageSize": Integer,
"totalCount": Integer,
"data": [
{
"requestId": String,
"mailSequence": Integer,
"receiveMail": String,
"mailStatusCode": String,
"mailStatusName": String,
"resultId": String,
"resultDate": String,
"readYn": String,
"readDate": String,
"createUser": String,
"createDate": String,
"updateUser": String,
"updateDate": String
}
]
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
body | Object | 본문 영역 |
- pageNum | Integer | 현재 페이지 번호 |
-pageSize | Integer | 조회된 데이터 건수 |
- totalCount | Integer | 총 데이터 건수 |
- data | List | 데이터 영역 |
-- requestId | String | 요청 아이디 |
-- 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.2/appKeys/{appKey}/tagMails/{requestId}/{mailSequence} |
[Path parameter]
값 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 appKey |
requestId | String | 요청 아이디 |
mailSequence | Integer | 메일 순번 |
[예시]
curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/tagMails/{requestId}/{mailSequence}"
{
"header": {
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
},
"body": {
"data": {
"requestId": String,
"requestIp": String,
"templateId": String,
"templateName": String,
"mailStatusCode": String,
"mailStatusName": String,
"requestDate": String,
"resultDate": String,
"senderName": String,
"senderMail": String",
"resultId": String,
"title": String,
"body": String",
"receivers": [
{
"requestId": String
"mailSequence": String
"receiveType": String
"receiveTypeName": String
"receiveMailAddr": String
"readYn": String
"readDate": String
}
],
"attachFileList": [
{
"fileType": String,
"fileId": Integer
"fileName": String,
"filePath": String,
"fileSize": Integer,
"createDate": String
}
],
"customHeaders": Map
}
}
}
값 | 타입 | 설명 |
---|---|---|
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 | 요청 아이디 |
--- 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.2/appKeys/{appKey}/templates |
[Path parameter]
값 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 appKey |
[Query parameter]
값 | 타입 | 필수 | 설명 |
---|---|---|---|
categoryId | Integer | X | 카테고리 아이디 |
useYn | String | X | 사용 여부(Y/N) |
pageNum | Integer | X | 페이지 번호(Default : 1) |
pageSize | Integer | X | 조회 건수(Default : 15) |
all | Boolean | X | 전체 템플릿 목록 조회 여부 |
[예시]
curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/templates?useYn=Y&pageNum=1&pageSize=10"
{
"header": {
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
},
"body": {
"pageNum": Integer,
"pageSize": Integer,
"totalCount": Integer,
"data": [{
"templateId": String,
"serviceId": Integer,
"categoryId": Integer,
"categoryName": String,
"sort": Integer,
"templateName": String,
"templateDesc": String,
"useYn": String,
"sendMailAddress": String,
"sendType": String,
"sendTypeName": String,
"title": String,
"body": String,
"attachFileYn": String,
"delYn": String,
"createDate": String,
"createUser": String,
"updateDate": String,
"updateUser": String,
}]
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
body | Object | 본문 영역 |
- pageNum | Integer | 현재 페이지 번호 |
-pageSize | Integer | 조회된 데이터 건수 |
- totalCount | Integer | 총 데이터 건수 |
-data | List | 데이터 영역 |
--templateId | String | 템플릿 ID |
--serviceId | Integer | 서비스 ID |
--categoryId | Integer | 카테고리 ID |
--categoryName | String | 카테고리 명 |
--sort | Integer | 순서 |
--templateName | String | 템플릿 명 |
--templateDesc | String | 템플릿 설명 |
-- useYn | String | 사용여부 |
--sendMailAddress | String | 템플릿 발신메일주소 |
--title | String | 메일 제목 |
--body | String | 메일 본문 |
--attachFileYn | String | 템플릿 첨부파일 추가여부 |
--delYn | String | 삭제 여부 |
--createDate | String | 생성일시 |
--updateDate | String | 수정일시 |
[URL]
Http method | URI |
---|---|
GET | /email/v1.2/appKeys/{appKey}/templates/{templateId} |
[Path parameter]
값 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 appKey |
templateId | String | 템플릿 아이디 |
[예시]
curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/templates/{templateId}"
{
"header": {
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
},
"body": {
"data": [{
"templateId": String,
"serviceId": Integer,
"categoryId": Integer,
"categoryName": String,
"templateName": String,
"templateDesc": String,
"useYn": String,
"sendMailAddress": String,
"title": String,
"body": String,
"delYn": String,
"createDate": String,
"createUser": String,
"updateDate": String,
"updateUser": String,
"attachFileList": [{
"fileId": Integer,
"serviceId" : Integer,
"templateId": String,
"filePath": String,
"fileName": String,
"fileSize" : Integer,
"createDate": String,
"createUser": String,
"updateDate" : String,
"updateUser" : String
}]
}]
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
body | Object | 본문 영역 |
-data | List | 데이터 영역 |
--templateId | String | 템플릿ID |
--serviceId | Integer | 서비스ID |
--categoryId | Integer | 카테고리ID |
--categoryName | String | 카테고리명 |
--templateName | String | 템플릿명 |
--templateDesc | String | 템플릿 설명 |
--useYn | String | 사용여부 (Y= 사용중, N= 사용안함) |
--sendMailAddress | String | 발신메일주소 |
--title | String | 메일 주소 |
--body | String | 메일 내용 |
--delYn | String | 삭제여부 |
--createDate | String | 생성일시 |
--createUser | String | 생성자 |
--updateDate | String | 수정일시 |
--updateUser | String | 수정자 |
--attachFileList | List | 첨부파일 리스트 |
---fileId | Integer | 첨부파일ID |
---serviceId | Integer | 서비스 ID |
---templateId | String | 템플릿 ID |
---filePath | String | 첨부파일 경로 |
---fileName | String | 첨부파일명 |
---fileSize | Integer | 첨부파일 크기 |
---createDate | String | 생성일시 |
---createUser | String | 생성자 |
---updateDate | String | 수정일시 |
---updateUser | String | 수정자 |
[URL]
Http method | URI |
---|---|
GET | /email/v1.2/appKeys/{appKey}/tags |
[Path parameter]
값 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 appKey |
[Query parameter]
값 | 타입 | 필수 | 설명 |
---|---|---|---|
pageNum | Integer | X | 페이지 번호(Default : 1) |
pageSize | Integer | X | 조회 건수(Default : 15) |
[예시]
curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/tags?pageNum=1&pageSize=10"
{
"header": {
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
},
"body": {
"pageNum": Integer,
"pageSize": Integer,
"totalCount": Integer,
"data": [
{
"tagId": String,
"tagName": String,
"createdDate": String,
"updatedDate": String
}
]
}
}
값 | 타입 | 설명 |
---|---|---|
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.2/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.2/appKeys/{appKey}/tags -d '{"tagName":"샘플태그"}'
{
"header": {
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
},
"body": {
"data": {
"tagId": String
}
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
body | Object | 본문 영역 |
- data | List | 데이터 영역 |
-- tagId | String | 태그 ID |
[URL]
Http method | URI |
---|---|
PUT | /email/v1.2/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.2/appKeys/{appKey}/tags/{tagId} -d '{"tagName":"샘플태그2"}'
{
"header": {
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
[URL]
Http method | URI |
---|---|
DELETE | /email/v1.2/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.2/appKeys/{appKey}/tags/{tagId}
{
"header": {
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
[URL]
Http method | URI |
---|---|
GET | /email/v1.2/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(Default : 0) |
limit | Integer | X | 조회 건수(Default : 15) |
[예시]
curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/uids?wheres=tagId1,OR,tagId2&offset=0&limit=10"
{
"header": {
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
},
"body": {
"data": {
"uids": [
{
"uid": String,
"tags": [
{
"tagId": String,
"tagName": String,
"createDate": String,
"updateDate": String
}
],
"contacts": [
{
"contactType": String,
"contact": String,
"createDate": String"
}
]
}
],
"isLast": Boolean,
"totalCount": Integer
}
}
}
값 | 타입 | 설명 |
---|---|---|
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 | 총 데이터 건수 |
[URL]
Http method | URI |
---|---|
GET | /email/v1.2/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.2/appKeys/{appKey}/uids/{uid}"
{
"header": {
"isSuccessful": String,
"resultCode": Integer,
"resultMessage": String
},
"body": {
"data": {
"uid": "",
"tags": [
{
"tagId": String,
"tagName": String,
"createDate": String,
"updateDate": String
}
],
"contacts": [
{
"contactType": String,
"contact": String,
"createDate": String
}
]
}
}
}
값 | 타입 | 설명 |
---|---|---|
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 | 연락처 생성일시 |
[URL]
Http method | URI |
---|---|
POST | /email/v1.2/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 | 연락처 (메일 주소) |
[주의]
[예시]
curl -X POST -H "Content-Type: application/json;charset=UTF-8" https://api-mail.cloud.toast.com/email/v1.2/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": Boolean,
"resultCode": Integer,
"resultMessage": String
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
[URL]
Http method | URI |
---|---|
DELETE | /email/v1.2/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.2/appKeys/{appKey}/uids/{uid}
{
"header": {
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
[URL]
Http method | URI |
---|---|
POST | /email/v1.2/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.2/appKeys/{appKey}/uids/{uid}/email-addresses -d '{"emailAddress" : "customer1@nhn.com"}'
{
"header": {
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
[URL]
Http method | URI |
---|---|
DELETE | /email/v1.2/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.2/appKeys/{appKey}/uids/{uid}/email-addresses/customer1@nhn.com
{
"header": {
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
[URL]
Http method | URI |
---|---|
GET | /email/v1.2/appKeys/{appKey}/statistics/daily |
[Path parameter]
값 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 appKey |
[Query parameter]
값 | 타입 | 필수 | 설명 |
---|---|---|---|
from | String | O | 통계 조회 시작 날짜(년-월-일) (yyyy-MM-dd) |
to | String | O | 통계 조회 종료 날짜(년-월-일) (yyyy-MM-dd) |
type | String | X | 조회 타입 REQUEST:요청 SENT:발송 RECEIVED :수신 OPENED:오픈 |
filters | String | X | 검색 조건(다중 파라미터 가능) MAILTYPE:메일타입별(일반/대량) 통계 TEMPLATE:템플릿별 통계 |
[예시]
curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/statistics/daily?from=2018-03-01&to=2018-03-07&type=OPENED&filters=MAILTYPE&filters=TEMPLATE"
{
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
},
"body" : {
"data" : [
{
"ymd" : String,
"appKey" : String,
"type" : String,
"mailType" : String,
"templateId" : String,
"templateName" : String,
"tm00" : int,
"tm01" : int,
"tm02" : int,
"tm03" : int,
"tm04" : int,
"tm05" : int,
"tm06" : int,
"tm07" : int,
"tm08" : int,
"tm09" : int,
"tm10" : int,
"tm11" : int,
"tm12" : int,
"tm13" : int,
"tm14" : int,
"tm15" : int,
"tm16" : int,
"tm17" : int,
"tm18" : int,
"tm19" : int,
"tm20" : int,
"tm21" : int,
"tm22" : int,
"tm23" : int,
"sum" : int
}
]
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
body | Object | 본문 영역 |
- data | List | 데이터 영역 |
-- ymd | String | 통계 날짜(yyyyMMdd) |
-- appKey | String | appKey |
-- type | String | 통계 조회 타입 REQUEST:요청 SENT:발송 RECEIVED:수신 OPENED:오픈 |
-- mailType | String | 메일 타입 MAILTYPE:메일타입별(일반/대량) 통계 TEMPLATE:템플릿별 통계 |
-- templateId | String | 템플릿아이디 |
-- templateName | String | 템플릿명 |
-- tm00 | int | 00:00:00 ~ 00:59:59 |
-- tm01 | int | 01:00:00 ~ 01:59:59 |
-- tm02 | int | 02:00:00 ~ 02:59:59 |
-- tm03 | int | 03:00:00 ~ 03:59:59 |
-- tm04 | int | 04:00:00 ~ 04:59:59 |
-- tm05 | int | 05:00:00 ~ 05:59:59 |
-- tm06 | int | 06:00:00 ~ 06:59:59 |
-- tm07 | int | 07:00:00 ~ 07:59:59 |
-- tm08 | int | 08:00:00 ~ 08:59:59 |
-- tm09 | int | 09:00:00 ~ 09:59:59 |
-- tm10 | int | 10:00:00 ~ 10:59:59 |
-- tm11 | int | 11:00:00 ~ 11:59:59 |
-- tm12 | int | 12:00:00 ~ 12:59:59 |
-- tm13 | int | 13:00:00 ~ 13:59:59 |
-- tm14 | int | 14:00:00 ~ 14:59:59 |
-- tm15 | int | 15:00:00 ~ 15:59:59 |
-- tm16 | int | 16:00:00 ~ 16:59:59 |
-- tm17 | int | 17:00:00 ~ 17:59:59 |
-- tm18 | int | 18:00:00 ~ 18:59:59 |
-- tm19 | int | 19:00:00 ~ 19:59:59 |
-- tm20 | int | 20:00:00 ~ 20:59:59 |
-- tm21 | int | 21:00:00 ~ 21:59:59 |
-- tm22 | int | 22:00:00 ~ 22:59:59 |
-- tm23 | int | 23:00:00 ~ 23:59:59 |
-- sum | int | 합계 |
[URL]
Http method | URI |
---|---|
GET | /email/v1.2/appKeys/{appKey}/statistics/monthly |
[Path parameter]
값 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 appKey |
[Query parameter]
값 | 타입 | 필수 | 설명 |
---|---|---|---|
from | String | O | 통계 조회 시작 날짜(년-월) (yyyy-MM) |
to | String | O | 통계 조회 종료 날짜(년-월) (yyyy-MM) |
type | String | X | 조회 타입 REQUEST:요청 SENT:발송 RECEIVED :수신 OPENED:오픈 |
filters | String | X | 검색 조건(다중 파라미터 가능) MAILTYPE:메일타입별(일반/대량) 통계 TEMPLATE:템플릿별 통계 |
[예시]
curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/statistics/monthly?from=2018-03&to=2018-04&type=OPENED&filters=MAILTYPE&filters=TEMPLATE"
{
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
},
"body" : {
"data" : [
{
"ymd" : String,
"appKey" : String,
"type" : String,
"mailType" : String,
"templateId" : String,
"templateName" : String,
"tm00" : int,
"tm01" : int,
"tm02" : int,
"tm03" : int,
"tm04" : int,
"tm05" : int,
"tm06" : int,
"tm07" : int,
"tm08" : int,
"tm09" : int,
"tm10" : int,
"tm11" : int,
"tm12" : int,
"tm13" : int,
"tm14" : int,
"tm15" : int,
"tm16" : int,
"tm17" : int,
"tm18" : int,
"tm19" : int,
"tm20" : int,
"tm21" : int,
"tm22" : int,
"tm23" : int,
"sum" : int
}
]
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
body | Object | 본문 영역 |
- data | List | 데이터 영역 |
-- ymd | String | 통계 날짜(yyyyMMdd) |
-- appKey | String | appKey |
-- type | String | 통계 조회 타입 REQUEST:요청 SENT:발송 RECEIVED :수신 OPENED:오픈 |
-- mailType | String | 메일 타입 MAILTYPE:메일타입별(일반/대량) 통계 TEMPLATE:템플릿별 통계 |
-- templateId | String | 템플릿아이디 |
-- templateName | String | 템플릿명 |
-- tm00 | int | 00:00:00 ~ 00:59:59 |
-- tm01 | int | 01:00:00 ~ 01:59:59 |
-- tm02 | int | 02:00:00 ~ 02:59:59 |
-- tm03 | int | 03:00:00 ~ 03:59:59 |
-- tm04 | int | 04:00:00 ~ 04:59:59 |
-- tm05 | int | 05:00:00 ~ 05:59:59 |
-- tm06 | int | 06:00:00 ~ 06:59:59 |
-- tm07 | int | 07:00:00 ~ 07:59:59 |
-- tm08 | int | 08:00:00 ~ 08:59:59 |
-- tm09 | int | 09:00:00 ~ 09:59:59 |
-- tm10 | int | 10:00:00 ~ 10:59:59 |
-- tm11 | int | 11:00:00 ~ 11:59:59 |
-- tm12 | int | 12:00:00 ~ 12:59:59 |
-- tm13 | int | 13:00:00 ~ 13:59:59 |
-- tm14 | int | 14:00:00 ~ 14:59:59 |
-- tm15 | int | 15:00:00 ~ 15:59:59 |
-- tm16 | int | 16:00:00 ~ 16:59:59 |
-- tm17 | int | 17:00:00 ~ 17:59:59 |
-- tm18 | int | 18:00:00 ~ 18:59:59 |
-- tm19 | int | 19:00:00 ~ 19:59:59 |
-- tm20 | int | 20:00:00 ~ 20:59:59 |
-- tm21 | int | 21:00:00 ~ 21:59:59 |
-- tm22 | int | 22:00:00 ~ 22:59:59 |
-- tm23 | int | 23:00:00 ~ 23:59:59 |
-- sum | int | 합계 |
[URL]
Http method | URI |
---|---|
GET | /email/v1.2/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 | 템플릿 아이디 |
[예시]
curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/statistics/view?from=2018-03-21+00%3A00&to=2018-03-23+00%3A00&searchType=DATE&mailTypes=NORMAL&adYn=Y&templateId=templateId1"
{
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
},
"body" : {
"data" : [
{
"divisionName": String,
"requestedCount": long,
"sentCount": long,
"receivedCount": long,
"openedCount": long,
"sentRate": String,
"receivedRate": String,
"openedRate": String
}
]
}
}
값 | 타입 | 설명 |
---|---|---|
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.2/appKeys/{appKey}/block-receivers |
[Path parameter]
값 | 타입 | 설명 |
---|---|---|
appKey | String | 고유의 appKey |
[Query parameter]
값 | 타입 | 필수 | 설명 |
---|---|---|---|
mailAddress | String | X | 수신거부 목록에 등록되어 있는 이메일 주소 |
pageNum | Integer | X | 페이지 번호(Default : 1) |
pageSize | Integer | X | 조회 건수(Default : 15) |
[예시]
curl -X GET -H "Content-Type: application/json;charset=UTF-8" "https://api-mail.cloud.toast.com/email/v1.2/appKeys/{appKey}/block-receivers?mailAddress=customer1@nhn.com&pageNum=1&pageSize=10"
{
"header": {
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
},
"body": {
"totalCount": Integer,
"data": [
{
"mailAddress": String,
"blockDate": String
}
]
}
}
값 | 타입 | 설명 |
---|---|---|
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.2/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.2/appKeys/{appKey}/block-receivers -d '{"blockReceiverList":[{"mailAddress":"customer1@nhn.com","blockDate":"2018-03-01 00:00:00"}]}'
{
"header": {
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |
[URL]
Http method | URI |
---|---|
PUT | /email/v1.2/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.2/appKeys/{appKey}/block-receivers -d '{"deleted":true,"blockReceiverList":[{"mailAddress":"customer1@nhn.com"}]}'
{
"header": {
"isSuccessful": Boolean,
"resultCode": Integer,
"resultMessage": String
}
}
값 | 타입 | 설명 |
---|---|---|
header | Object | 헤더 영역 |
- isSuccessful | Boolean | 성공여부 |
- resultCode | Integer | 실패 코드 |
- resultMessage | String | 실패 메시지 |