Get Shoppable Video Precheck Result

资料正文

§1 Path: /affiliate_creator/202601/videos/precheck_tasks/{task_id}

§2 Method: [GET]

§3 Function Description

Use this API to get video pre-check result

§4 Common Parameters

For common parameters, refer to How to call TikTok Shop APIs - Common Parameters

Properties	Location	Type	Require	Sample	Properties description
content-type	header	string	Y	application/json	Allowed type: application/json

§5 Request Path Parameters

Properties	Type	Require	Sample	Properties description
task_id	string	Y	7493990579714164574	task id from Precheck Video Content

§6 Request Query Parameters

Properties	Type	Require	Sample	Properties description
app_key	string	Y	38abcd	Every single app will have a unique key. Please use the specific key assigned to your app.
sign	string	Y	5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c	Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp	int	Y	1623812664	Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.

§7 Request Sample

Query

https://open-api.tiktokglobalshop.com/affiliate_creator/202601/videos/precheck_tasks/7493990579714164574?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268

§8 Response Parameters

Properties	Type	Sample	Properties description
code	int	0	The success or failure status code returned in API response.
message	string	Success	The success or failure messages returned in API response. Reasons of failure will be described in the message.
request_id	string	202203070749000101890810281E8C70B7	Request log
data	object		Specific return information
^precheck_task	object		Video pre-check task
^^id	string	7493990579714164574	The id of the video pre-check task.
^^violation_check_result	object		violation check details
^^^status	string	FAIL	SUCCESS: The precheck task passed violation checks
FAIL: The precheck task has failed due to violations. Check the 'issues' field for details.
PROCESSING: The precheck violation task is still in progress
^^^issues	[]object		A list of policy violation details returned when violation check fails
^^^^risk	string	Pirated Content	Policy violation
^^^^suggestions	string	Your video may include unoriginal content. Creating original content is essential for standing out from the crowd.	Detailed guidance to resolve the detected violation.
^^good_quality_check_result	object		good qualtiy check details
^^^status	string	FAIL	SUCCESS: The precheck task passed all good quality checks
FAIL: The precheck task failed good quality checks. Check the 'issues' field for details.
PROCESSING: The good qualtify check is still in progress
^^^issues	[]object		A list of quality issues and improvement suggestions when the good quality check fails.
^^^^code	string	LOW_CONTENT_PROMOTIO	Quality finding
^^^^suggestions	string	You can try to showcase the product from multiple perspectives.	Recommended improvements based on the quality finding.

§9 Response Sample

{"code":0,"data":{"precheck_task":{"id":"7493990579714164574","violation_check_result":{"status":"FAIL","issues":[{"risk":"Pirated Content","suggestions":"Your video may include unoriginal content. Creating original content is essential for standing out from the crowd."}]},"good_quality_check_result":{"status":"FAIL","issues":[{"code":"LOW_CONTENT_PROMOTIO","suggestions":"You can try to showcase the product from multiple perspectives."}]}}},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}

§10 Error Code

For common error codes, refer to How to call TikTok Shop APIs - Common Error Code

Code	Message
36009003	Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support.