Classic/VPC 환경에서 이용 가능합니다.
이메일 템플릿 및 카테고리 구조를 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | /template |
요청 헤더
Cloud Outbound Mailer API에서 공통으로 사용하는 헤더에 대한 정보는 Cloud Outbound Mailer 요청 헤더를 참조해 주십시오.
요청 쿼리 파라미터
요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
isUse |
Boolean | Optional | 사용 중인 템플릿 및 카테고리 구조만 조회할지 여부
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://mail.apigw.gov-ntruss.com/api/v1/template?isUse=true' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
contents |
List | - | 조회 대상 템플릿 및 카테고리의 상세 구조 |
응답 상태 코드
Cloud Outbound Mailer API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Cloud Outbound Mailer 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"contents": [
{
"sid": 261,
"parentSid": -1,
"createDate": {
"utc": 1589355820663,
"formattedDate": "2020-05-13",
"formattedDateTime": "2020-05-13 16:43:40 663"
},
"name": "AD",
"isCategory": true,
"isUse": true,
"subCategories": null,
"templates": [
{
"sid": 262,
"parentSid": 261,
"createDate": {
"utc": 1589355868201,
"formattedDate": "2020-05-13",
"formattedDateTime": "2020-05-13 16:44:28 201"
},
"name": "AD_Template",
"isCategory": false,
"isUse": true,
"subCategories": null,
"templates": null
}
]
}
]
}