動画の字幕情報を新規作成/更新するAPIです。
■リクエストURL
POST:https://file-platform.stream.co.jp/writeapi/subtitleup/[アップロードキー]
※「アップロードキー」の取得方法は「認証API」をご参照ください。
- contentType:multipart/form-data
■パラメータ
パラメータ | 必須 | 説明 | デフォルト値 | フォーマット | |
新規 | 更新 | ||||
mid | ○ | ○ | 動画ID | 無し | 半角数 |
stid | --- | ○ |
字幕ID 指定なし:新規作成 |
無し | 半角数 |
lang_code | ○ | --- |
言語コード 下記「■言語対応表」を参照 |
無し | 全角半角 20文字 |
subtitle | ○ | --- | 字幕ファイル | 無し | フルパス形式 50文字以内(拡張子含む) 50MB以下 *.vtt; *.ttml; |
order | --- | --- | 表示順序 | 最大値で登録 | 2 以上の半角数 ※1 は字幕OFF固定のため |
default | --- | --- | デフォルト | 0 | 0:無効 1:デフォルト |
lang_label | ※ | --- |
ラベル ※「lang_code」がカスタムの場合は必須 |
新規登録時、「言語コード」のデフォルトのラベルで登録 | 全角半角 20文字 |
※新規登録時、「言語コード」及び「ラベル」が既存の字幕と重複している場合はエラーとなります。
※更新で字幕ファイルを差し替えた場合、字幕ID(stid)は新しいIDが発番されます。
※表示順序の変更で、指定された値に既に入っている場合、指定値が優先され、それ以降は繰り上がります。 また、既に登録済みの最大番号以上の値を指定した場合は、最後尾となります。
■言語対応表
言語コード | 言語選択 | ラベル |
de | ドイツ語 | German |
en | 英語 | English |
fr | フランス語 | French |
ja | 日本語 | 日本語 |
ko | 韓国語 | Korean |
zh | 中国語 | Chinese |
zh-Hans | 中国語(簡体字) | Chinese(Simplified) |
zh-Hant | 中国語(繁体字) | Chinese(Traditional) |
fil | フィリピン語 | Filipino |
th | タイ語 | Thai |
id | インドネシア語 | Indonesian |
vi | ベトナム語 | Vietnamese |
pt | ポルトガル語 | Portuguese |
es | スペイン語 | Spanish |
my | ビルマ語 | Burmese |
it | イタリア語 | Italian |
■レスポンス情報
- 出力タイプ:JSON
- Content-Type:application/json
- 文字コード:UTF-8(BOMなし)
■レスポンス例:正常時
{ "error_code": 0, "message": "{変更点}", } |
error_code:レスポンスコード message:メッセージ |
■レスポンス例:エラー時
{ "error_code": 9021, "message": "{エラーメッセージ}", } |
error_code:レスポンスコード message:メッセージ |
■レスポンスコード
レスポンスコード | メッセージ |
0 | OK |
9021 | request parameter error:{parameter name} |
9022 | subtitle(filename): uncorresponded. |
9022 | subtitle(filename): limit over. |
9044 | Invalid duplicate. |
9503 | request parameter error: mid: not exist. |
99999 | system error |