プロジェクトの作成

Prev Next

Classic/VPC環境で利用できます。

プロジェクトを作成します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /common/v2/projects

リクエストヘッダ

Simple & Easy Notification Service APIで共通して使用されるヘッダの詳細は、Simple & Easy Notification Serviceのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
projectName String Required プロジェクト名
  • 英小文字、数字、記号の「-」、「_」を使用して24文字以内で入力
projectDesc String Optional プロジェクトの説明
  • 0~128文字
useKkoBizMsg Boolean Optional Biz Messageサービスを使用するか
  • true | false (デフォルト)
    • true: 使用
    • false: 使用しない
  • falseの場合でもサービスのメタ情報が作成され、その後に変更可能
useSms Boolean Optional SMSサービスを使用するか
  • true | false (デフォルト)
    • true: 使用
    • false: 使用しない
  • falseの場合でもサービスのメタ情報が作成され、その後に変更可能

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://sens.apigw.ntruss.com/common/v2/projects' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
    "projectName": "mypush",
    "projectDesc": "push service",
    "useKkoBizMsg": true,
    "useSms": false
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
projectId String Required プロジェクト ID
projectName String Required プロジェクト名
projectDesc String Required プロジェクトの説明
useSms Boolean Required SMSサービスを使用するか
  • true | false
    • true: 使用
    • false: 使用しない
useKkoBizMsg Boolean Required Biz Messageサービスを使用するか
  • true | false
    • true: 使用
    • false: 使用しない
smsService Object Optional SMSサービスのメタ情報
  • useSmsがfalseの場合でも、メタ情報は作成される
smsService.serviceId String Required SMSサービス ID
smsService.serviceName String Required SMSサービス名
smsService.createTime String Required SMSサービスの作成日時
  • YYYY-MM-DDTHH:mm:ss.sss形式
smsService.updateTime String Optional SMSサービスの更新日時
  • YYYY-MM-DDTHH:mm:ss.sss形式
smsService.useBlockService Boolean Required 080受信拒否番号サービスを使用するか
  • true | false
    • true: 使用
    • false: 使用しない
kkoBizMsgService Object Optional Biz Messageサービスのメタ情報
  • useKkoBizMsgがfalseの場合でも、メタ情報は作成される
kkoBizMsgService.serviceId String Required Biz Messageサービス ID
kkoBizMsgService.serviceName String Required Biz Messageサービス名
kkoBizMsgService.createTime String Required Biz Messageサービスの作成日時
  • YYYY-MM-DDTHH:mm:ss.sss形式
kkoBizMsgService.updateTime String Optional Biz Messageサービスの更新日時
  • YYYY-MM-DDTHH:mm:ss.sss形式
createTime String Required プロジェクトの作成日時
  • YYYY-MM-DDTHH:mm:ss.sss形式

レスポンスステータスコード

Simple & Easy Notification Service APIで共通して使用されるレスポンスステータスコードの詳細は、Simple & Easy Notification Serviceのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "projectId": "b674e9e0-****-****-****-165e285c8497",
    "projectName": "mypush",
    "projectDesc": "push service",
    "useSms": false,
    "useKkoBizMsg": true,
    "smsService": {
        "serviceId": "ncp:sms:kr:27********30:mypush",
        "serviceName": "mypush",
        "createTime": "2025-11-18T08:55:01.578",
        "updateTime": "2025-11-18T08:55:01.576",
        "useBlockService": false
    },
    "kkoBizMsgService": {
        "serviceId": "ncp:kkobizmsg:kr:27********13:mypush",
        "serviceName": "mypush",
        "createTime": "2025-11-18T08:55:01.617",
        "updateTime": "2025-11-18T08:55:01.616"
    },
    "createTime": "2025-11-18T08:55:01.558"
}