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

v2.media.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.get_video_upload_result

Use this API to retrieve the current status and result of a video upload task. You can also use video_upload_result_push to get notified immediately when a video upload reaches a final status (SUCCEEDED, FAILED, or CANCELLED).

#

§2 Overview

Overview

FieldValue
ModuleMedia
API typePublic
HTTP methodGET
Path/api/v2/media/get_video_upload_result
Production URLhttps://partner.shopeemobile.com/api/v2/media/get_video_upload_result
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/media/get_video_upload_result
PermissionERP System; Seller In House System; Product Management; Customer Service; Consignment Service System; Shopee Video Management
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
video_upload_idstringYessg-11110201-6kh48-mepm7a0ttcw3c3The unique ID of the upload task, returned by v2.media.init_video_upload.
#

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
errorstringIndicate error type if hit error. Empty if no error happened.
messagestringIndicate error details if hit error. Empty if no error happened.
warningstringIndicate warning message you should take care.
request_idstringe3e3e7f33ee88a7454c64e7a0b546e01The identifier for an API request for error tracking.
responseobject
response.statusstringSUCCEEDEDCurrent status of the upload task. Possible values: - INITIATED: Upload task has been created (via init_video_upload) but no parts have been uploaded yet.; - UPLOADING: Video file parts are being uploaded. The upload has started but is not yet completed.; - UPLOADED: All video parts have been uploaded successfully, waiting for complete_video_upload to trigger processing.; - PROCESSING: Video is being transcoded/validated by the system (duration, format, resolution checks).; - SUCCEEDED: Video upload and transcoding completed successfully. Video URL and cover URL are available for use.; - FAILED: Upload or processing failed (e.g., invalid format, duration not within allowed range, transcoding error).; - CANCELLED: Upload task was explicitly canceled by the client (cancel_video_upload), and the video is discarded.
response.reasonstringDetailed fail or cancel reason, will be returned if status is FAILED or CANCELLED.
response.update_timetimestamp1758018336The time of video status updates.
response.video_infoobjectTranscoded video info, will be returned if status is SUCCEEDED.
response.video_info.video_urlstringhttp://play-src.vod.shopee.com/api/v4/11110201/mms/sg-11110201-6kh48-mepm7a0ttcw3c3.Video playback url.
response.video_info.video_thumbnail_urlstringhttp://img.sp.mms.shopee.sg/sg-11110201-6kh48-mepm7a0ttcw3c3_coverVideo thumbnail image url.
response.video_info.thumbnail_widthint321920Video thumbnail image width.
response.video_info.thumbnail_heightint321080Video thumbnail image width.
response.video_info.durationint32105Video duration in seconds.
response.video_info.resolutionstring960x540Video resolution, e.g., "1280x1280".
#

§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.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature generated by partner_id, api path, timestamp 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/get_video_upload_result?partner_id=partner_id&sign=sign&timestamp=timestamp&video_upload_id=sg-11110201-6kh48-mepm7a0ttcw3c3")
.asString();
#

§8 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/media/get_video_upload_result?partner_id=partner_id&sign=sign&timestamp=timestamp&video_upload_id=sg-11110201-6kh48-mepm7a0ttcw3c3',
  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/get_video_upload_result?partner_id=partner_id&sign=sign&timestamp=timestamp&video_upload_id=sg-11110201-6kh48-mepm7a0ttcw3c3' 
#

§10 Python

Python

import requests

url = "https://partner.shopeemobile.com/api/v2/media/get_video_upload_result?partner_id=partner_id&sign=sign&timestamp=timestamp&video_upload_id=sg-11110201-6kh48-mepm7a0ttcw3c3"

payload={}
headers = {

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

print(response.text)
#

§11 Response sample

Response sample

#

§12 JSON

JSON

{
	"error": "",
	"message": "",
	"warning": "",
	"request_id": "e3e3e7f33ee88a7454c64e7a0b546e01",
	"response": {
		"status": "SUCCEEDED",
		"reason": "",
                "update_time": 1758018336,
		"video_info": {
			"video_url": "http://play-src.vod.shopee.com/api/v4/11110201/mms/sg-11110201-6kh48-mepm7a0ttcw3c3.",
			"video_thumbnail_url": "http://img.sp.mms.shopee.sg/sg-11110201-6kh48-mepm7a0ttcw3c3_cover",
			"thumbnail_width": 1920,
			"thumbnail_height": 1080,
			"duration": 105,
			"resolution": "960x540"
		}
	}
}
#

§13 Error example

Error example

#

§14 JSON

JSON

{
    "error": "error_param",
    "message": "Upload task not found.",
    "request_id": "e3e3e7f33ee8a17b646c2bf8bdb51d01"
}
#

§15 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.
#

§16 Update log

Update log

DateChange
-New API
#