ライブカーテンコンテンツリストの照会

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

ライブカーテンコンテンツリストを照会します。

リクエスト

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

メソッド	URI
GET	/api/v2/curtainContents

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	Optional	ページ番号 1~N
`pageSizeNo`	Integer	Optional	ページごとの項目数 1~N
`status`	String	Optional	コンテンツの状態で絞り込み `CREATING` \| `READY` \| `PROCESSING_FAIL` \| `DELETED` `CREATING`: 作成中 `READY`: 準備完了 `PROCESSING_FAIL`: 作成失敗 `DELETED`: 削除完了

リクエスト例

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

curl --location --request GET 'https://livestation.apigw.ntruss.com/api/v2/curtainContents?pageNo=1&pageSizeNo=2' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'x-ncp-region_code: KR' \
--header 'Content-Type: application/json'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`content`	Array	-	ライブカーテンのコンテンツリスト: content
`total`	Integer	-	レスポンス総数

`content`

contentの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`id`	Integer	-	コンテンツ ID
`registerTime`	Integer	-	コンテンツ作成日時(ミリ秒) Unix Timestamp形式
`updatedTime`	Integer	-	コンテンツ更新日時(ミリ秒) Unix Timestamp形式
`status`	String	-	コンテンツの状態 `CREATING` \| `READY` \| `PROCESSING_FAIL` \| `DELETED` `CREATING`: 作成中 `READY`: 準備完了 `PROCESSING_FAIL`: 作成失敗 `DELETED`: 削除完了
`fileSize`	Integer	-	コンテンツのファイルサイズ(Byte)
`fileDuration`	Integer	-	コンテンツ再生時間(秒)
`input`	Array	-	ソースコンテンツの保存場所リスト `{バケット名}/{詳細パス}`形式

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

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

レスポンス例

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

{
    "content": [
        {
            "id": 413,
            "registerTime": 1755582009232,
            "updatedTime": 1755582013129,
            "status": "READY",
            "fileSize": 38304320,
            "fileDuration": 300,
            "input": [
                "mybucket/data/loading_screen.mp4"
            ]
        },
        {
            "id": 412,
            "registerTime": 1755579080117,
            "updatedTime": 1755579085344,
            "status": "READY",
            "fileSize": 2579365,
            "fileDuration": 300,
            "input": [
                "mybucket/data/abcd.png",
                "mybucket/data/sound_nocopyright.mp3"
            ]
        }
    ],
    "total": 2
}