Login
      目次 x
      Project API
        • 印刷する
        • PDF
        目次

        Project API

          • 印刷する
          • PDF
          記事の要約

          最新のコンテンツが反映されていません。早急にアップデート内容をご提供できるよう努めております。最新のコンテンツ内容は韓国語ページをご参照ください。

          基本情報

          API URL

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

          SENS Project API Swaggerに移動する

          API Header

          項目Mandatory説明
          Content-TypeMandatoryリクエストBody Content Typeをapplication/jsonに指定(POST)
          x-ncp-apigw-timestampMandatory1970年1月1日 00:00:00 協定世界時(UTC)からの経過時間をミリセカンド(Millisecond)で表したものである。
          API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
          x-ncp-iam-access-keyMandatoryポータルまたはSub Accountが発行したAccess Key ID
          x-ncp-apigw-signature-v2Mandatory上記の例の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

          API Headerに移動する

          リクエストBody

          {
  "projectName": "string",
  "projectDesc": "string",
  "useKkoBizMsg": "boolean",
  "usePush": "boolean",
  "useSms": "boolean
}
          項目MandatoryType説明備考
          projectNameMadatoryStringプロジェクト名アルファベットの小文字、数字、-、_のみ入力可能
          最大24文字
          projectDescOptionalStringプロジェクトの説明最大128文字
          useKkoBizMsgOptionalBooleanbizメッセージサービスの使用の有無default: false
          usePushOptionalBooleanPUSHサービスの使用の有無default: false
          useSmsOptionalBooleanSMSサービスの使用の有無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"
}
          項目MandatoryType説明備考
          projectNameMadatoryStringプロジェクト名
          projectDescMandatoryStringプロジェクトの説明
          useKkoBizMsgMandatoryBooleanbizメッセージサービスの使用の有無
          usePushMandatoryBooleanPUSHサービスの使用の有無
          useSmsMandatoryBooleanSMSサービスの使用の有無
          createTimeMandatoryString作成時間format：LocalDateTime(説明)
          updateTimeOptionalString作成時間format: LocalDateTime
          *Service.serviceIdMandatoryStringサービスIDSMS、PUSH、KkoBizMsg共通
          *Service.serviceNameMandatoryStringサービス名SMS、PUSH、KkoBizMsg共通
          *Service.createTimeMandatoryStringサービスの作成時間SMS、PUSH、KkoBizMsg共通
          format: LocalDateTime
          *Service.updateTimeOptionalStringサービスの修正時間SMS、PUSH、KkoBizMsg共通
          format: LocalDateTime
          smsService.useBlockServiceMandatoryBoolean080受信拒否番号サービスの使用の有無

          レスポンスStatus

          HTTP StatusDesc
          200OK (作成完了)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          429Too Many Requests
          500Internal 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

          項目MandatoryType説明備考
          projectIdMandatoryStringプロジェクトIDプロジェクトを作成する時に発行されたプロジェクトID

          Parameters

          なし

          Headers

          API Headerに移動する

          リクエストBody

          {
  "projectDesc": "string",
  "useKkoBizMsg": "boolean",
  "usePush": "boolean",
  "useSms": "boolean
}
          項目MandatoryType説明備考
          projectDescOptionalStringプロジェクトの説明最大128文字
          useKkoBizMsgOptionalBooleanbizメッセージサービスの使用の有無default: false
          usePushOptionalBooleanPUSHサービスの使用の有無default: false
          useSmsOptionalBooleanSMSサービスの使用の有無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"
}
          項目MandatoryType説明備考
          projectNameMadatoryStringプロジェクト名
          projectDescMandatoryStringプロジェクトの説明
          useKkoBizMsgMandatoryBooleanbizメッセージサービスの使用の有無
          usePushMandatoryBooleanPUSHサービスの使用の有無
          useSmsMandatoryBooleanSMSサービスの使用の有無
          createTimeMandatoryString作成時間format：LocalDateTime(説明)
          updateTimeMandatoryString修正時間format: LocalDateTime
          *Service.serviceIdMandatoryStringサービスIDSMS、PUSH、KkoBizMsg共通
          *Service.serviceNameMandatoryStringサービス名SMS、PUSH、KkoBizMsg共通
          *Service.createTimeMandatoryStringサービスの作成時間SMS、PUSH、KkoBizMsg共通
          format: LocalDateTime
          *Service.updateTimeOptionalStringサービスの修正時間SMS、PUSH、KkoBizMsg共通
          format: LocalDateTime
          smsService.useBlockServiceMandatoryBoolean080受信拒否番号サービスの使用の有無
          smsService.blockService.availableOptionalBoolean使用可能か否か
          smsService.blockService.companyNameOptionalString会社名
          smsService.blockService.statusNameOptionalStringサービスの状態
          smsService.blockService.createTimeOptionalStringサービスの作成時間format: LocalDateTime
          smsService.blockService.updateTimeOptionalStringサービスの修正時間format: LocalDateTime

          レスポンスStatus

          HTTP StatusDesc
          200OK (修正完了)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          429Too Many Requests
          500Internal 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

          項目MandatoryType説明備考
          projectNameOptionalStringプロジェクト名like照会結果を返す
          pageSizeOptionalIntegerページサイズdefault: 100
          1～100までの数字のみ入力可能
          pageIndexOptionalIntegerページインデックス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"
    }
]
          項目MandatoryType説明備考
          projectNameMadatoryStringプロジェクト名
          projectDescMandatoryStringプロジェクトの説明
          useKkoBizMsgMandatoryBooleanbizメッセージサービスの使用の有無
          usePushMandatoryBooleanPUSHサービスの使用の有無
          useSmsMandatoryBooleanSMSサービスの使用の有無
          createTimeMandatoryString作成時間format：LocalDateTime(説明)
          updateTimeOptionalString作成時間format: LocalDateTime
          *Service.serviceIdMandatoryStringサービスIDSMS、PUSH、KkoBizMsg共通
          *Service.serviceNameMandatoryStringサービス名SMS、PUSH、KkoBizMsg共通
          *Service.createTimeMandatoryStringサービスの作成時間SMS、PUSH、KkoBizMsg共通
          format: LocalDateTime
          *Service.updateTimeOptionalStringサービスの修正時間SMS、PUSH、KkoBizMsg共通
          format: LocalDateTime
          smsService.useBlockServiceMandatoryBoolean080受信拒否番号サービスの使用の有無
          smsService.blockService.availableOptionalBoolean使用可能か否か
          smsService.blockService.companyNameOptionalString会社名
          smsService.blockService.statusNameOptionalStringサービスの状態
          smsService.blockService.createTimeOptionalStringサービスの作成時間format: LocalDateTime
          smsService.blockService.updateTimeOptionalStringサービスの修正時間format: LocalDateTime

          レスポンスStatus

          HTTP StatusDesc
          200OK (照会完了)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal 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

          項目MandatoryType説明備考
          projectIdMandatoryStringプロジェクト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"
}
          項目MandatoryType説明備考
          projectNameMadatoryStringプロジェクト名
          projectDescMandatoryStringプロジェクトの説明
          useKkoBizMsgMandatoryBooleanbizメッセージサービスの使用の有無
          usePushMandatoryBooleanPUSHサービスの使用の有無
          useSmsMandatoryBooleanSMSサービスの使用の有無
          createTimeMandatoryString作成時間format：LocalDateTime(説明)
          updateTimeOptionalString作成時間format: LocalDateTime
          *Service.serviceIdMandatoryStringサービスIDSMS、PUSH、KkoBizMsg共通
          *Service.serviceNameMandatoryStringサービス名SMS、PUSH、KkoBizMsg共通
          *Service.createTimeMandatoryStringサービスの作成時間SMS、PUSH、KkoBizMsg共通
          format: LocalDateTime
          *Service.updateTimeOptionalStringサービスの修正時間SMS、PUSH、KkoBizMsg共通
          format: LocalDateTime
          smsService.useBlockServiceMandatoryBoolean080受信拒否番号サービスの使用の有無
          smsService.blockService.availableOptionalBoolean使用可能か否か
          smsService.blockService.companyNameOptionalString会社名
          smsService.blockService.statusNameOptionalStringサービスの状態
          smsService.blockService.createTimeOptionalStringサービスの作成時間format: LocalDateTime
          smsService.blockService.updateTimeOptionalStringサービスの修正時間format: LocalDateTime

          レスポンスStatus

          HTTP StatusDesc
          200OK (照会完了)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal 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

          項目MandatoryType説明備考
          projectIdMandatoryStringプロジェクトIDプロジェクトを作成する時に発行されたプロジェクトID

          Parameters

          なし

          Headers

          API Headerに移動する

          リクエストBody

          なし

          レスポンスBody

          なし

          レスポンスStatus

          HTTP StatusDesc
          204No Content(削除完了)
          400Bad Request
          401Unauthorized
          403Forbidden
          404Not Found
          500Internal Server Error
          429Too Many Requests
          この記事は役に立ちましたか?
          What's Next
          Change password!
          Changing your password will log you out immediately. Use the new password to log back in.
          Change profile
          Success!
          First name must have atleast 2 characters. Numbers and special characters are not allowed.
          Last name must have atleast 1 characters. Numbers and special characters are not allowed.
          Enter a valid email
          Enter a valid password
          Your profile has been successfully updated.
          Logout