基本情報
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とマッピングする Secret Keyで暗号化した署名
- 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
API Headerへ
リクエストボディ
{
"projectName": "string",
"projectDesc": "string",
"useKkoBizMsg": "boolean",
"useSms": "boolean"
}
| 項目 |
Mandatory |
Type |
説明 |
備考 |
| projectName |
Mandatory |
String |
プロジェクト名 |
- 英字の小文字、数字、ハイフン「-」、アンダースコア「_」のみ入力可能
- 最大24文字
|
| projectDesc |
Optional |
String |
プロジェクトの説明 |
最大128文字 |
| useKkoBizMsg |
Optional |
Boolean |
BizMessageサービスのの使用有無 |
デフォルト: false |
| useSms |
Optional |
Boolean |
SMSサービスのの使用有無 |
デフォルト: false |
- useKkoBizMsg、useSmsの場合、明示しないとデフォルトとして falseが使用されます。
- 使用有無が falseであっても、それぞれのサービスに該当するメタ情報が作成され、その後、使用有無も変更できます。
レスポンスボディ
{
"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"
}
| 項目 |
Mandatory |
Type |
説明 |
備考 |
| projectName |
Mandatory |
String |
プロジェクト名 |
|
| projectDesc |
Mandatory |
String |
プロジェクトの説明 |
|
| useKkoBizMsg |
Mandatory |
Boolean |
BizMessageサービスのの使用有無 |
|
| useSms |
Mandatory |
Boolean |
SMSサービスのの使用有無 |
|
| createTime |
Mandatory |
String |
作成時間 |
|
| updateTime |
Optional |
String |
作成時間 |
|
| *Service.serviceId |
Mandatory |
String |
サービス ID |
SMS、KkoBizMsg共通 |
| *Service.serviceName |
Mandatory |
String |
サービス名 |
SMS、KkoBizMsg共通 |
| *Service.createTime |
Mandatory |
String |
サービスの作成時間 |
SMS、KkoBizMsg共通 |
| *Service.updateTime |
Optional |
String |
サービスの更新時間 |
SMS、KkoBizMsg共通 |
| smsService.useBlockService |
Mandatory |
Boolean |
080受信拒否番号サービスの使用の有無 |
|
レスポンスステータス
| 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
API Headerへ
リクエストボディ
{
"projectDesc": "string",
"useKkoBizMsg": "boolean",
"useSms": "boolean"
}
| 項目 |
Mandatory |
Type |
説明 |
備考 |
| projectDesc |
Optional |
String |
プロジェクトの説明 |
最大128文字 |
| useKkoBizMsg |
Optional |
Boolean |
BizMessageサービスのの使用有無 |
デフォルト: false |
| useSms |
Optional |
Boolean |
SMSサービスのの使用有無 |
デフォルト: false |
- projectNameの場合、既存の名前と異なる名前を使用しても変更されません。
- useKkoBizMsg、useSmsの場合、明示しないとデフォルトの falseに変更されます。
レスポンスボディ
{
"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"
}
| 項目 |
Mandatory |
Type |
説明 |
備考 |
| projectName |
Mandatory |
String |
プロジェクト名 |
|
| projectDesc |
Mandatory |
String |
プロジェクトの説明 |
|
| useKkoBizMsg |
Mandatory |
Boolean |
BizMessageサービスのの使用有無 |
|
| useSms |
Mandatory |
Boolean |
SMSサービスのの使用有無 |
|
| createTime |
Mandatory |
String |
作成時間 |
|
| updateTime |
Mandatory |
String |
更新時間 |
|
| *Service.serviceId |
Mandatory |
String |
サービス ID |
SMS、KkoBizMsg共通 |
| *Service.serviceName |
Mandatory |
String |
サービス名 |
SMS、KkoBizMsg共通 |
| *Service.createTime |
Mandatory |
String |
サービスの作成時間 |
SMS、KkoBizMsg共通 |
| *Service.updateTime |
Optional |
String |
サービスの更新時間 |
SMS、KkoBizMsg共通 |
| 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 |
サービスの作成時間 |
|
| smsService.blockService.updateTime |
Optional |
String |
サービスの更新時間 |
|
レスポンスステータス
| 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 |
ページサイズ |
デフォルト: 100
1~100までの数字のみ入力可能 |
| pageIndex |
Optional |
Integer |
ページインデックス |
デフォルト: 0 |
Headers
API Headerへ
リクエストボディ
なし
レスポンスボディ
[
{
"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"
}
]
| 項目 |
Mandatory |
Type |
説明 |
備考 |
| projectName |
Mandatory |
String |
プロジェクト名 |
|
| projectDesc |
Mandatory |
String |
プロジェクトの説明 |
|
| useKkoBizMsg |
Mandatory |
Boolean |
BizMessageサービスのの使用有無 |
|
| useSms |
Mandatory |
Boolean |
SMSサービスのの使用有無 |
|
| createTime |
Mandatory |
String |
作成時間 |
|
| updateTime |
Optional |
String |
作成時間 |
|
| *Service.serviceId |
Mandatory |
String |
サービス ID |
SMS、KkoBizMsg共通 |
| *Service.serviceName |
Mandatory |
String |
サービス名 |
SMS、KkoBizMsg共通 |
| *Service.createTime |
Mandatory |
String |
サービスの作成時間 |
SMS、KkoBizMsg共通 |
| *Service.updateTime |
Optional |
String |
サービスの更新時間 |
SMS、KkoBizMsg共通 |
| 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 |
サービスの作成時間 |
|
| smsService.blockService.updateTime |
Optional |
String |
サービスの更新時間 |
|
レスポンスステータス
| 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
API Headerへ
リクエストボディ
なし
レスポンスボディ
{
"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"
}
| 項目 |
Mandatory |
Type |
説明 |
備考 |
| projectName |
Mandatory |
String |
プロジェクト名 |
|
| projectDesc |
Mandatory |
String |
プロジェクトの説明 |
|
| useKkoBizMsg |
Mandatory |
Boolean |
BizMessageサービスのの使用有無 |
|
| useSms |
Mandatory |
Boolean |
SMSサービスのの使用有無 |
|
| createTime |
Mandatory |
String |
作成時間 |
|
| updateTime |
Optional |
String |
作成時間 |
|
| *Service.serviceId |
Mandatory |
String |
サービス ID |
SMS、KkoBizMsg共通 |
| *Service.serviceName |
Mandatory |
String |
サービス名 |
SMS、KkoBizMsg共通 |
| *Service.createTime |
Mandatory |
String |
サービスの作成時間 |
SMS、KkoBizMsg共通 |
| *Service.updateTime |
Optional |
String |
サービスの更新時間 |
SMS、KkoBizMsg共通 |
| 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 |
サービスの作成時間 |
|
| smsService.blockService.updateTime |
Optional |
String |
サービスの更新時間 |
|
レスポンスステータス
| 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
API Headerへ
リクエストボディ
なし
レスポンスボディ
なし
レスポンスステータス
| HTTP Status |
Desc |
| 204 |
No Content(削除完了) |
| 400 |
Bad Request |
| 401 |
Unauthorized |
| 403 |
Forbidden |
| 404 |
Not Found |
| 500 |
Internal Server Error |
| 429 |
Too Many Requests |