Classic/VPC 환경에서 이용 가능합니다.
이메일 발송 프로젝트별 설정 항목을 조회합니다. 현재는 발송 차단 내역만 볼 수 있습니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | /config |
요청 헤더
Cloud Outbound Mailer API에서 공통으로 사용하는 헤더에 대한 자세한 내용은 Cloud Outbound Mailer 요청 헤더를 참조해 주십시오.
요청 쿼리 파라미터
파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
type |
String | Required | 조회할 설정 항목
|
subType |
String | Optional | 해당 설정의 서브 타입
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://mail.apigw.gov-ntruss.com/api/v1/config
?type=SEND_BLOCK_TIME'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}'
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
type |
String | Required | 조회한 설정 항목 |
subType |
Integer | Optional | 해당 설정의 서브 타입 |
value |
String | Required | 반영된 설정 값 |
응답 상태 코드
응답 상태 코드에 대한 설명은 다음과 같습니다.
| 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 | 그 외 내부 서버 오류 |
응답 예시
응답 예시는 다음과 같습니다.
{
"type": "SEND_BLOCK_TIME",
"subType": null,
"value": "180"
}