プロジェクトの照会

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

プロジェクトの詳細情報を照会します。

リクエスト

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

メソッド	URI
GET	/common/v2/projects/{projectId}

リクエストヘッダ

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

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`projectId`	String	Required	プロジェクト ID プロジェクトリストの照会を参照

リクエスト例

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

curl --location --request GET 'https://sens.apigw.ntruss.com/common/v2/projects/5c7c325a-****-****-****-42ef00c15265' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`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サービスのメタ情報
`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サービスのメタ情報
`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形式
`updateTime`	String	Optional	プロジェクトの最終更新日時 YYYY-MM-DDTHH:mm:ss.sss形式更新履歴がない場合、表示しない

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

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

レスポンス例

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

{
    "projectId": "5c7c325a-****-****-****-42ef00c15265",
    "projectName": "sens",
    "projectDesc": "sample project",
    "useSms": true,
    "useKkoBizMsg": true,
    "smsService": {
        "serviceId": "ncp:sms:kr:50********51:sens",
        "serviceName": "sens",
        "createTime": "2025-11-18T09:14:49.686",
        "updateTime": "2025-11-18T09:14:49.681",
        "useBlockService": true
    },
    "kkoBizMsgService": {
        "serviceId": "ncp:kkobizmsg:kr:50*********3:sens",
        "serviceName": "sens",
        "createTime": "2025-11-18T09:14:49.691",
        "updateTime": "2025-11-18T09:14:49.690"
    },
    "createTime": "2025-11-18T09:14:49.679"
}