v2.media.get_video_upload_result
GET /api/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).
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/media/get_video_upload_result
Common Request Parameters
| Name | Type | 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. |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature 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 |
Request Parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| video_upload_id | string | True | sg-11110201-6kh48-mepm7a0ttcw3c3 | The unique ID of the upload task, returned by v2.media.init_video_upload. |
Response Parameters
| Name | Type | Sample | Description |
|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Indicate error details if hit error. Empty if no error happened. | |
| warning | string | Indicate warning message you should take care. | |
| request_id | string | e3e3e7f33ee88a7454c64e7a0b546e01 | The identifier for an API request for error tracking. |
| response | object | ||
| status | string | SUCCEEDED | Current 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. |
| reason | string | Detailed fail or cancel reason, will be returned if status is FAILED or CANCELLED. | |
| update_time | timestamp | 1758018336 | The time of video status updates. |
| video_info | object | Transcoded video info, will be returned if status is SUCCEEDED. | |
| video_url | string | http://play-src.vod.shopee.com/api/v4/11110201/mms/sg-11110201-6kh48-mepm7a0ttcw3c3. | Video playback url. |
| video_thumbnail_url | string | http://img.sp.mms.shopee.sg/sg-11110201-6kh48-mepm7a0ttcw3c3\_cover | Video thumbnail image url. |
| thumbnail_width | int32 | 1920 | Video thumbnail image width. |
| thumbnail_height | int32 | 1080 | Video thumbnail image width. |
| duration | int32 | 105 | Video duration in seconds. |
| resolution | string | 960x540 | Video resolution, e.g., "1280x1280". |