Project API

印刷する
共有
PDF

Project API

印刷する
共有
PDF

Article Summary

Share feedback

Thanks for sharing your feedback!

基本情報

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 Cloud Platformの認証キーおよび 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に移動する

リクエスト Body

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

項目	Mandatory	Type	説明	備考
projectName	Mandatory	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	Mandatory	String	プロジェクト名
projectDesc	Mandatory	String	プロジェクトの説明
useKkoBizMsg	Mandatory	Boolean	bizメッセージサービスの使用有無
usePush	Mandatory	Boolean	PUSHサービスの使用有無
useSms	Mandatory	Boolean	SMSサービスの使用有無
createTime	Mandatory	String	作成時間
updateTime	Optional	String	作成時間
*Service.serviceId	Mandatory	String	サービス ID	SMS、PUSH、KkoBizMsg共通
*Service.serviceName	Mandatory	String	サービス名	SMS、PUSH、KkoBizMsg共通
*Service.createTime	Mandatory	String	サービスの作成時間	SMS、PUSH、KkoBizMsg共通
*Service.updateTime	Optional	String	サービスの修正時間	SMS、PUSH、KkoBizMsg共通
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

API Headerに移動する

リクエスト 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	Mandatory	String	プロジェクト名
projectDesc	Mandatory	String	プロジェクトの説明
useKkoBizMsg	Mandatory	Boolean	bizメッセージサービスの使用有無
usePush	Mandatory	Boolean	PUSHサービスの使用有無
useSms	Mandatory	Boolean	SMSサービスの使用有無
createTime	Mandatory	String	作成時間
updateTime	Mandatory	String	修正時間
*Service.serviceId	Mandatory	String	サービス ID	SMS、PUSH、KkoBizMsg共通
*Service.serviceName	Mandatory	String	サービス名	SMS、PUSH、KkoBizMsg共通
*Service.createTime	Mandatory	String	サービスの作成時間	SMS、PUSH、KkoBizMsg共通
*Service.updateTime	Optional	String	サービスの修正時間	SMS、PUSH、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	サービスの修正時間

レスポンス 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

API Headerに移動する

リクエスト 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	Mandatory	String	プロジェクト名
projectDesc	Mandatory	String	プロジェクトの説明
useKkoBizMsg	Mandatory	Boolean	bizメッセージサービスの使用有無
usePush	Mandatory	Boolean	PUSHサービスの使用有無
useSms	Mandatory	Boolean	SMSサービスの使用有無
createTime	Mandatory	String	作成時間
updateTime	Optional	String	作成時間
*Service.serviceId	Mandatory	String	サービス ID	SMS、PUSH、KkoBizMsg共通
*Service.serviceName	Mandatory	String	サービス名	SMS、PUSH、KkoBizMsg共通
*Service.createTime	Mandatory	String	サービスの作成時間	SMS、PUSH、KkoBizMsg共通
*Service.updateTime	Optional	String	サービスの修正時間	SMS、PUSH、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	サービスの修正時間

レスポンス 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

API Headerに移動する

リクエスト 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	Mandatory	String	プロジェクト名
projectDesc	Mandatory	String	プロジェクトの説明
useKkoBizMsg	Mandatory	Boolean	bizメッセージサービスの使用有無
usePush	Mandatory	Boolean	PUSHサービスの使用有無
useSms	Mandatory	Boolean	SMSサービスの使用有無
createTime	Mandatory	String	作成時間
updateTime	Optional	String	作成時間
*Service.serviceId	Mandatory	String	サービス ID	SMS、PUSH、KkoBizMsg共通
*Service.serviceName	Mandatory	String	サービス名	SMS、PUSH、KkoBizMsg共通
*Service.createTime	Mandatory	String	サービスの作成時間	SMS、PUSH、KkoBizMsg共通
*Service.updateTime	Optional	String	サービスの修正時間	SMS、PUSH、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	サービスの修正時間

レスポンス 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}