getTemplateStructure
- 인쇄
- PDF
getTemplateStructure
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
이메일 템플릿 및 카테고리 구조를 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET | /template |
요청 헤더
Cloud Outbound Mailer API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Cloud Outbound Mailer 요청 헤더를 참조해 주십시오.
요청 쿼리 파라미터
파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
isUse | Boolean | Optional | 사용 중인 템플릿 및 카테고리 구조만 조회할지 여부
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://mail.apigw.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 | TemplateStructureResponse | Optional | 조회 대상 템플릿 및 카테고리의 상세 구조 |
응답 상태 코드
응답 상태 코드에 대한 설명은 다음과 같습니다.
HTTP 상태 코드 | 코드 | 설명 |
---|---|---|
200 | - | 요청 성공 |
400 | - | 인증 실패, 잘못된 요청 |
400 | 77101 | 로그인 정보 오류 |
400 | 77102 | 요청 오류 |
400 | 77103 | 요청한 리소스가 존재하지 않음 |
403 | 77201 | 요청한 리소스에 대한 권한이 없음 |
403 | 77202 | 이메일 서비스 사용을 신청하지 않은 사용자가 호출한 경우 |
405 | 77001 | 지원되지 않는 메서드 유형 |
415 | 77002 | 지원되지 않는 미디어 유형 |
500 | - | 서버 오류 |
500 | 77301 | 기본 프로젝트가 존재하지 않음 |
500 | 77302 | 외부 시스템 API 연동 오류 |
500 | 77303 | 그 외 내부 서버 오류 |
응답 예시
응답 예시는 다음과 같습니다.
{
"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
}
]
}
]
}
이 문서가 도움이 되었습니까?