Project API

Basic information

API URL

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

Go to SENS Project API Swagger

API Header

Category	Mandatory	Description
Content-Type	Mandatory	Specify the request body content type as application/json (POST).
x-ncp-apigw-timestamp	Mandatory	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-key	Mandatory	Access key ID issued by the portal or Sub Account
x-ncp-apigw-signature-v2	Mandatory	Signature used to encrypt the body of the above example with the secret key that maps with the access key ID. Use the HMAC-SHA256 encryption algorithm.

Go to NAVER Cloud Platform authentication key and signature creation guide

Number of projects

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}

Path Variables

None

Headers

Go to API header

Request body

{
  "projectName": "string",
  "projectDesc": "string",
  "useKkoBizMsg": "boolean",
  "useSms": "boolean"
}

Category	Mandatory	Type	Description	Remarks
projectName	Mandatory	String	Project name	Only English lowercase letters, numbers, hyphens (-), and underscores (_) are allowed. Up to 24 characters
projectDesc	Optional	String	Project description	Up to 128 characters
useKkoBizMsg	Optional	Boolean	Use status of Biz Message service	default: false
useSms	Optional	Boolean	Use status of SMS service	default: false

For useKkoBizMsg 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",
  "useSms": "boolean",
  "useKkoBizMsg": "boolean",
  "smsService": {
    "serviceId": "string",
    "serviceName": "string",
    "createTime": "localDateTime",
    "updateTime": "localDateTime",
    "useBlockService": "boolean"
  },
  "kkoBizMsgService": {
    "serviceId": "string",
    "serviceName": "string",
    "createTime": "localDateTime",
    "updateTime": "localDateTime"
  },
  "createTime": "localDateTime",
  "updateTime": "localDateTime"
}

Category	Mandatory	Type	Description	Remarks
projectName	Mandatory	String	Project name
projectDesc	Mandatory	String	Project description
useKkoBizMsg	Mandatory	Boolean	Use status of Biz Message service
useSms	Mandatory	Boolean	Use status of SMS service
createTime	Mandatory	String	Creation time
updateTime	Optional	String	Creation time
*Service.serviceId	Mandatory	String	Service ID	Common for SMS, KkoBizMsg
*Service.serviceName	Mandatory	String	Service name	Common for SMS, KkoBizMsg
*Service.createTime	Mandatory	String	Service creation time	Common for SMS, KkoBizMsg
*Service.updateTime	Optional	String	Service edit time	Common for SMS, KkoBizMsg
smsService.useBlockService	Mandatory	Boolean	Use status of 080 Block Call Service

Response status

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

Edit 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}

Path Variables

Category	Mandatory	Type	Description	Remarks
projectId	Mandatory	String	Project ID	Project ID issued when creating the project

Parameters

None

Headers

Go to API header

Request body

{
  "projectDesc": "string",
  "useKkoBizMsg": "boolean",
  "useSms": "boolean"
}

Category	Mandatory	Type	Description	Remarks
projectDesc	Optional	String	Project description	Up to 128 characters
useKkoBizMsg	Optional	Boolean	Use status of Biz Message service	default: false
useSms	Optional	Boolean	Use status of SMS service	default: false

For projectName, even if you use a name that is different from the existing name, it will not be modified.
For useKkoBizMsg and useSms, the default value is changed to false if not specified.

Response body

{
  "projectId": "string",
  "projectName": "string",
  "projectDesc": "string",
  "useSms": "boolean",
  "useKkoBizMsg": "boolean",
  "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"
}

Category	Mandatory	Type	Description	Remarks
projectName	Mandatory	String	Project name
projectDesc	Mandatory	String	Project description
useKkoBizMsg	Mandatory	Boolean	Use status of Biz Message service
useSms	Mandatory	Boolean	Use status of SMS service
createTime	Mandatory	String	Creation time
updateTime	Mandatory	String	Edited time
*Service.serviceId	Mandatory	String	Service ID	Common for SMS, KkoBizMsg
*Service.serviceName	Mandatory	String	Service name	Common for SMS, KkoBizMsg
*Service.createTime	Mandatory	String	Service creation time	Common for SMS, KkoBizMsg
*Service.updateTime	Optional	String	Service edit time	Common for SMS, KkoBizMsg
smsService.useBlockService	Mandatory	Boolean	Use status of 080 Block Call Service
smsService.blockService.available	Optional	Boolean	Status of availability
smsService.blockService.companyName	Optional	String	Company name
smsService.blockService.statusName	Optional	String	Service status
smsService.blockService.createTime	Optional	String	Service creation time
smsService.blockService.updateTime	Optional	String	Service edit time

