MENU
      Project API

        Project API


        Article summary

        Basic information

        API URL

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

        Go to SENS Project API Swagger

        API Header

        ItemsMandatoryDescription
        Content-TypeMandatorySpecify the request body content type as application/json (POST)
        x-ncp-apigw-timestampMandatory- This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
        - Request is considered invalid if the timestamp differs from the current time by more than 5 minutes
        x-ncp-iam-access-keyMandatoryAccess key ID issued by the portal or Sub Account
        x-ncp-apigw-signature-v2Mandatory- Signature that encrypts the body of the example above with secret key mapped to the access key ID
        - Use the HMAC-SHA256 encryption algorithm

        Go to NAVER Cloud Platform authentication key and signature creation guide


        Project

        Create project

        Create project.

        Request 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

        None
        JSON

        Headers

        Go to API header

        Request body

        {
          "projectName": "string",
          "projectDesc": "string",
          "useKkoBizMsg": "boolean",
          "usePush": "boolean",
          "useSms": "boolean"
        }
        JSON
        ItemsMandatoryTypeDescriptionRemarks
        projectNameMandatoryStringProject name- Only English lowercase letters, numbers, hyphens (-), and underscores (_) are allowed
        - Up to 24 characters
        projectDescOptionalStringProject descriptionUp to 128 characters
        useKkoBizMsgOptionalBooleanUse status of Biz Message servicedefault: false
        usePushOptionalBooleanUse status of PUSH servicedefault: false
        useSmsOptionalBooleanUse status of SMS servicedefault: false
        • For useKkoBizMsg, usePush, and useSms, false is the default value if not specified.
        • Even if it's false, meta information is generated for each service, and you can change the usage status later.

        Response 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
        ItemsMandatoryTypeDescriptionRemarks
        projectNameMandatoryStringProject name
        projectDescMandatoryStringProject description
        useKkoBizMsgMandatoryBooleanUse status of Biz Message service
        usePushMandatoryBooleanUse status of PUSH service
        useSmsMandatoryBooleanUse status of SMS service
        createTimeMandatoryStringCreation time
        updateTimeOptionalStringCreation time
        *Service.serviceIdMandatoryStringService IDCommon for SMS, PUSH, KkoBizMsg
        *Service.serviceNameMandatoryStringService nameCommon for SMS, PUSH, KkoBizMsg
        *Service.createTimeMandatoryStringService creation timeCommon for SMS, PUSH, KkoBizMsg
        *Service.updateTimeOptionalStringService edit timeCommon for SMS, PUSH, KkoBizMsg
        smsService.useBlockServiceMandatoryBooleanUse status of 080 Block Call Service

        Response status

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

        Modify project

        Edit project.

        Request 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

        ItemsMandatoryTypeDescriptionRemarks
        projectIdMandatoryStringProject IDProject ID issued when creating the project

        Parameters

        None
        Plain text

        Headers

        Go to API header

        Request body

        {
          "projectDesc": "string",
          "useKkoBizMsg": "boolean",
          "usePush": "boolean",
          "useSms": "boolean"
        }
        JSON
        ItemsMandatoryTypeDescriptionRemarks
        projectDescOptionalStringProject descriptionUp to 128 characters
        useKkoBizMsgOptionalBooleanUse status of Biz Message servicedefault: false
        usePushOptionalBooleanUse status of PUSH servicedefault: false
        useSmsOptionalBooleanUse status of SMS servicedefault: false
        • For projectName, even if you use a name that is different from the existing name, it will not be modified.
        • For useKkoBizMsg, usePush, and useSms, the default value is changed to false if not specified.

        Response 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
        ItemsMandatoryTypeDescriptionRemarks
        projectNameMandatoryStringProject name
        projectDescMandatoryStringProject description
        useKkoBizMsgMandatoryBooleanUse status of Biz Message service
        usePushMandatoryBooleanUse status of PUSH service
        useSmsMandatoryBooleanUse status of SMS service
        createTimeMandatoryStringCreation time
        updateTimeMandatoryStringEdited time
        *Service.serviceIdMandatoryStringService IDCommon for SMS, PUSH, KkoBizMsg
        *Service.serviceNameMandatoryStringService nameCommon for SMS, PUSH, KkoBizMsg
        *Service.createTimeMandatoryStringService creation timeCommon for SMS, PUSH, KkoBizMsg
        *Service.updateTimeOptionalStringService edit timeCommon for SMS, PUSH, KkoBizMsg
        smsService.useBlockServiceMandatoryBooleanUse status of 080 Block Call Service
        smsService.blockService.availableOptionalBooleanStatus of availability
        smsService.blockService.companyNameOptionalStringCompany name
        smsService.blockService.statusNameOptionalStringService status
        smsService.blockService.createTimeOptionalStringService creation time
        smsService.blockService.updateTimeOptionalStringService edit time

        Response status

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

        Search multiple projects

        Get multiple projects.

        Request 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

        None
        Plain text

        Parameters

        ItemsMandatoryTypeDescriptionRemarks
        projectNameOptionalStringProject namelike search results are returned
        pageSizeOptionalIntegerPage sizedefault: 100
        Only numbers between 1 and 100 can be entered
        pageIndexOptionalIntegerPage indexdefault: 0

        Headers

        Go to API header

        Request body

        None
        JSON

        Response 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
        ItemsMandatoryTypeDescriptionRemarks
        projectNameMandatoryStringProject name
        projectDescMandatoryStringProject description
        useKkoBizMsgMandatoryBooleanUse status of Biz Message service
        usePushMandatoryBooleanUse status of PUSH service
        useSmsMandatoryBooleanUse status of SMS service
        createTimeMandatoryStringCreation time
        updateTimeOptionalStringCreation time
        *Service.serviceIdMandatoryStringService IDCommon for SMS, PUSH, KkoBizMsg
        *Service.serviceNameMandatoryStringService nameCommon for SMS, PUSH, KkoBizMsg
        *Service.createTimeMandatoryStringService creation timeCommon for SMS, PUSH, KkoBizMsg
        *Service.updateTimeOptionalStringService edit timeCommon for SMS, PUSH, KkoBizMsg
        smsService.useBlockServiceMandatoryBooleanUse status of 080 Block Call Service
        smsService.blockService.availableOptionalBooleanStatus of availability
        smsService.blockService.companyNameOptionalStringCompany name
        smsService.blockService.statusNameOptionalStringService status
        smsService.blockService.createTimeOptionalStringService creation time
        smsService.blockService.updateTimeOptionalStringService edit time

        Response status

        HTTP StatusDesc
        200OK (search completed)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error

        Search single project

        This searches a single project.

        Request 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

        ItemsMandatoryTypeDescriptionRemarks
        projectIdMandatoryStringProject IDProject ID issued when creating the project

        Parameters

        None
        JSON

        Headers

        Go to API header

        Request body

        None
        JSON

        Response 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
        ItemsMandatoryTypeDescriptionRemarks
        projectNameMandatoryStringProject name
        projectDescMandatoryStringProject description
        useKkoBizMsgMandatoryBooleanUse status of Biz Message service
        usePushMandatoryBooleanUse status of PUSH service
        useSmsMandatoryBooleanUse status of SMS service
        createTimeMandatoryStringCreation time
        updateTimeOptionalStringCreation time
        *Service.serviceIdMandatoryStringService IDCommon for SMS, PUSH, KkoBizMsg
        *Service.serviceNameMandatoryStringService nameCommon for SMS, PUSH, KkoBizMsg
        *Service.createTimeMandatoryStringService creation timeCommon for SMS, PUSH, KkoBizMsg
        *Service.updateTimeOptionalStringService edit timeCommon for SMS, PUSH, KkoBizMsg
        smsService.useBlockServiceMandatoryBooleanUse status of 080 Block Call Service
        smsService.blockService.availableOptionalBooleanStatus of availability
        smsService.blockService.companyNameOptionalStringCompany name
        smsService.blockService.statusNameOptionalStringService status
        smsService.blockService.createTimeOptionalStringService creation time
        smsService.blockService.updateTimeOptionalStringService edit time

        Response status

        HTTP StatusDesc
        200OK (search completed)
        400Bad Request
        401Unauthorized
        403Forbidden
        404Not Found
        500Internal Server Error

        Delete project

        Delete project.

        Request 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

        ItemsMandatoryTypeDescriptionRemarks
        projectIdMandatoryStringProject IDProject ID issued when creating the project

        Parameters

        None
        JSON

        Headers

        Go to API header

        Request body

        None
        JSON

        Response body

        None
        JSON

        Response status

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

        Was this article helpful?

        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.