MENU
      Project API

        Project API


        기사 요약

        기본 정보

        API URL

        https://sens.apigw.ntruss.com/common/v2
        HTTP

        SENS Project API Swagger 바로가기

        API Header

        항목Mandatory설명
        Content-TypeMandatory요청 Body Content Type을 application/json으로 지정 (POST)
        x-ncp-apigw-timestampMandatory- 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것
        - API Gateway 서버와 시간 차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
        x-ncp-iam-access-keyMandatory포털 또는 Sub Account에서 발급받은 Access Key ID
        x-ncp-apigw-signature-v2Mandatory- 위 예제의 Body를 Access Key Id와 맵핑되는 SecretKey로 암호화한 서명
        - HMAC 암호화 알고리즘은 HmacSHA256 사용

        NAVER Cloud Platform 인증키 및 Signature 생성 가이드 바로가기


        프로젝트

        프로젝트 생성

        프로젝트를 생성합니다.

        요청 URL

        POST https://sens.apigw.ntruss.com/common/v2/projects
        
        Content-Type: application/json; charset=utf-8
        x-ncp-apigw-timestamp: {Timestamp}
        x-ncp-iam-access-key: {Sub Account Access Key}
        x-ncp-apigw-signature-v2: {API Gateway Signature}
        HTTP

        Path Variables

        없음
        JSON

        Headers

        API Header 바로가기

        요청 Body

        {
          "projectName": "string",
          "projectDesc": "string",
          "useKkoBizMsg": "boolean",
          "usePush": "boolean",
          "useSms": "boolean"
        }
        JSON
        항목MandatoryType설명비고
        projectNameMandatoryString프로젝트 이름- 영문 소문자, 숫자, 붙임표 ( - ), 밑줄 문자 ( _ )만 입력 가능
        - 최대 24자
        projectDescOptionalString프로젝트 설명최대 128자
        useKkoBizMsgOptionalBoolean비즈메시지 서비스 사용 여부default: false
        usePushOptionalBooleanPUSH 서비스 사용 여부default: false
        useSmsOptionalBooleanSMS 서비스 사용 여부default: false
        • useKkoBizMsg, usePush, useSms의 경우 명시하지 않으면 기본값으로 false가 사용됩니다.
        • 사용 여부가 false라도 각 서비스에 해당하는 메타정보가 생성되며 추후 사용 여부를 변경할 수 있습니다.

        응답 Body

        {
          "projectId": "string",
          "projectName": "string",
          "projectDesc": "string",
          "usePush": "boolean",
          "useSms": "boolean",
          "useKkoBizMsg": "boolean",
          "pushService": {
            "serviceId": "string",
            "serviceName": "string",
            "createTime": "localDateTime",
            "updateTime": "localDateTime"
          },
          "smsService": {
            "serviceId": "string",
            "serviceName": "string",
            "createTime": "localDateTime",
            "updateTime": "localDateTime",
            "useBlockService": "boolean"
          },
          "kkoBizMsgService": {
            "serviceId": "string",
            "serviceName": "string",
            "createTime": "localDateTime",
            "updateTime": "localDateTime"
          },
          "createTime": "localDateTime",
          "updateTime": "localDateTime"
        }
        JSON
        항목MandatoryType설명비고
        projectNameMandatoryString프로젝트 이름
        projectDescMandatoryString프로젝트 설명
        useKkoBizMsgMandatoryBoolean비즈메시지 서비스 사용 여부
        usePushMandatoryBooleanPUSH 서비스 사용 여부
        useSmsMandatoryBooleanSMS 서비스 사용 여부
        createTimeMandatoryString생성 시간
        updateTimeOptionalString생성 시간
        *Service.serviceIdMandatoryString서비스 아이디SMS, PUSH, KkoBizMsg 공통
        *Service.serviceNameMandatoryString서비스 이름SMS, PUSH, KkoBizMsg 공통
        *Service.createTimeMandatoryString서비스 생성 시간SMS, PUSH, KkoBizMsg 공통
        *Service.updateTimeOptionalString서비스 수정 시간SMS, PUSH, KkoBizMsg 공통
        smsService.useBlockServiceMandatoryBoolean080 수신 거부 번호 서비스 사용 여부

        응답 Status

        HTTP StatusDesc
        200OK (생성 완료)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        429Too Many Requests
        500Internal Server Error

        프로젝트 수정

        프로젝트를 수정합니다.

        요청 URL

        PUT https://sens.apigw.ntruss.com/common/v2/projects/{projectId}
        
        x-ncp-apigw-timestamp: {Timestamp}
        x-ncp-iam-access-key: {Sub Account Access Key}
        x-ncp-apigw-signature-v2: {API Gateway Signature}
        HTTP

        Path Variables

        항목MandatoryType설명비고
        projectIdMandatoryString프로젝트 아이디프로젝트 생성 시 발급받은 프로젝트 아이디

        Parameters

        없음
        Plain text

        Headers

        API Header 바로가기

        요청 Body

        {
          "projectDesc": "string",
          "useKkoBizMsg": "boolean",
          "usePush": "boolean",
          "useSms": "boolean"
        }
        JSON
        항목MandatoryType설명비고
        projectDescOptionalString프로젝트 설명최대 128자
        useKkoBizMsgOptionalBoolean비즈메시지 서비스 사용 여부default: false
        usePushOptionalBooleanPUSH 서비스 사용 여부default: false
        useSmsOptionalBooleanSMS 서비스 사용 여부default: false
        • projectName의 경우 기존 이름과 다른 이름을 사용하셔도 수정되지 않습니다.
        • useKkoBizMsg, usePush, useSms의 경우 명시하지 않으시면 기본값으로 false로 변경됩니다.

        응답 Body

        {
          "projectId": "string",
          "projectName": "string",
          "projectDesc": "string",
          "usePush": "boolean",
          "useSms": "boolean",
          "useKkoBizMsg": "boolean",
          "pushService": {
            "serviceId": "string",
            "serviceName": "string",
            "createTime": "localDateTime",
            "updateTime": "localDateTime"
          },
          "smsService": {
            "serviceId": "string",
            "serviceName": "string",
            "createTime": "localDateTime",
            "updateTime": "localDateTime",
            "useBlockService": "boolean",
                    "blockService": {
                        "available": "boolean",
                        "companyName": "string",
                        "statusName": "string",
                        "createTime": "localDateTime",
                        "updateTime": "localDateTime"
                    }
          },
          "kkoBizMsgService": {
            "serviceId": "string",
            "serviceName": "string",
            "createTime": "localDateTime",
            "updateTime": "localDateTime"
          },
          "createTime": "localDateTime",
          "updateTime": "localDateTime"
        }
        JSON
        항목MandatoryType설명비고
        projectNameMandatoryString프로젝트 이름
        projectDescMandatoryString프로젝트 설명
        useKkoBizMsgMandatoryBoolean비즈메시지 서비스 사용 여부
        usePushMandatoryBooleanPUSH 서비스 사용 여부
        useSmsMandatoryBooleanSMS 서비스 사용 여부
        createTimeMandatoryString생성 시간
        updateTimeMandatoryString수정 시간
        *Service.serviceIdMandatoryString서비스 아이디SMS, PUSH, KkoBizMsg 공통
        *Service.serviceNameMandatoryString서비스 이름SMS, PUSH, KkoBizMsg 공통
        *Service.createTimeMandatoryString서비스 생성 시간SMS, PUSH, KkoBizMsg 공통
        *Service.updateTimeOptionalString서비스 수정 시간SMS, PUSH, KkoBizMsg 공통
        smsService.useBlockServiceMandatoryBoolean080 수신 거부 번호 서비스 사용 여부
        smsService.blockService.availableOptionalBoolean사용 사능 여부
        smsService.blockService.companyNameOptionalString회사 이름
        smsService.blockService.statusNameOptionalString서비스 상태
        smsService.blockService.createTimeOptionalString서비스 생성 시간
        smsService.blockService.updateTimeOptionalString서비스 수정 시간

        응답 Status

        HTTP StatusDesc
        200OK (수정 완료)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        429Too Many Requests
        500Internal Server Error

        프로젝트 다건 조회

        다건의 프로젝트를 조회합니다.

        요청 URL

        GET https://sens.apigw.ntruss.com/common/v2/projects
        
        x-ncp-apigw-timestamp: {Timestamp}
        x-ncp-iam-access-key: {Sub Account Access Key}
        x-ncp-apigw-signature-v2: {API Gateway Signature}
        HTTP

        Path Variables

        없음
        Plain text

        Parameters

        항목MandatoryType설명비고
        projectNameOptionalString프로젝트 이름like 조회 결과를 반환
        pageSizeOptionalInteger페이지 사이즈default: 100
        1 ~ 100 사이의 숫자만 입력 가능
        pageIndexOptionalInteger페이지 인덱스default: 0

        Headers

        API Header 바로가기

        요청 Body

        없음
        JSON

        응답 Body

        [
            {
                "projectId": "string",
                "projectName": "string",
                "projectDesc": "string",
                "usePush": "boolean",
                "useSms": "boolean",
                "useKkoBizMsg": "boolean",
                "pushService": {
                    "serviceId": "string",
                    "serviceName": "string",
                    "createTime": "localDateTime",
                    "updateTime": "localDateTime"
                },
                "smsService": {
                    "serviceId": "string",
                    "serviceName": "string",
                    "createTime": "localDateTime",
                    "updateTime": "localDateTime",
                    "useBlockService": "boolean",
                    "blockService": {
                        "available": "boolean",
                        "companyName": "string",
                        "statusName": "string",
                        "createTime": "localDateTime",
                        "updateTime": "localDateTime"
                    }
                },
                "kkoBizMsgService": {
                    "serviceId": "string",
                    "serviceName": "string",
                    "createTime": "localDateTime",
                    "updateTime": "localDateTime"
                },
                "createTime": "localDateTime",
                "updateTime": "localDateTime"
            }
        ]
        JSON
        항목MandatoryType설명비고
        projectNameMandatoryString프로젝트 이름
        projectDescMandatoryString프로젝트 설명
        useKkoBizMsgMandatoryBoolean비즈메시지 서비스 사용 여부
        usePushMandatoryBooleanPUSH 서비스 사용 여부
        useSmsMandatoryBooleanSMS 서비스 사용 여부
        createTimeMandatoryString생성 시간
        updateTimeOptionalString생성 시간
        *Service.serviceIdMandatoryString서비스 아이디SMS, PUSH, KkoBizMsg 공통
        *Service.serviceNameMandatoryString서비스 이름SMS, PUSH, KkoBizMsg 공통
        *Service.createTimeMandatoryString서비스 생성 시간SMS, PUSH, KkoBizMsg 공통
        *Service.updateTimeOptionalString서비스 수정 시간SMS, PUSH, KkoBizMsg 공통
        smsService.useBlockServiceMandatoryBoolean080 수신 거부 번호 서비스 사용 여부
        smsService.blockService.availableOptionalBoolean사용 사능 여부
        smsService.blockService.companyNameOptionalString회사 이름
        smsService.blockService.statusNameOptionalString서비스 상태
        smsService.blockService.createTimeOptionalString서비스 생성 시간
        smsService.blockService.updateTimeOptionalString서비스 수정 시간

        응답 Status

        HTTP StatusDesc
        200OK (조회 완료)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error

        프로젝트 단건 조회

        단건의 프로젝트를 조회합니다.

        요청 URL

        GET https://sens.apigw.ntruss.com/common/v2/projects/{projectId}
        
        x-ncp-apigw-timestamp: {Timestamp}
        x-ncp-iam-access-key: {Sub Account Access Key}
        x-ncp-apigw-signature-v2: {API Gateway Signature}
        HTTP

        Path Variables

        항목MandatoryType설명비고
        projectIdMandatoryString프로젝트 아이디프로젝트 생성 시 발급받은 프로젝트 아이디

        Parameters

        없음
        JSON

        Headers

        API Header 바로가기

        요청 Body

        없음
        JSON

        응답 Body

        {
          "projectId": "string",
          "projectName": "string",
          "projectDesc": "string",
          "usePush": "boolean",
          "useSms": "boolean",
          "useKkoBizMsg": "boolean",
          "pushService": {
            "serviceId": "string",
            "serviceName": "string",
            "createTime": "localDateTime",
            "updateTime": "localDateTime"
          },
          "smsService": {
            "serviceId": "string",
            "serviceName": "string",
            "createTime": "localDateTime",
            "updateTime": "localDateTime",
            "useBlockService": "boolean",
                    "blockService": {
                        "available": "boolean",
                        "companyName": "string",
                        "statusName": "string",
                        "createTime": "localDateTime",
                        "updateTime": "localDateTime"
                    }
          },
          "kkoBizMsgService": {
            "serviceId": "string",
            "serviceName": "string",
            "createTime": "localDateTime",
            "updateTime": "localDateTime"
          },
          "createTime": "localDateTime",
          "updateTime": "localDateTime"
        }
        JSON
        항목MandatoryType설명비고
        projectNameMandatoryString프로젝트 이름
        projectDescMandatoryString프로젝트 설명
        useKkoBizMsgMandatoryBoolean비즈메시지 서비스 사용 여부
        usePushMandatoryBooleanPUSH 서비스 사용 여부
        useSmsMandatoryBooleanSMS 서비스 사용 여부
        createTimeMandatoryString생성 시간
        updateTimeOptionalString생성 시간
        *Service.serviceIdMandatoryString서비스 아이디SMS, PUSH, KkoBizMsg 공통
        *Service.serviceNameMandatoryString서비스 이름SMS, PUSH, KkoBizMsg 공통
        *Service.createTimeMandatoryString서비스 생성 시간SMS, PUSH, KkoBizMsg 공통
        *Service.updateTimeOptionalString서비스 수정 시간SMS, PUSH, KkoBizMsg 공통
        smsService.useBlockServiceMandatoryBoolean080 수신 거부 번호 서비스 사용 여부
        smsService.blockService.availableOptionalBoolean사용 사능 여부
        smsService.blockService.companyNameOptionalString회사 이름
        smsService.blockService.statusNameOptionalString서비스 상태
        smsService.blockService.createTimeOptionalString서비스 생성 시간
        smsService.blockService.updateTimeOptionalString서비스 수정 시간

        응답 Status

        HTTP StatusDesc
        200OK (조회 완료)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error

        프로젝트 삭제

        프로젝트를 삭제합니다.

        요청 URL

        DELETE https://sens.apigw.ntruss.com/common/v2/projects/{projectId}
        
        x-ncp-apigw-timestamp: {Timestamp}
        x-ncp-iam-access-key: {Sub Account Access Key}
        x-ncp-apigw-signature-v2: {API Gateway Signature}
        HTTP

        Path Variables

        항목MandatoryType설명비고
        projectIdMandatoryString프로젝트 아이디프로젝트 생성 시 발급받은 프로젝트 아이디

        Parameters

        없음
        JSON

        Headers

        API Header 바로가기

        요청 Body

        없음
        JSON

        응답 Body

        없음
        JSON

        응답 Status

        HTTP StatusDesc
        204No Content (삭제 완료)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error
        429Too Many Requests

        이 문서가 도움이 되었습니까?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.