[Step 1] 자동메일 Event 리턴 API URL 및 파라미터 설명

 

구분	설명
action	http://localhost:8080/api/event/v2/json-return
method	post
encoding	UTF-8
Content-Type	application/json

 

Parameter	Value 값	설명
api_key	26b5e583njhjla	계정관리 - API용 KEY를 그대로 입력
template_id	11	연동 발송할 메일의 템플릿 KEY(숫자만)
sender	help@pringo.co.kr	발신 이메일 주소
sender_name	프링고 고객센터	발신자명
recipient	gildong@emaile.co.kr	수신 이메일 주소
recipient_name	홍길동	수신자명
send_ok	O, X	성공 or 실패
return_type	1, 2	1 :기본형, 2 : 전체
return_key	4	자동메일> 연동목록>연동내역>return_key (발송 시도된 고유번호)
start_date	202201010100	yyyyMMddHHmm 연 월 일 시 분
end_date	202212311259	yyyyMMddHHmm 연 월 일 시 분

※ 붉은색 : 필수 입력사항 

※ 파란색 : 선택 입력사항 

 

 

2.2. Form retrun_type : 1 기본 필드 조회

 

## 결과 조회 필드 설명 ##

• 기본 조회 결과

 

결과조회 항목	변수	설명
순서번호	No	데이터들의 순차번호 내림차순
결과조회 Key	return_key	자동메일>연동목록>연동내역>retrun_key(발송 시도된 고유번호)
수신자 이메일	email
오픈여부	open	O(성공)  X(실패)
성공여부	send_success	O(성공)  X(실패)
발송시간	send_time
실패코드	status	발송실패 error code, 성공 250

 

## 결과 호출 예시 ###

 

 

{

   “api_key” :  “26b5e583njhjla~~~~~~~~~1213214”,

   “template_id” :  “7”,

   “return_type” :  “2”,

   “recipient” : “받는사람 이메일”

}

## 기본 결과 예시 ###

 

   {

"No": 2,

"return_key": 4,

"email": "받는사람@pringo.co.kr",

"open": "X",

"send_success": "X",

"send_time": "2022-07-13 11:16:58",

"status": "554"

},

{

"No": 1,

"return_key": 3,

"email": "받는사람@pringo.co.kr",

"open": "X",

"send_success": "O",

"send_time": "2022-07-22 17:16:06",

"status": "250"

}

 

전체 조회 필드 설명

 

결과조회 항목	변수	비고
인덱스 값	No	데이터들의 순차번호 내림차순
결과조회 Key	return_key	자동메일>연동목록>연동내역>retrun_key(발송 시도된 고유번호)
수신자 이메일	email
오픈여부	open	O(성공)  X(실패)
성공여부	send_success	O(성공)  X(실패)
발송시간	send_time
실패코드	status	발송실패 error code, 성공 250
템플릿 id	eventKey	발송할 템플릿 id
오픈시간	read_time
읽은 IP	remoteIP
메일 제목	tilte
발신자 이메일	sender
발신자 이름	sender_alias
수신자 이름	receiver_alias
수신자 피시 os	os
피시, 모바일 확인	isweb

 

 

## 전체 결과 예시 ##

• 결과 데이터 리턴Type : JASON 형식(2개이상 검색결과시 )

{

"No": 2,

"return_key": 4,

"email": "받는사람@pringo.co.kr",

"open": "X",

"send_success": "X",

"send_time": "2022-07-13 11:16:58",

"status": "554",

"eventKey": 7,

"read_time": "",

"remoteIP": null,

"title": "local 테스트 이벤트 메일 테스트 중",

"sender": "help@pringo.co.kr",

"sender_alias": "프링고",

"receiver_alias": "수신자명",

"os": null,

"isweb": null

},

{

"No": 1,

"return_key": 3,

"email": "받는사람@pringo.co.kr",

"open": "X",

"send_success": "O",

"send_time": "2022-07-22 17:16:06",

"status": "250",

"eventKey": 7,

"read_time": "",

"remoteIP": null,

"title": "local 테스트 이벤트 메일 테스트 중",

"sender": "bschoi@cheom.net",

"sender_alias": "local",

"receiver_alias": "[$name]님",

"os": null,

"isweb": null

}

 

 

 

[Step 3] 자동메일 결과 조회 API 리턴 코드 

 

리턴코드	설명
1	API연동 성공, 발송 준비 되었습니다.
0	해당하는 조회 결과가 없습니다.
-1	파라미터가 잘못 되었거나, 누락되었습니다.
-3	계정 정보가 맞지 않습니다.
-4	소유자가 아닙니다.
90x	고객센터에 문의해주시기 바랍니다.