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

v2.video.delete_video

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.video.delete_video

Use this API to delete video. You can delete the video for both draft and post status.

#

§2 Overview

Overview

FieldValue
ModuleVideo
API typeUser
HTTP methodPOST
Path/api/v2/video/delete_video
Production URLhttps://partner.shopeemobile.com/api/v2/video/delete_video
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/video/delete_video
PermissionShopee Video Management
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
video_upload_id_liststring[]No["sg-11110199-6v8gq-mgbni6rb44qz04"]You can only select one from video_upload_id_list and post_id_list: - If you want to delete video with draft status, please pass video_upload_id_list.; - If you want to delete video with post status, please pass post_id_list.
post_id_liststring[]No["YwOo_gZqCACXbM0UAAAAAA=="]You can only select one from video_upload_id_list and post_id_list: - If you want to delete video with draft status, please pass video_upload_id_list.; - If you want to delete video with post status, please pass post_id_list.
#

§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.
request_idstring2af852cd-7420-4714-b7cd-33317f6fe548The identifier for an API request for error tracking.
responseobjectDetail informations you are querying.
response.success_listobject[]The list of video delete successfully.
response.success_list.success_video_upload_idstringThe video_upload_id delete successfully.
response.success_list.success_post_idstringThe post_id delete successfully.
response.failure_listobject[]The list of video delete deleted.
response.failure_list.fail_video_upload_idstringFailed video_upload_id.
response.failure_list.fail_post_idstringFailed post_id.
response.failure_list.failed_reasonstringFailed reason of the corresponding video_upload_id or post_id.
#

§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.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
user_idint1Shopee's unique identifier for a user.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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

{
	"video_upload_id_list": [
		"sg-11110199-6v8gq-mgbni6rb44qz04"
	]
}
#

§8 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/video/delete_video?access_token=access_token&partner_id=partner_id&sign=sign&timestamp=timestamp&user_id=user_id")
.header("Content-Type","application/json")
.body("{
   \"post_id_list\": [
      \"YwOo_gZqCACXbM0UAAAAAA==\"
   ],
   \"video_upload_id_list\": [
      \"sg-11110199-6v8gq-mgbni6rb44qz04\"
   ]
}")
.asString();
#

§9 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/video/delete_video?access_token=access_token&partner_id=partner_id&sign=sign&timestamp=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 => '{
    "post_id_list": [
        "YwOo_gZqCACXbM0UAAAAAA=="
    ],
    "video_upload_id_list": [
        "sg-11110199-6v8gq-mgbni6rb44qz04"
    ]
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
#

§10 cURL

cURL

curl --location --request POST 'https://partner.shopeemobile.com/api/v2/video/delete_video?access_token=access_token&partner_id=partner_id&sign=sign&timestamp=timestamp&user_id=user_id' \
--header 'Content-Type: application/json' \
--data-raw '{
   "post_id_list": [
      "YwOo_gZqCACXbM0UAAAAAA=="
   ],
   "video_upload_id_list": [
      "sg-11110199-6v8gq-mgbni6rb44qz04"
   ]
}'
#

§11 Python

Python

import requests
import json

url = "https://partner.shopeemobile.com/api/v2/video/delete_video?access_token=access_token&partner_id=partner_id&sign=sign&timestamp=timestamp&user_id=user_id"

payload=json.dumps({
  "post_id_list": [
    "YwOo_gZqCACXbM0UAAAAAA=="
  ],
  "video_upload_id_list": [
    "sg-11110199-6v8gq-mgbni6rb44qz04"
  ]
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)
#

§12 Response sample

Response sample

#

§13 JSON

JSON

{
	"error": "",
	"message": "",
	"response": {
		"success_list": [
			{
				"success_video_upload_id": "sg-11110199-6v8gq-mgbni6rb44qz04",
				"success_post_id": null
			}
		],
		"failure_list": []
	},
	"request_id": "63d15f2f-018d-4581-9b25-b67aff42c688"
}
#

§14 Error example

Error example

#

§15 JSON

JSON

{
	"error": "batch_process_failed",
	"message": "Please check failure_list for detailed reason",
	"response": {
		"success_list": [],
		"failure_list": [
			{
				"failed_reason": "video not exist",
				"fail_video_upload_id": "sg-11110199-6v8gq-mgbni6rb44qz04",
				"fail_post_id": null
			}
		]
	},
	"request_id": "d62eec3e-f104-4235-9430-2db399cdfd3e"
}
#

§16 Errors

Errors

ErrorDescriptionSolution
batch_process_failedPlease check failure_list for detailed reason
error-paramvideo_upload_id is illegal
error_paramvideoUploadIdList all illegal,no record in database
error_paramvideo_upload_list can not over 5
error_paramvideo_upload_id_list and post_id_list all empty
error_paramvideo_upload_id_list and post_id_list can only select one
#

§17 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.
error_paramThere is no access_token in query.
error_authInvalid access_token.
user_no_linkedPartner and user has no linked.
user_bannedThis user account has been banned. Permissions for user authorization and API calls have been suspended until the user account is restored.
invalid_acceess_tokenInvalid access_token, please have a check.
error_paramThere is no user_id in query.
error_paramuser_id is invalid, should be an integer between 0 and 4294967295.
#

§18 Update log

Update log

DateChange
-New API
#