快工助手跨境电商知识与商机助手

v2.media_space.get_video_upload_result

Shopee 官方资料 · Shopee Open Platform 接口参考 · 适合开发者

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.api_reference
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.media_space.get_video_upload_result

Query the upload status and result of video upload.

#

§2 Overview

Overview

FieldValue
ModuleMediaSpace
API typeShop
HTTP methodGET
Path/api/v2/media_space/get_video_upload_result
Production URLhttps://partner.shopeemobile.com/api/v2/media_space/get_video_upload_result
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/media_space/get_video_upload_result
Rate limit[0, 0, 0]
PermissionERP System; Seller In House System; Product Management; Swam ERP
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
video_upload_idstringYessg_90ce045e-fd92-4f0b-97a4-eda40546cd9f_000000
#

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
messagestringIndicate error details if hit error. Empty if no error happened.
request_idstring11f7272477404b9989ba77183656e8b7The identifier for an API request for error tracking.
responseobject
response.statusstringSUCCEEDEDCurrent status of this video upload session. could be: INITIATED(waiting for part uploading and/or the complete_video_upload API call), TRANSCODING(has received all video parts, and is transcoding the video file), SUCCEEDED(transcoding completed, and this upload_id can now be used for item adding/updating), FAILED(this upload failed, see the message filed for some info), CANCELLED(this upload is cancelled)
response.video_infoobjectTranscoded video info, will be present if status is SUCCEEDED.
response.video_info.video_url_listobject[]Video playback URL list.
response.video_info.video_url_list.video_url_regionstringSGThe region of this video URL.
response.video_info.video_url_list.video_urlstringhttps://cvf.shopee.sg/file/ddb50833eee1c9fda5c522a2e6fc0ea6Video playback URL.
response.video_info.thumbnail_url_listobject[]Video thumbnail image URL list.
response.video_info.thumbnail_url_list.image_url_regionstringSGThe region of this image URL.
response.video_info.thumbnail_url_list.image_urlstringhttps://cf.shopee.sg/file/75eba55932c987851abc39895047dd54Image display URL.
response.video_info.durationint15Duration of this video, in seconds.
response.messagestringVideo is too shortDetail error message if video uploading/transcoding failed.
errorstringIndicate error type if hit error. Empty if no error happened.
warningstringWarning message.
#

§5 Common parameters

Common parameters

NameTypeRequiredSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2
#

§6 Request samples

Request samples

#

§7 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/media_space/get_video_upload_result?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp&video_upload_id=sg_90ce045e-fd92-4f0b-97a4-eda40546cd9f_000000")
.asString();
#

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/media_space/get_video_upload_result?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp&video_upload_id=sg_90ce045e-fd92-4f0b-97a4-eda40546cd9f_000000',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
#

§9 cURL

cURL

curl --location --request GET 'https://partner.shopeemobile.com/api/v2/media_space/get_video_upload_result?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp&video_upload_id=sg_90ce045e-fd92-4f0b-97a4-eda40546cd9f_000000' 
#

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/media_space/get_video_upload_result?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp&video_upload_id=sg_90ce045e-fd92-4f0b-97a4-eda40546cd9f_000000"

payload={}
headers = {

}
response = requests.request("GET",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)
#

§11 Response sample

Response sample

#

§12 JSON

JSON

