GET media/upload (STATUS)

概要

STATUSコマンドを使用すると、メディアの処理操作の更新を定期的にポーリングできます。STATUSコマンドの応答がsucceededを返すと次の手順に移動し、そこでは通常media_idを使用してツイートを作成できます。

リクエスト

URLパラメータを使用したHTTP GETリクエストである必要があります。

注: このエンドポイントのドメインはupload.twitter.comです

応答

応答の本体には、メディア処理操作の現在のステータスに関する情報を含むprocessing_infoフィールドが含まれます。また、移行フロー“pending” -> “in_progress” -> [“failed” | “succeeded”]があるstateフィールドが含まれます。stateフィールドが“succeeded”に設定されるまで、media_idを使用したツイートやその他のエンティティの作成はできません。

リソース情報

応答形式 JSON
認証の要否 要(ユーザーのコンテキストに限る)
レート制限 あり

パラメータ

名前 要否 説明 デフォルト値
command 必須 STATUSに設定する必要があります(大文字、小文字の区別あり)。
media_id 必須 INITコマンドから返されるmedia_idです。

リクエストの例

GET https://upload.twitter.com/1.1/media/upload.json?command=STATUS&media_id=710511363345354753

結果の例

// Example of an in_progress response:

{
  "media_id":710511363345354753,
  "media_id_string":"710511363345354753",
  "expires_after_secs":3595,
  "processing_info":{
    "state":"in_progress", // state transition flow is pending -> in_progress -> [failed|succeeded]
    "check_after_secs":10, // check for the update after 10 seconds
    "progress_percent":8 // Optional [0-100] int value. Please don't use it as a replacement of "state" field.
  }
}

// Example of a failed response:

{
  "media_id":710511363345354753,
  "media_id_string":"710511363345354753",
  "processing_info":{
    "state":"failed",
    "progress_percent":12,
    "error":{
      "code":1,
      "name":"InvalidMedia",
      "message":"Unsupported video format"
    }
  }
}

// Example of a succeeded response:

{
  "media_id":710511363345354753,
  "media_id_string":"710511363345354753",
  "expires_after_secs":3593,
  "video":{
    "video_type":"video/mp4"
  },
  "processing_info":{
    "state":"succeeded",
    "progress_percent":100,
  }
}