getConfig

Prev Next

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

이메일 발송 프로젝트별 설정 항목을 조회합니다. 현재는 발송 차단 내역만 볼 수 있습니다.

요청

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

메서드 URI
GET /config

요청 헤더

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

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
type String Required 조회할 설정 항목
  • SEND_BLOCK_TIME: 발송 차단 설정
subType String Optional 해당 설정의 서브 타입
  • SEND_BLOCK_TIMEnull 입력

요청 예시

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

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 - 조회한 설정 항목
subType Integer - 해당 설정의 서브 타입
value String - 반영된 설정 값

응답 상태 코드

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

응답 예시

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

{
  "type": "SEND_BLOCK_TIME",
  "subType": null,
  "value": "180"
}