Project API
- 印刷する
- PDF
Project API
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
基本情報
API URL
https://sens.apigw.ntruss.com/common/v2
SENS Project API Swaggerに移動する
API Header
| 項目 | Mandatory | 説明 |
|---|---|---|
| Content-Type | Mandatory | リクエストBody Content Typeをapplication/jsonに指定(POST) |
| x-ncp-apigw-timestamp | Mandatory | 1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で表したものである。 API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす |
| x-ncp-iam-access-key | Mandatory | ポータルまたはSub Accountが発行したAccess Key ID |
| x-ncp-apigw-signature-v2 | Mandatory | 上記の例のBodyをAccess Key IDとマッピングするSecretKeyで暗号化した署名 HMAC暗号化アルゴリズムはHmacSHA256を使用 |
NAVERクラウドプラットフォームの認証キー及び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}
Path Variables
なし
Headers
リクエストBody
{
"projectName": "string",
"projectDesc": "string",
"useKkoBizMsg": "boolean",
"usePush": "boolean",
"useSms": "boolean
}
| 項目 | Mandatory | Type | 説明 | 備考 |
|---|---|---|---|---|
| projectName | Madatory | String | プロジェクト名 | アルファベットの小文字、数字、-、_のみ入力可能最大24文字 |
| projectDesc | Optional | String | プロジェクトの説明 | 最大128文字 |
| useKkoBizMsg | Optional | Boolean | bizメッセージサービスの使用の有無 | default: false |
| usePush | Optional | Boolean | PUSHサービスの使用の有無 | default: false |
| useSms | Optional | Boolean | SMSサービスの使用の有無 | 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"
}
| 項目 | Mandatory | Type | 説明 | 備考 |
|---|---|---|---|---|
| projectName | Madatory | String | プロジェクト名 | |
| projectDesc | Mandatory | String | プロジェクトの説明 | |
| useKkoBizMsg | Mandatory | Boolean | bizメッセージサービスの使用の有無 | |
| usePush | Mandatory | Boolean | PUSHサービスの使用の有無 | |
| useSms | Mandatory | Boolean | SMSサービスの使用の有無 | |
| createTime | Mandatory | String | 作成時間 | format：LocalDateTime(説明) |
| updateTime | Optional | String | 作成時間 | format: LocalDateTime |
| *Service.serviceId | Mandatory | String | サービスID | SMS、PUSH、KkoBizMsg共通 |
| *Service.serviceName | Mandatory | String | サービス名 | SMS、PUSH、KkoBizMsg共通 |
| *Service.createTime | Mandatory | String | サービスの作成時間 | SMS、PUSH、KkoBizMsg共通 format: LocalDateTime |
| *Service.updateTime | Optional | String | サービスの修正時間 | SMS、PUSH、KkoBizMsg共通 format: LocalDateTime |
| smsService.useBlockService | Mandatory | Boolean | 080受信拒否番号サービスの使用の有無 |
レスポンスStatus
| HTTP Status | Desc |
|---|---|
| 200 | OK (作成完了) |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 429 | Too Many Requests |
| 500 | Internal 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}
Path Variables
| 項目 | Mandatory | Type | 説明 | 備考 |
|---|---|---|---|---|
| projectId | Mandatory | String | プロジェクトID | プロジェクトを作成する時に発行されたプロジェクトID |
Parameters
なし
Headers
リクエストBody
{
"projectDesc": "string",
"useKkoBizMsg": "boolean",
"usePush": "boolean",
"useSms": "boolean
}
| 項目 | Mandatory | Type | 説明 | 備考 |
|---|---|---|---|---|
| projectDesc | Optional | String | プロジェクトの説明 | 最大128文字 |
| useKkoBizMsg | Optional | Boolean | bizメッセージサービスの使用の有無 | default: false |
| usePush | Optional | Boolean | PUSHサービスの使用の有無 | default: false |
| useSms | Optional | Boolean | SMSサービスの使用の有無 | 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"
}
| 項目 | Mandatory | Type | 説明 | 備考 |
|---|---|---|---|---|
| projectName | Madatory | String | プロジェクト名 | |
| projectDesc | Mandatory | String | プロジェクトの説明 | |
| useKkoBizMsg | Mandatory | Boolean | bizメッセージサービスの使用の有無 | |
| usePush | Mandatory | Boolean | PUSHサービスの使用の有無 | |
| useSms | Mandatory | Boolean | SMSサービスの使用の有無 | |
| createTime | Mandatory | String | 作成時間 | format：LocalDateTime(説明) |
| updateTime | Mandatory | String | 修正時間 | format: LocalDateTime |
| *Service.serviceId | Mandatory | String | サービスID | SMS、PUSH、KkoBizMsg共通 |
| *Service.serviceName | Mandatory | String | サービス名 | SMS、PUSH、KkoBizMsg共通 |
| *Service.createTime | Mandatory | String | サービスの作成時間 | SMS、PUSH、KkoBizMsg共通 format: LocalDateTime |
| *Service.updateTime | Optional | String | サービスの修正時間 | SMS、PUSH、KkoBizMsg共通 format: LocalDateTime |
| smsService.useBlockService | Mandatory | Boolean | 080受信拒否番号サービスの使用の有無 | |
| smsService.blockService.available | Optional | Boolean | 使用可能か否か | |
| smsService.blockService.companyName | Optional | String | 会社名 | |
| smsService.blockService.statusName | Optional | String | サービスの状態 | |
| smsService.blockService.createTime | Optional | String | サービスの作成時間 | format: LocalDateTime |
| smsService.blockService.updateTime | Optional | String | サービスの修正時間 | format: LocalDateTime |
レスポンスStatus
| HTTP Status | Desc |
|---|---|
| 200 | OK (修正完了) |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 429 | Too Many Requests |
| 500 | Internal 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}
Path Variables
なし
Parameters
| 項目 | Mandatory | Type | 説明 | 備考 |
|---|---|---|---|---|
| projectName | Optional | String | プロジェクト名 | like照会結果を返す |
| pageSize | Optional | Integer | ページサイズ | default: 100 1～100までの数字のみ入力可能 |
| pageIndex | Optional | Integer | ページインデックス | default: 0 |
Headers
リクエストBody
なし
レスポンス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"
}
]
| 項目 | Mandatory | Type | 説明 | 備考 |
|---|---|---|---|---|
| projectName | Madatory | String | プロジェクト名 | |
| projectDesc | Mandatory | String | プロジェクトの説明 | |
| useKkoBizMsg | Mandatory | Boolean | bizメッセージサービスの使用の有無 | |
| usePush | Mandatory | Boolean | PUSHサービスの使用の有無 | |
| useSms | Mandatory | Boolean | SMSサービスの使用の有無 | |
| createTime | Mandatory | String | 作成時間 | format：LocalDateTime(説明) |
| updateTime | Optional | String | 作成時間 | format: LocalDateTime |
| *Service.serviceId | Mandatory | String | サービスID | SMS、PUSH、KkoBizMsg共通 |
| *Service.serviceName | Mandatory | String | サービス名 | SMS、PUSH、KkoBizMsg共通 |
| *Service.createTime | Mandatory | String | サービスの作成時間 | SMS、PUSH、KkoBizMsg共通 format: LocalDateTime |
| *Service.updateTime | Optional | String | サービスの修正時間 | SMS、PUSH、KkoBizMsg共通 format: LocalDateTime |
| smsService.useBlockService | Mandatory | Boolean | 080受信拒否番号サービスの使用の有無 | |
| smsService.blockService.available | Optional | Boolean | 使用可能か否か | |
| smsService.blockService.companyName | Optional | String | 会社名 | |
| smsService.blockService.statusName | Optional | String | サービスの状態 | |
| smsService.blockService.createTime | Optional | String | サービスの作成時間 | format: LocalDateTime |
| smsService.blockService.updateTime | Optional | String | サービスの修正時間 | format: LocalDateTime |
レスポンスStatus
| HTTP Status | Desc |
|---|---|
| 200 | OK (照会完了) |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal 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}
Path Variables
| 項目 | Mandatory | Type | 説明 | 備考 |
|---|---|---|---|---|
| projectId | Mandatory | String | プロジェクトID | プロジェクトを作成する時に発行されたプロジェクトID |
Parameters
なし
Headers
リクエストBody
なし
レスポンス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"
}
| 項目 | Mandatory | Type | 説明 | 備考 |
|---|---|---|---|---|
| projectName | Madatory | String | プロジェクト名 | |
| projectDesc | Mandatory | String | プロジェクトの説明 | |
| useKkoBizMsg | Mandatory | Boolean | bizメッセージサービスの使用の有無 | |
| usePush | Mandatory | Boolean | PUSHサービスの使用の有無 | |
| useSms | Mandatory | Boolean | SMSサービスの使用の有無 | |
| createTime | Mandatory | String | 作成時間 | format：LocalDateTime(説明) |
| updateTime | Optional | String | 作成時間 | format: LocalDateTime |
| *Service.serviceId | Mandatory | String | サービスID | SMS、PUSH、KkoBizMsg共通 |
| *Service.serviceName | Mandatory | String | サービス名 | SMS、PUSH、KkoBizMsg共通 |
| *Service.createTime | Mandatory | String | サービスの作成時間 | SMS、PUSH、KkoBizMsg共通 format: LocalDateTime |
| *Service.updateTime | Optional | String | サービスの修正時間 | SMS、PUSH、KkoBizMsg共通 format: LocalDateTime |
| smsService.useBlockService | Mandatory | Boolean | 080受信拒否番号サービスの使用の有無 | |
| smsService.blockService.available | Optional | Boolean | 使用可能か否か | |
| smsService.blockService.companyName | Optional | String | 会社名 | |
| smsService.blockService.statusName | Optional | String | サービスの状態 | |
| smsService.blockService.createTime | Optional | String | サービスの作成時間 | format: LocalDateTime |
| smsService.blockService.updateTime | Optional | String | サービスの修正時間 | format: LocalDateTime |
レスポンスStatus
| HTTP Status | Desc |
|---|---|
| 200 | OK (照会完了) |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal 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}
Path Variables
| 項目 | Mandatory | Type | 説明 | 備考 |
|---|---|---|---|---|
| projectId | Mandatory | String | プロジェクトID | プロジェクトを作成する時に発行されたプロジェクトID |
Parameters
なし
Headers
リクエストBody
なし
レスポンスBody
なし
レスポンスStatus
| HTTP Status | Desc |
|---|---|
| 204 | No Content(削除完了) |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
| 429 | Too Many Requests |
この記事は役に立ちましたか?