stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.livestream.upload_image
Upload an image as the live stream cover.(For TW, ID, TH, PH, MY, SG, VN)
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Livestream |
| API type | User |
| HTTP method | POST |
| Path | /api/v2/livestream/upload_image |
| Production URL | https://partner.shopeemobile.com/api/v2/livestream/upload_image |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/livestream/upload_image |
| Permission | Livestream Management |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| image | file | Yes | The image file to upload. |
§4 Response parameters
Response parameters
| Name | Type | Required | 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. | ||
| request_id | string | 6aae40843578b4c9c6f0b96ac3d27401 | The identifier for an API request for error tracking. | |
| response | object | Detail informations you are querying. | ||
| response.image_url | string | https://cf.shopee.sg/file/id-11134104-7r98o-m9y7ly25ngg927 | The image URL |
§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. | |
| user_id | int | 1 | Shopee's unique identifier for a user. | |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by(depends on different APIs) partner_id, api path, timestamp, access_token, user_id and partner_key via HMAC-SHA256 hashing algorithm. |
§6 Request samples
Request samples
§7 Payload
Payload
{
"image": "path/to/file"
}
§8 Java
Java
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/livestream/upload_image?access_token=access_token&partner_id=partner_id&sign=sign×tamp=timestamp&user_id=user_id")
.field("file", new File("/path/to/file")) //replace the sample path with your file path
.asString();
§9 PHP
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/livestream/upload_image?access_token=access_token&partner_id=partner_id&sign=sign×tamp=timestamp&user_id=user_id',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => array('image'=> new CURLFILE('/path/to/file') /* Replace with actual file path */),
CURLOPT_HTTPHEADER => array(
'Content-Type: multipart/form-data'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
§10 cURL
cURL
curl --location --request POST 'https://partner.shopeemobile.com/api/v2/livestream/upload_image?access_token=access_token&partner_id=partner_id&sign=sign×tamp=timestamp&user_id=user_id' \
--form 'image=@"/path/to/file"' #replace the sample path with your file path
§11 Python
Python
import requests
url = "https://partner.shopeemobile.com/api/v2/livestream/upload_image?access_token=access_token&partner_id=partner_id&sign=sign×tamp=timestamp&user_id=user_id"
payload={}
files=[
('image',('image',open('/path/to/file','rb'),'application/octet-stream')) # Replace with actual file path
]
headers = {
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, files=files, allow_redirects=False)
print(response.text)
§12 Response sample
Response sample
§13 JSON
JSON
{
"error": "",
"message": "",
"request_id": "6aae40843578b4c9c6f0b96ac3d27401",
"response": {
"image_url": "https://cf.shopee.sg/file/id-11134104-7r98o-m9y7ly25ngg927"
}
}
§14 Error example
Error example
§15 JSON
JSON
{
"error": "error_param",
"message": "Invalid image format, only support jpg/jpeg/png/gif",
"request_id": "6aae4084357887ad5d3e122955e0fb01",
"response": {}
}
§16 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| error_data | parse data failed | |
| error_data | data not exist | |
| error_param | parameter invalid | |
| error_param | The image may contain sensitive content, please use another one | |
| error_param | No image found in the request | |
| error_param | The image size cannot exceed {{image_size_limit}} bytes | |
| error_param | Invalid image format, only support jpg/jpeg/png/gif) | |
| error_auth | You are not authorized | |
| error_server | The API is not supported for current region | |
| error_param | Parse data error: {{err_msg}} | |
| error_server | Too many requests, please try again later | |
| error_server | Server internal error: {{err_msg}} | |
| error_param | The information you queried is not found. | |
| error_param | Wrong parameters, detail: {msg}. | |
| error_server | Something wrong. Please try later. |
§17 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. | |
| user_no_linked | Partner and user has no linked. | |
| user_banned | This user account has been banned. Permissions for user authorization and API calls have been suspended until the user account is restored. | |
| invalid_acceess_token | Invalid access_token, please have a check. | |
| error_param | There is no user_id in query. | |
| error_param | user_id is invalid, should be an integer between 0 and 4294967295. |
§18 Update log
Update log
| Date | Change |
|---|---|
| 2025-06-24 | New API |