Response status

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

Get 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}

Path Variables

None

Parameters

Category	Mandatory	Type	Description	Remarks
projectName	Optional	String	Project name	`like` search results are returned.
pageSize	Optional	Integer	Page size	default: 100 Only numbers between 1 and 100 can be entered.
pageIndex	Optional	Integer	Page index	default: 0

Headers

Go to API header

Request body

None

Response body

[
    {
        "projectId": "string",
        "projectName": "string",
        "projectDesc": "string",
        "useSms": "boolean",
        "useKkoBizMsg": "boolean",
        "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"
    }
]

Category	Mandatory	Type	Description	Remarks
projectName	Mandatory	String	Project name
projectDesc	Mandatory	String	Project description
useKkoBizMsg	Mandatory	Boolean	Use status of Biz Message service
useSms	Mandatory	Boolean	Use status of SMS service
createTime	Mandatory	String	Creation time
updateTime	Optional	String	Creation time
*Service.serviceId	Mandatory	String	Service ID	Common for SMS, KkoBizMsg
*Service.serviceName	Mandatory	String	Service name	Common for SMS, KkoBizMsg
*Service.createTime	Mandatory	String	Service creation time	Common for SMS, KkoBizMsg
*Service.updateTime	Optional	String	Service edit time	Common for SMS, KkoBizMsg
smsService.useBlockService	Mandatory	Boolean	Use status of 080 Block Call Service
smsService.blockService.available	Optional	Boolean	Status of availability
smsService.blockService.companyName	Optional	String	Company name
smsService.blockService.statusName	Optional	String	Service status
smsService.blockService.createTime	Optional	String	Service creation time
smsService.blockService.updateTime	Optional	String	Service edit time

Response status

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

Get 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}

Path Variables

Category	Mandatory	Type	Description	Remarks
projectId	Mandatory	String	Project ID	Project ID issued when creating the project

Parameters

None

Headers

Go to API header

Request body

None

Response body

{
  "projectId": "string",
  "projectName": "string",
  "projectDesc": "string",
  "useSms": "boolean",
  "useKkoBizMsg": "boolean",
  "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"
}

Category	Mandatory	Type	Description	Remarks
projectName	Mandatory	String	Project name
projectDesc	Mandatory	String	Project description
useKkoBizMsg	Mandatory	Boolean	Use status of Biz Message service
useSms	Mandatory	Boolean	Use status of SMS service
createTime	Mandatory	String	Creation time
updateTime	Optional	String	Creation time
*Service.serviceId	Mandatory	String	Service ID	Common for SMS, KkoBizMsg
*Service.serviceName	Mandatory	String	Service name	Common for SMS, KkoBizMsg
*Service.createTime	Mandatory	String	Service creation time	Common for SMS, KkoBizMsg
*Service.updateTime	Optional	String	Service edit time	Common for SMS, KkoBizMsg
smsService.useBlockService	Mandatory	Boolean	Use status of 080 Block Call Service
smsService.blockService.available	Optional	Boolean	Status of availability
smsService.blockService.companyName	Optional	String	Company name
smsService.blockService.statusName	Optional	String	Service status
smsService.blockService.createTime	Optional	String	Service creation time
smsService.blockService.updateTime	Optional	String	Service edit time

Response status

HTTP Status	Desc
200	OK (search completed)
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
500	Internal 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}

Path Variables

Category	Mandatory	Type	Description	Remarks
projectId	Mandatory	String	Project ID	Project ID issued when creating the project

Parameters

None

Headers

Go to API header

Request body

None

Response body

None

Response status

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