stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.media_space.get_video_upload_result
Query the upload status and result of video upload.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | MediaSpace |
| API type | Shop |
| HTTP method | GET |
| Path | /api/v2/media_space/get_video_upload_result |
| Production URL | https://partner.shopeemobile.com/api/v2/media_space/get_video_upload_result |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/media_space/get_video_upload_result |
| Rate limit | [0, 0, 0] |
| Permission | ERP System; Seller In House System; Product Management; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| video_upload_id | string | Yes | sg_90ce045e-fd92-4f0b-97a4-eda40546cd9f_000000 |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| message | string | Indicate error details if hit error. Empty if no error happened. | ||
| request_id | string | 11f7272477404b9989ba77183656e8b7 | The identifier for an API request for error tracking. | |
| response | object | |||
| response.status | string | SUCCEEDED | Current 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_info | object | Transcoded video info, will be present if status is SUCCEEDED. | ||
| response.video_info.video_url_list | object[] | Video playback URL list. | ||
| response.video_info.video_url_list.video_url_region | string | SG | The region of this video URL. | |
| response.video_info.video_url_list.video_url | string | https://cvf.shopee.sg/file/ddb50833eee1c9fda5c522a2e6fc0ea6 | Video playback URL. | |
| response.video_info.thumbnail_url_list | object[] | Video thumbnail image URL list. | ||
| response.video_info.thumbnail_url_list.image_url_region | string | SG | The region of this image URL. | |
| response.video_info.thumbnail_url_list.image_url | string | https://cf.shopee.sg/file/75eba55932c987851abc39895047dd54 | Image display URL. | |
| response.video_info.duration | int | 15 | Duration of this video, in seconds. | |
| response.message | string | Video is too short | Detail error message if video uploading/transcoding failed. | |
| error | string | Indicate error type if hit error. Empty if no error happened. | ||
| warning | string | Warning message. |
§5 Common parameters
Common parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. | |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. | |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. | |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. | |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature 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×tamp=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×tamp=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×tamp=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×tamp=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
| Error | Description | Solution |
|---|---|---|
| error_network | Inner http call failed | |
| error_data | parse data failed | |
| error_data | data not exist | |
| error_param | parameter invalid | |
| error_param | The information you queried is not found. | |
| error_param | Wrong parameters, detail: {msg}. | |
| error_server | Something wrong. Please try later. | |
| error_param | request not from gateway | |
| error_server | Unknown error. | |
| error_server | Unknown error. | |
| error_server | Unknown internal error. | |
| error_server | Unknown internal error. | |
| error_param | Invalid parameter. | |
| error_invalid_upload_id | Invalid upload_id. |
§16 Common errors
Common errors
| Error | Description | Solution |
|---|---|---|
| error_auth | partner_id is invalid | |
| error_auth | The App is deleted, and you'll be unable to make any API call. | |
| error_auth | App 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_param | There is no partner_id in query. | |
| error_param | Invalid partner_id. | |
| error_param | no timestamp | |
| error_param | Invalid timestamp | |
| error_param | There is no sign in query. | |
| error_sign | Wrong sign. | |
| invalid_partner_id | Invalid partner_id, please have a check. | |
| error_auth | No permission to current api. | |
| error_api_call_restricted | The 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_suspended | The API is offline. Please call v2 API instead. | |
| error_limit | The 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_limit | Too many requests. You have reached the rate limit. Please try again later. | |
| source_ip_undeclared | Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist | |
| error_param | Permission denied. This API is currently offline or the request path is incorrect. | |
| error_param | Partner_id is invalid, should be an integer between 0 and 4294967295. | |
| error_param | no timestamp. | |
| error_param | Timestamp is invalid, should be an integer between 0 and 4294967295. | |
| error_param | Timestamp is expired. | |
| error_partner_key_expired | Your 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_permission | This app type has no permission to this API. | |
| error_param | There is no access_token in query. | |
| error_auth | Invalid access_token. | |
| error_auth | Invalid partner_id or shopid. | |
| shop_no_linked | Partner and shop has no linked. | |
| shop_banned | The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored. | |
| invalid_acceess_token | Invalid access_token, please have a check. | |
| partner_shop_no_link | Invalid partner_id or shop_id, please have a check. | |
| error_ashop_api_permission | The shop is Affiliate shop has no permission to call this API. | |
| error_kyc_auth | No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API. | |
| error_auth | System error, please try again later. | |
| error_param | There is no shop_id in query. | |
| error_param | shop_id is invalid, should be an integer between 0 and 4294967295. |
