프로젝트 목록 조회

Prev Next

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

프로젝트 목록을 조회합니다.

요청

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

메서드 URI
GET /common/v2/projects

요청 헤더

Simple & Easy Notification Service API에서 공통으로 사용하는 헤더에 대한 정보는 Simple & Easy Notification Service 요청 헤더를 참조해 주십시오.

요청 쿼리 파라미터

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

필드 타입 필수 여부 설명
projectName String Optional 프로젝트 이름
  • 전체 또는 부분 일치하는 값 필터링
pageSize Integer Optional 페이지당 항목 수
  • 1~100 (기본값: 100)
pageIndex Integer Optional 페이지 인덱스
  • 0~N (기본값: 0)

요청 예시

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

curl --location --request GET 'https://sens.apigw.ntruss.com/common/v2/projects' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
projectId String Required 프로젝트 아이디
projectName String Required 프로젝트 이름
projectDesc String Required 프로젝트 설명
useSms Boolean Required SMS 서비스 사용 여부
  • true | false
    • true: 사용
    • false: 사용 안 함
useKkoBizMsg Boolean Required Biz Message 서비스 사용 여부
  • true | false
    • true: 사용
    • false: 사용 안 함
smsService Object Optional SMS 서비스 메타 정보
smsService.serviceId String Required SMS 서비스 아이디
smsService.serviceName String Required SMS 서비스 이름
smsService.createTime String Required SMS 서비스 생성 일시
  • YYYY-MM-DDTHH:mm:ss.sss 형식
smsService.updateTime String Optional SMS 서비스 수정 일시
  • YYYY-MM-DDTHH:mm:ss.sss 형식
smsService.useBlockService Boolean Required 080 수신 거부 번호 서비스 사용 여부
  • true | false
    • true: 사용
    • false: 사용 안 함
kkoBizMsgService Object Optional Biz Message 서비스 메타 정보
kkoBizMsgService.serviceId String Required Biz Message 서비스 아이디
kkoBizMsgService.serviceName String Required Biz Message 서비스 이름
kkoBizMsgService.createTime String Required Biz Message 서비스 생성 일시
  • YYYY-MM-DDTHH:mm:ss.sss 형식
kkoBizMsgService.updateTime String Optional Biz Message 서비스 수정 일시
  • YYYY-MM-DDTHH:mm:ss.sss 형식
createTime String Required 프로젝트 생성 일시
  • YYYY-MM-DDTHH:mm:ss.sss 형식
updateTime String Optional 프로젝트 최종 수정 일시
  • YYYY-MM-DDTHH:mm:ss.sss 형식
  • 수정 이력이 없는 경우, 미표시

응답 상태 코드

Simple & Easy Notification Service API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Simple & Easy Notification Service 응답 상태 코드를 참조해 주십시오.

응답 예시

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

[
    {
        "projectId": "c665f4dc-****-****-****-b1c7880a9b4a",
        "projectName": "mypush",
        "projectDesc": "push service",
        "useSms": false,
        "useKkoBizMsg": true,
        "smsService": {
            "serviceId": "ncp:sms:kr:50********10:mypush",
            "serviceName": "mypush",
            "createTime": "2025-11-18T10:21:53.540",
            "updateTime": "2025-11-18T10:21:53.537",
            "useBlockService": false
        },
        "kkoBizMsgService": {
            "serviceId": "ncp:kkobizmsg:kr:50********25:mypush",
            "serviceName": "mypush",
            "createTime": "2025-11-18T10:21:53.546",
            "updateTime": "2025-11-18T10:21:53.544"
        },
        "createTime": "2025-11-18T10:21:53.536"
    },
    {
        "projectId": "5c7c325a-****-****-****-42ef00c15265",
        "projectName": "sens",
        "projectDesc": "sample project",
        "useSms": true,
        "useKkoBizMsg": true,
        "smsService": {
            "serviceId": "ncp:sms:kr:50*********1:sens",
            "serviceName": "sens",
            "createTime": "2025-11-18T09:14:49.686",
            "updateTime": "2025-11-18T09:14:49.681",
            "useBlockService": true
        },
        "kkoBizMsgService": {
            "serviceId": "ncp:kkobizmsg:kr:50*********5:sens",
            "serviceName": "sens",
            "createTime": "2025-11-18T09:14:49.691",
            "updateTime": "2025-11-18T09:14:49.690"
        },
        "createTime": "2025-11-18T09:14:49.679"
    }
]