v2.media.init_video_upload
POST /api/v2/media/init_video_upload
Use this API to initialize a new video upload task and obtain a unique upload session ID.
Endpoint URL
URL: https://partner.shopeemobile.com/api/v2/media/init_video_upload
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 |
|---|---|---|---|---|
| business | int32 | True | 3 | Defines the business type of the uploaded image. Supported values: 3 = Video |
| scene | int32 | True | 1 | Defines the purpose of the uploaded image under the specified business type. Supported values: - If business = 3 (Video): 1 = Shopee Video |
| file_name | string | True | test_video_name.mp4 | Original video file name. |
| file_size | int64 | True | 26214400 | Total video file size in bytes. Rules and restrictions by business and scene: - If business = 3 (Video) and scene = 1 (Shopee Video): Maximum 1GB. |
| duration | int32 | True | 105 | Video duration in seconds. Rules and restrictions by business and scene: - If business = 3 (Video) and scene = 1 (Shopee Video): 1s~180s. |
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 | ||
| video_upload_id | string | sg-11110201-6kh48-mepm7a0ttcw3c3 | Unique upload session ID. |
| part_size | int64 | 10485760 | The size of each part. When uploading video chunks, the video must be split according to this part size for each upload request. |