Project API
- Print
- PDF
Project API
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
Basic information
API URL
https://sens.apigw.ntruss.com/common/v2
Go to SENS Project API Swagger
API Header
Item | Mandatory | Description |
---|---|---|
Content-Type | Mandatory | Specifies the request body content type as application/json (POST) |
x-ncp-apigw-timestamp | Mandatory | - 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-key | Mandatory | This is the Access Key ID issued by the portal or Sub Account |
x-ncp-apigw-signature-v2 | Mandatory | - 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
Request body
{
"projectName": "string",
"projectDesc": "string",
"useKkoBizMsg": "boolean",
"usePush": "boolean",
"useSms": "boolean"
}
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
projectName | Mandatory | String | Project name | - Only English lowercase letters, numbers, hyphens ( - ), and underscores ( _ ) can be entered. - Up to 24 characters |
projectDesc | Optional | String | Project description | Up to 128 characters |
useKkoBizMsg | Optional | Boolean | Use status of biz message service | default: false |
usePush | Optional | Boolean | Use status of PUSH service | default: false |
useSms | Optional | Boolean | Use status of SMS service | default: 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"
}
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
projectName | Mandatory | String | Project name | |
projectDesc | Mandatory | String | Project description | |
useKkoBizMsg | Mandatory | Boolean | Use status of biz message service | |
usePush | Mandatory | Boolean | Use status of PUSH 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 | SMS, PUSH, KkoBizMsg common |
*Service.serviceName | Mandatory | String | Service name | SMS, PUSH, KkoBizMsg common |
*Service.createTime | Mandatory | String | Service creation time | SMS, PUSH, KkoBizMsg common |
*Service.updateTime | Optional | String | Service edit time | SMS, PUSH, KkoBizMsg common |
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
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
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
projectId | Mandatory | String | Project ID | Project ID issued when creating project |
Parameters
None
Headers
Request body
{
"projectDesc": "string",
"useKkoBizMsg": "boolean",
"usePush": "boolean",
"useSms": "boolean
}
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
projectDesc | Optional | String | Project description | Up to 128 characters |
useKkoBizMsg | Optional | Boolean | Use status of biz message service | default: false |
usePush | Optional | Boolean | Use status of PUSH service | default: false |
useSms | Optional | Boolean | Use status of SMS service | default: 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"
}
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
projectName | Mandatory | String | Project name | |
projectDesc | Mandatory | String | Project description | |
useKkoBizMsg | Mandatory | Boolean | Use status of biz message service | |
usePush | Mandatory | Boolean | Use status of PUSH service | |
useSms | Mandatory | Boolean | Use status of SMS service | |
createTime | Mandatory | String | Creation time | |
updateTime | Mandatory | String | Editing time | |
*Service.serviceId | Mandatory | String | Service ID | SMS, PUSH, KkoBizMsg common |
*Service.serviceName | Mandatory | String | Service name | SMS, PUSH, KkoBizMsg common |
*Service.createTime | Mandatory | String | Service creation time | SMS, PUSH, KkoBizMsg common |
*Service.updateTime | Optional | String | Service edit time | SMS, PUSH, KkoBizMsg common |
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 |
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
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
projectName | Optional | String | Project name | like Search results are returned. |
pageSize | Optional | Integer | Page size | default: 100 Only the numbers between 1 and 100 can be entered. |
pageIndex | Optional | Integer | Page index | default: 0 |
Headers
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"
}
]
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
projectName | Mandatory | String | Project name | |
projectDesc | Mandatory | String | Project description | |
useKkoBizMsg | Mandatory | Boolean | Use status of biz message service | |
usePush | Mandatory | Boolean | Use status of PUSH 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 | SMS, PUSH, KkoBizMsg common |
*Service.serviceName | Mandatory | String | Service name | SMS, PUSH, KkoBizMsg common |
*Service.createTime | Mandatory | String | Service creation time | SMS, PUSH, KkoBizMsg common |
*Service.updateTime | Optional | String | Service edit time | SMS, PUSH, KkoBizMsg common |
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 searched) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal 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
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
projectId | Mandatory | String | Project ID | Project ID issued when creating project |
Parameters
None
Headers
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"
}
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
projectName | Mandatory | String | Project name | |
projectDesc | Mandatory | String | Project description | |
useKkoBizMsg | Mandatory | Boolean | Use status of biz message service | |
usePush | Mandatory | Boolean | Use status of PUSH 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 | SMS, PUSH, KkoBizMsg common |
*Service.serviceName | Mandatory | String | Service name | SMS, PUSH, KkoBizMsg common |
*Service.createTime | Mandatory | String | Service creation time | SMS, PUSH, KkoBizMsg common |
*Service.updateTime | Optional | String | Service edit time | SMS, PUSH, KkoBizMsg common |
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 searched) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal 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
Item | Mandatory | Type | Description | Remarks |
---|---|---|---|---|
projectId | Mandatory | String | Project ID | Project ID issued when creating project |
Parameters
None
Headers
Request body
None
Response body
None
Response status
HTTP Status | Desc |
---|---|
204 | No Content (successfully deleted) |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
429 | Too Many Requests |
Was this article helpful?