ショートクリップリストの照会

Prev Next

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

ショートクリップリストを照会します。作成後1時間以内のスナップショットに対するショートクリップリストのみ照会できます。

リクエスト

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

メソッド URI
GET /api/v2/channels/{channelId}/{snapshotId}/shortclips

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
channelId String Required チャンネル ID
snapshotId String Required スナップショット ID

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

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

フィールド タイプ 必須の有無 説明
shortclipStatus String Optional ショートクリップの状態で絞り込み
  • CREATING | COMPLETED | PROCESSING_FAIL | UPLOAD_FAIL
    • CREATING: 作成中
    • COMPLETED: 完了
    • PROCESSING_FAIL: 作成失敗
    • UPLOAD_FAIL: アップロード失敗

リクエスト例

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

curl --location --request GET 'https://livestation.apigw.ntruss.com/api/v2/channels/ls-20250814******-zTwK2/7559/shortclips' \
--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 Object - レスポンス結果
content.channelId String - チャンネル ID
content.snapshotId Integer - スナップショット ID
content.shortClipList Array - ショートクリップリスト: shortClipList
total Integer - レスポンス総数

shortClipList

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

フィールド タイプ 必須の有無 説明
id Integer - ショートクリップ ID
status String - ショートクリップの状態
  • CREATING | COMPLETED | PROCESSING_FAIL | UPLOAD_FAIL
    • CREATING: 作成中
    • COMPLETED: 完了
    • PROCESSING_FAIL: 作成失敗
    • UPLOAD_FAIL: アップロード失敗
createdTime Integer - ショートクリップ作成日時(ミリ秒)
  • Unix Timestamp形式
updatedTime Integer - ショートクリップ更新日時(ミリ秒)
  • Unix Timestamp形式
fileSize Integer - ショートクリップファイルサイズ(Byte)
duration Integer - ショートクリップ再生時間(ミリ秒)
output Object - 保存情報
output.accessControl String - ショートクリップファイル保存場所の公開範囲
  • PRIVATE | PUBLIC_READ
    • PRIVATE: 非公開
    • PUBLIC_READ: 公開
output.bucketName String - ショートクリップファイル保存場所バケット名
output.filePath String - 保存場所の詳細パス
output.fileName String - ショートクリップファイル名

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

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

レスポンス例

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

{
    "content": {
        "channelId": "ls-20250814******-zTwK2",
        "snapshotId": 7559,
        "shortClipList": [
            {
                "id": 1411,
                "status": "COMPLETED",
                "createdTime": 1755571698831,
                "updatedTime": 1755571699315,
                "fileSize": 1102425,
                "duration": 19916,
                "output": {
                    "accessControl": "PRIVATE",
                    "bucketName": "mybucket",
                    "filePath": "/shortclip",
                    "fileName": "1411-1755571698831.mp4"
                }
            },
            {
                "id": 1410,
                "status": "COMPLETED",
                "createdTime": 1755571641845,
                "updatedTime": 1755571642503,
                "fileSize": 561643,
                "duration": 10006,
                "output": {
                    "accessControl": "PRIVATE",
                    "bucketName": "mybucket",
                    "filePath": "/shortclip",
                    "fileName": "1410-1755571641845.mp4"
                }
            }
        ]
    },
    "total": 2
}