Login
      Contents x
      Project API
        • Print
        • PDF
        Contents

        Project API

          • Print
          • PDF
          Article summary

          The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

          Basic information

          API URL

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

          Go to SENS Project API Swagger

          API Header

          ItemMandatoryDescription
          Content-TypeMandatorySpecifies the request body content type as application/json (POST)
          x-ncp-apigw-timestampMandatory- Time elapsed in milliseconds since January 1, 1970 00:00:00 (UTC)
          - If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
          x-ncp-iam-access-keyMandatoryThis is the Access Key ID issued by the portal or Sub Account
          x-ncp-apigw-signature-v2Mandatory- Signature comprising the above example body encrypted with a SecretKey mapped with Access Key ID
          - HmacSHA256 is used as the HMAC encryption algorithm.

          Go to the creation guide of NAVER Cloud Platform authentication key and signature

          Project

          Create project

          Creates a 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}

          Path Variables

          None

          Headers

          Go to API header

          Request body

          {
  "projectName": "string",
  "projectDesc": "string",
  "useKkoBizMsg": "boolean",
  "usePush": "boolean",
  "useSms": "boolean"
}
          ItemMandatoryTypeDescriptionRemarks
          projectNameMandatoryStringProject name- Only English lowercase letters, numbers, hyphens ( - ), and underscores ( _ ) can be entered.
          - 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, if not specified, false is used as a default value.
          • Even if the status is false, meta information corresponding to each service will be created, and the use status can be changed 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"
}
          ItemMandatoryTypeDescriptionRemarks
          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 IDSMS, PUSH, KkoBizMsg common
          *Service.serviceNameMandatoryStringService nameSMS, PUSH, KkoBizMsg common
          *Service.createTimeMandatoryStringService creation timeSMS, PUSH, KkoBizMsg common
          *Service.updateTimeOptionalStringService edit timeSMS, PUSH, KkoBizMsg common
          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

          Edit project

          This edits the 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}

          Path Variables

          ItemMandatoryTypeDescriptionRemarks
          projectIdMandatoryStringProject IDProject ID issued when creating project

          Parameters

          None

          Headers

          Go to API header

          Request body

          {
  "projectDesc": "string",
  "useKkoBizMsg": "boolean",
  "usePush": "boolean",
  "useSms": "boolean"
}
          ItemMandatoryTypeDescriptionRemarks
          projectDescOptionalStringProject descriptionUp to 128 characters
          useKkoBizMsgOptionalBooleanUse status of biz message servicedefault: false
          usePushOptionalBooleanUse status of PUSH servicedefault: false
          useSmsOptionalBooleanUse status of SMS servicedefault: false
          • In the case of projectName, even if you use a name that is different from the existing name, it will not be edited.
          • For useKkoBizMsg, usePush, and useSms, if not specified, changes to false as the default value.

          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"
}
          ItemMandatoryTypeDescriptionRemarks
          projectNameMandatoryStringProject name
          projectDescMandatoryStringProject description
          useKkoBizMsgMandatoryBooleanUse status of biz message service
          usePushMandatoryBooleanUse status of PUSH service
          useSmsMandatoryBooleanUse status of SMS service
          createTimeMandatoryStringCreation time
          updateTimeMandatoryStringEditing time
          *Service.serviceIdMandatoryStringService IDSMS, PUSH, KkoBizMsg common
          *Service.serviceNameMandatoryStringService nameSMS, PUSH, KkoBizMsg common
          *Service.createTimeMandatoryStringService creation timeSMS, PUSH, KkoBizMsg common
          *Service.updateTimeOptionalStringService edit timeSMS, PUSH, KkoBizMsg common
          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 for multiple projects

          Searches for 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}

          Path Variables

          None

          Parameters

          ItemMandatoryTypeDescriptionRemarks
          projectNameOptionalStringProject namelike Search results are returned.
          pageSizeOptionalIntegerPage sizedefault: 100
          Only the numbers between 1 and 100 can be entered.
          pageIndexOptionalIntegerPage indexdefault: 0

          Headers

          Go to API header

          Request body

          None

          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"
    }
]
          ItemMandatoryTypeDescriptionRemarks
          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 IDSMS, PUSH, KkoBizMsg common
          *Service.serviceNameMandatoryStringService nameSMS, PUSH, KkoBizMsg common
          *Service.createTimeMandatoryStringService creation timeSMS, PUSH, KkoBizMsg common
          *Service.updateTimeOptionalStringService edit timeSMS, PUSH, KkoBizMsg common
          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 searched)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Search for single project

          Searches for 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}

          Path Variables

          ItemMandatoryTypeDescriptionRemarks
          projectIdMandatoryStringProject IDProject ID issued when creating project

          Parameters

          None

          Headers

          Go to API header

          Request body

          None

          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"
}
          ItemMandatoryTypeDescriptionRemarks
          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 IDSMS, PUSH, KkoBizMsg common
          *Service.serviceNameMandatoryStringService nameSMS, PUSH, KkoBizMsg common
          *Service.createTimeMandatoryStringService creation timeSMS, PUSH, KkoBizMsg common
          *Service.updateTimeOptionalStringService edit timeSMS, PUSH, KkoBizMsg common
          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 searched)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error

          Delete project

          Deletes a 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}

          Path Variables

          ItemMandatoryTypeDescriptionRemarks
          projectIdMandatoryStringProject IDProject ID issued when creating project

          Parameters

          None

          Headers

          Go to API header

          Request body

          None

          Response body

          None

          Response status

          HTTP StatusDesc
          204No Content (successfully deleted)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error
          429Too Many Requests
          Was this article helpful?
          What's Next
          Change password!
          Changing your password will log you out immediately. Use the new password to log back in.
          Change profile
          Success!
          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.
          Logout