getAddressBook
- 인쇄
- PDF
getAddressBook
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
주소록 현황 조회 (총 주소 개수 및 각 수신자 그룹별 주소 개수 조회)
GET https://mail.apigw.gov-ntruss.com/api/v1/address-book
응답
| HTTP 상태코드 | 설명 |
|---|---|
| 200 | 성공 |
| 400 | 인증 실패, 잘못된 요청 |
| 500 | 서버 오류 |
예시
요청 예시
GET https://mail.apigw.gov-ntruss.com/api/v1/address-book
응답 예시
{
"totalAddressCount": 4300,
"groups": [
{
"sid": 155,
"groupName": "10대",
"addressCount": 3900
},
{
"sid": 159,
"groupName": "남자",
"addressCount": 1000
}
}
속성
| 항목 | 필수 여부 | 타입 | 제약 사항 | 설명 |
|---|---|---|---|---|
| totalAddressCount | Yes | Integer | 총 메일주소 개수 | |
| groups | No | List<AddressBookResponse> | 수신자 그룹 목록 |
오류 코드
| HTTP Status Code | 리턴 코드 | 응답 메시지 |
|---|---|---|
| 400 | 77101 | 로그인 정보 오류 |
| 400 | 77102 | BAD_REQUEST |
| 400 | 77103 | 리소스가 존재하지 않음 |
| 403 | 77201 | 권한 없음 |
| 403 | 77202 | Email 상품 사용신청 하지 않음 |
| 405 | 77001 | METHOD_NOT_ALLOWED |
| 415 | 77002 | UNSUPPORTED_MEDIA_TYPE |
| 500 | 77301 | 기본 프로젝트가 존재하지 않음 |
| 500 | 77302 | 외부 시스템 API 연동 오류 |
| 500 | 77303 | 그외 INTERNAL_SERVER_ERROR |
이 문서가 도움이 되었습니까?