{
  "error":"",
  "message": "",
  "request_id": "11f7272477404b9989ba77183656e8b7",
  "response": {
    "status": "SUCCEEDED",
    "message": "success",
    "video_info": {
      "video_url_list": [
        {
          "video_url_region": "TW",
          "video_url": "https://cvf.shopee.tw/file/ddb50833eee1c9fda5c522a2e6fc0ea6"
        },
        {
          "video_url_region": "VN",
          "video_url": "https://cvf.shopee.vn/file/ddb50833eee1c9fda5c522a2e6fc0ea6"
        },
        {
          "video_url_region": "PH",
          "video_url": "https://cvf.shopee.ph/file/ddb50833eee1c9fda5c522a2e6fc0ea6"
        },
        {
          "video_url_region": "TH",
          "video_url": "https://cvf.shopee.co.th/file/ddb50833eee1c9fda5c522a2e6fc0ea6"
        },
        {
          "video_url_region": "ID",
          "video_url": "https://cvf.shopee.co.id/file/ddb50833eee1c9fda5c522a2e6fc0ea6"
        },
        {
          "video_url_region": "MY",
          "video_url": "https://cvf.shopee.com.my/file/ddb50833eee1c9fda5c522a2e6fc0ea6"
        },
        {
          "video_url_region": "BR",
          "video_url": "https://cvf.shopee.com.br/file/ddb50833eee1c9fda5c522a2e6fc0ea6"
        },
        {
          "video_url_region": "SG",
          "video_url": "https://cvf.shopee.sg/file/ddb50833eee1c9fda5c522a2e6fc0ea6"
        }
      ],
      "thumbnail_url_list": [
        {
          "image_url_region": "TW",
          "image_url": "https://cf.shopee.tw/file/75eba55932c987851abc39895047dd54"
        },
        {
          "image_url_region": "VN",
          "image_url": "https://cf.shopee.vn/file/75eba55932c987851abc39895047dd54"
        },
        {
          "image_url_region": "PH",
          "image_url": "https://cf.shopee.ph/file/75eba55932c987851abc39895047dd54"
        },
        {
          "image_url_region": "TH",
          "image_url": "https://cf.shopee.co.th/file/75eba55932c987851abc39895047dd54"
        },
        {
          "image_url_region": "ID",
          "image_url": "https://cf.shopee.co.id/file/75eba55932c987851abc39895047dd54"
        },
        {
          "image_url_region": "MY",
          "image_url": "https://cf.shopee.com.my/file/75eba55932c987851abc39895047dd54"
        },
        {
          "image_url_region": "BR",
          "image_url": "https://cf.shopee.com.br/file/75eba55932c987851abc39895047dd54"
        },
        {
          "image_url_region": "SG",
          "image_url": "https://cf.shopee.sg/file/75eba55932c987851abc39895047dd54"
        }
      ],
      "duration": 15
    }
  }
}
#

§13 Error example

Error example

#

§14 JSON

JSON

{
    "error": "product.error_param",
    "message": "invalid upload_id",
    "warning": "",
    "request_id": "f8a5acf1756e23cd60a308af0f9726c3"
}
#

§15 Errors

Errors

ErrorDescriptionSolution
error_networkInner http call failed
error_dataparse data failed
error_datadata not exist
error_paramparameter invalid
error_paramThe information you queried is not found.
error_paramWrong parameters, detail: {msg}.
error_serverSomething wrong. Please try later.
error_paramrequest not from gateway
error_serverUnknown error.
error_serverUnknown error.
error_serverUnknown internal error.
error_serverUnknown internal error.
error_paramInvalid parameter.
error_invalid_upload_idInvalid upload_id.
#

§16 Common errors

Common errors

ErrorDescriptionSolution
error_authpartner_id is invalid
error_authThe App is deleted, and you'll be unable to make any API call.
error_authApp developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
error_paramThere is no partner_id in query.
error_paramInvalid partner_id.
error_paramno timestamp
error_paramInvalid timestamp
error_paramThere is no sign in query.
error_signWrong sign.
invalid_partner_idInvalid partner_id, please have a check.
error_authNo permission to current api.
error_api_call_restrictedThe App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details.
api_suspendedThe API is offline. Please call v2 API instead.
error_limitThe total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00)
error_rate_limitToo many requests. You have reached the rate limit. Please try again later.
source_ip_undeclaredRequest Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_paramPermission denied. This API is currently offline or the request path is incorrect.
error_paramPartner_id is invalid, should be an integer between 0 and 4294967295.
error_paramno timestamp.
error_paramTimestamp is invalid, should be an integer between 0 and 4294967295.
error_paramTimestamp is expired.
error_partner_key_expiredYour API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api.
error_api_permissionThis app type has no permission to this API.
error_paramThere is no access_token in query.
error_authInvalid access_token.
error_authInvalid partner_id or shopid.
shop_no_linkedPartner and shop has no linked.
shop_bannedThe shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_tokenInvalid access_token, please have a check.
partner_shop_no_linkInvalid partner_id or shop_id, please have a check.
error_ashop_api_permissionThe shop is Affiliate shop has no permission to call this API.
error_kyc_authNo permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_authSystem error, please try again later.
error_paramThere is no shop_id in query.
error_paramshop_id is invalid, should be an integer between 0 and 4294967295.
#