이메일 스탠다드

이메일 발송 API 입니다.

이메일 스탠다드 API

캐릭터 인코딩은 UTF-8을 기본으로 합니다.

Email 발송 API

POST https://atocqjpb6r.apigw.ntruss.com/email-standard/v1/send

Headers

Name

Type

Description

Authorization*

string

사용자ID;secret_key

Request Body

Name

Type

Description

sender*

string

발신자 email

file_name

string

첨부파일 명 (최대 5개 '|' 로 구분)

file_url

string

첨부파일 url (최대 5개 '|' 로 구분) (파일 용량의 합이 10MB 이하)

agreement_text

string

안내 문구

(본메일은 [$NOW_DATE] 기준, 회원님의 수신동의 여부를 확인한 결과 회원님께서 수신동의를 하셨기에 발송되었습니다.)

body*

string

본문 (치환문자가 있을 경우 대문자로 표시)

subject*

string

제목 (치환문자가 있을 경우 대문자로 표시)

sender_name*

string

발신자명 (35자 제한)

receiver*

object array

수신자 정보 상세

키

타입

필수

내용

string

수신자 email

name

string

이름 (한글 10글자, 영문 30 byte)

mobile

string

휴대폰번호

note1

string

치환문자 (한글,영문 소문자 128byte)

note2

string

치환문자 (한글,영문 소문자 128byte)

note3

string

치환문자 (한글,영문 소문자 128byte)

note4

string

치환문자 (한글,영문 소문자 128byte)

note5

string

치환문자 (한글,영문 소문자 128byte)

Request Body 예시

{
    "sender": "string",
    "subject": "email 테스트입니다. ",
    "sender_name": "string",
    "body": "<html><body><h1>안녕하세요. 대체문자1은 [$NOTE1], 대체문자2는 [$NOTE2] 입니다.</h1></body></html> ",
    "receiver": [
        {
            "email": "string",
            "mobile": "010-000-0000",
            "note1": "replace문자1"
        },
        {
            "email": "string",
            "mobile": "010-000-0001",
            "note1": "replace문자2"
        }
    ]
}

Response Body

요청 중 중복된 수신 주소가 있을 경우 마지막 메일만 전송 처리 됩니다.

{
    "mail_id": "string",
    "sendtime": "string",
    "status": "string"
}

키

타입

설명

mail_id

string

메일 id (원천 서비스에서 생성, request 당 1개)

sendtime

string

발송 시간 (yyyy-mm-dd hh:mi:ss)

status

string

메일 상태 (아래 표의 status 코드 참조)

status

코드설명

정상 발송

100

POST validation 실패

102

Subject, Body 정보가 없습니다.

103

Sender 이메일이 유효하지 않습니다.

104

receiver 이메일이 유효하지 않습니다.

105

본문에 포함되면 안되는 확장자가 있습니다.

106

body validation 실패

107

받는 사람이 없습니다.

110

첨부 파일이 없습니다.

111

첨부 파일의 개수가 5개를 초과합니다.

112

파일의 총Size가 10 MB를 넘어갑니다.

113

첨부 파일이 다운로드 되지 않았습니다.

114

utf-8 인코딩 에러 발생

115

템플릿 validation 실패

202

발송자명이 최대 길이를 초과 하였습니다.

999

Internal Error.

메세지 발송 결과(Webhook)

고객사가 요청한 메시지에 대한 처리 결과를 고객사의 callback URL로 전달합니다. (API PLEX Gateway -> 고객사 URL)

고객사 callback URL 정보는 서비스 신청 시 입력 합니다.

고객사 callback URL에 대한 CJ API GATEWAY의 접근을 허용해야 합니다. (IP, PORT)

이메일 스탠다드 WebHook API

POST {Callback URL}

Webhook Body (API PLEX ➡ 고객사)

{
    "SendTime": "string",
    "mail_id": "string",
    "Success": "number",
    "Failed": "number",
    "IsNeedResend": "true/false",
    "Result": "string",
    "Recipients": [
        {
            "Email": "string",
            "State": "string",
            "SmtpCode": "string",
            "SmtpMsg": "string"
        }
    ]
}

전송되는 Webhook Body 형식

키

타입

설명

SendTime

string

발송 일시 (yyyy-mm-dd hh:mi:ss)

mail_id

string

메일 id

Success

number

성공 건수

Failed

number

실패 건수

IsNeedResend

boolean

2차발송 여부 (네트워크 오류 등 환경적인 상황에서의 오류 발생 시 API PLEX 자체적으로 최대 2회 까지 재시도)

Result

string

결과 desc (EX. success)

Recipients

object array

수신자 정보 상세

키

타입

설명

string

수신자 email

State

string

SmtpCode

string

smtp 코드

SmtpMsg

string

smtp 메시지

결과 코드

State

설명

-1

발송 대기

성공

일시적 에러

도메인 에러

서버 연결 에러

메일 박스 에러

기타 에러

수신 거부

Response Body (고객사 ➡ API PLEX)

{
    "code": "string",
    "desc": "string"
}

키

타입

필수

설명

code

string

접수 결과 코드 (정상 수신 시 "100")

desc

string

접수 결과 코드 상세 (ex: "desc":"Success")

Last updated 1 year ago

Was this helpful?

이메일 스탠다드

이메일 발송 API 입니다.

