getTemplate

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

저장된 메일 템플릿을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /template/{templateSid}

요청 헤더

Cloud Outbound Mailer API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Outbound Mailer 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
templateSid Integer Required 조회할 템플릿의 SID

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://mail.apigw.gov-ntruss.com/api/v1/template/258' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
sid Integer - 조회한 템플릿의 SID
createDate Object - 생성 일시
name String - 템플릿 이름
description String - 템플릿에 대한 설명
title String - 이메일 제목
senderAddress String - 발송자 이메일 주소
senderName String - 발송자 이름
body String - 이메일 본문
isUse Boolean - 템플릿 사용 여부
category Object - 부모 카테고리의 정보

응답 상태 코드

Cloud Outbound Mailer API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Outbound Mailer 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
  "sid": 258,
  "createDate": {
    "utc": 1589348863431,
    "formattedDate": "2020-05-13",
    "formattedDateTime": "2020-05-13 14:47:43 431"
  },
  "name": "membershipTemplate",
  "description": "Example of creating a template",
  "title": "[EN] Naver Cloud Platform",
  "senderAddress": "admin@master.com",
  "senderName": "Admin",
  "body": "Congratulations on your membership.",
  "isUse": true,
  "category": {
    "sid": 252,
    "parentSid": -1,
    "name": "testCategory"
  }
}