프로젝트 생성

Prev Next

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

프로젝트를 생성합니다.

요청

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

메서드 URI
POST /common/v2/projects

요청 헤더

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

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
projectName String Required 프로젝트 이름
  • 영문 소문자, 숫자, 특수 문자 '-', '_'를 허용하며, 24자 이내로 입력
projectDesc String Optional 프로젝트 설명
  • 0~128자
useKkoBizMsg Boolean Optional Biz Message 서비스 사용 여부
  • true | false (기본값)
    • true: 사용
    • false: 사용 안 함
  • false인 경우에도 서비스 메타 정보가 생성되며 추후 변경 가능
useSms Boolean Optional SMS 서비스 사용 여부
  • true | false (기본값)
    • true: 사용
    • false: 사용 안 함
  • false인 경우에도 서비스 메타 정보가 생성되며 추후 변경 가능

요청 예시

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

curl --location --request POST 'https://sens.apigw.gov-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}' \
--header 'Content-Type: application/json' \
--data '{
    "projectName": "mypush",
    "projectDesc": "push service",
    "useKkoBizMsg": true,
    "useSms": false
}'

응답

응답 형식을 설명합니다.

응답 바디

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

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

응답 상태 코드

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

응답 예시

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

{
    "projectId": "b674e9e0-****-****-****-165e285c8497",
    "projectName": "mypush",
    "projectDesc": "push service",
    "useSms": false,
    "useKkoBizMsg": true,
    "smsService": {
        "serviceId": "ncp:sms:kr:27********30:mypush",
        "serviceName": "mypush",
        "createTime": "2025-11-18T08:55:01.578",
        "updateTime": "2025-11-18T08:55:01.576",
        "useBlockService": false
    },
    "kkoBizMsgService": {
        "serviceId": "ncp:kkobizmsg:kr:27********13:mypush",
        "serviceName": "mypush",
        "createTime": "2025-11-18T08:55:01.617",
        "updateTime": "2025-11-18T08:55:01.616"
    },
    "createTime": "2025-11-18T08:55:01.558"
}