이메일 스탠다드 API

캐릭터 인코딩은 UTF-8을 기본으로 합니다.

Email 발송 API

POST https://atocqjpb6r.apigw.ntruss.com/email-standard/v1/send

Headers

Name

Type

Description

Authorization*

string

사용자ID;secret_key

Request Body

Name

Type

Description

sender*

string

발신자 email

file_name

string

첨부파일 명 (최대 5개 '|' 로 구분)

file_url

string

첨부파일 url (최대 5개 '|' 로 구분) (파일 용량의 합이 10MB 이하)

agreement_text

string

안내 문구

(본메일은 [$NOW_DATE] 기준, 회원님의 수신동의 여부를 확인한 결과 회원님께서 수신동의를 하셨기에 발송되었습니다.)

body*

string

본문 (치환문자가 있을 경우 대문자로 표시)

subject*

string

제목 (치환문자가 있을 경우 대문자로 표시)

sender_name*

string

발신자명 (35자 제한)

receiver*

object array

수신자 ( 참조)

수신자 정보 상세

키

타입

필수

내용

string

수신자 email

name

string

이름 (한글 10글자, 영문 30 byte)

mobile

string

휴대폰번호

note1

string

치환문자 (한글,영문 소문자 128byte)

note2

string

치환문자 (한글,영문 소문자 128byte)

note3

string

치환문자 (한글,영문 소문자 128byte)

note4

string

치환문자 (한글,영문 소문자 128byte)

note5

string

치환문자 (한글,영문 소문자 128byte)

Request Body 예시

{
    "sender": "string",
    "subject": "email 테스트입니다. ",
    "sender_name": "string",
    "body": "<html><body><h1>안녕하세요. 대체문자1은 [$NOTE1], 대체문자2는 [$NOTE2] 입니다.</h1></body></html> ",
    "receiver": [
        {
            "email": "string",
            "mobile": "010-000-0000",
            "note1": "replace문자1"
        },
        {
            "email": "string",
            "mobile": "010-000-0001",
            "note1": "replace문자2"
        }
    ]
}

Response Body

요청 중 중복된 수신 주소가 있을 경우 마지막 메일만 전송 처리 됩니다.

{
    "mail_id": "string",
    "sendtime": "string",
    "status": "string"
}

키

타입

설명

mail_id

string

메일 id (원천 서비스에서 생성, request 당 1개)

sendtime

string

발송 시간 (yyyy-mm-dd hh:mi:ss)

status

string

메일 상태 (아래 표의 status 코드 참조)

status

코드설명

정상 발송

100

POST validation 실패

102

Subject, Body 정보가 없습니다.

103

Sender 이메일이 유효하지 않습니다.

104

receiver 이메일이 유효하지 않습니다.

105

본문에 포함되면 안되는 확장자가 있습니다.

106

body validation 실패

107

받는 사람이 없습니다.

110

첨부 파일이 없습니다.

111

첨부 파일의 개수가 5개를 초과합니다.

112

파일의 총Size가 10 MB를 넘어갑니다.

113

첨부 파일이 다운로드 되지 않았습니다.

114

utf-8 인코딩 에러 발생

115

템플릿 validation 실패

202

발송자명이 최대 길이를 초과 하였습니다.

999

Internal Error.

메세지 발송 결과(Webhook)

고객사가 요청한 메시지에 대한 처리 결과를 고객사의 callback URL로 전달합니다. (API PLEX Gateway -> 고객사 URL)

고객사 callback URL 정보는 서비스 신청 시 입력 합니다.

고객사 callback URL에 대한 CJ API GATEWAY의 접근을 허용해야 합니다. (IP, PORT)

이메일 스탠다드 WebHook API

POST {Callback URL}

Webhook Body (API PLEX ➡ 고객사)

{
    "SendTime": "string",
    "mail_id": "string",
    "Success": "number",
    "Failed": "number",
    "IsNeedResend": "true/false",
    "Result": "string",
    "Recipients": [
        {
            "Email": "string",
            "State": "string",
            "SmtpCode": "string",
            "SmtpMsg": "string"
        }
    ]
}

전송되는 Webhook Body 형식

키

타입

설명

SendTime

string

발송 일시 (yyyy-mm-dd hh:mi:ss)

mail_id

string

메일 id

Success

number

성공 건수

Failed

number

실패 건수

IsNeedResend

boolean

2차발송 여부 (네트워크 오류 등 환경적인 상황에서의 오류 발생 시 API PLEX 자체적으로 최대 2회 까지 재시도)

Result

string

결과 desc (EX. success)

Recipients

object array

수신자 별 결과(아래 참조)

수신자 정보 상세

키

타입

설명

string

수신자 email

State

string

결과 코드 (아래 참조)

SmtpCode

string

smtp 코드

SmtpMsg

string

smtp 메시지

결과 코드

State

설명

-1

발송 대기

성공

일시적 에러

도메인 에러

서버 연결 에러

메일 박스 에러

기타 에러

수신 거부

Response Body (고객사 ➡ API PLEX)

{
    "code": "string",
    "desc": "string"
}

키

타입

필수

설명

code

string

접수 결과 코드 (정상 수신 시 "100")

desc

string

접수 결과 코드 상세 (ex: "desc":"Success")

Last updated 1 year ago

Was this helpful?