stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /customer_engagement/202502/engagement_tasks/custom
#§2 Method: [POST]
#§3 Function Description
Create an engagement task that uses a self-defined custom message instead of predefined message templates from TikTok Shop. The task acts as a container for grouping messages with similar content and rules, allowing sellers to track and compare task performance across different types of content. Note that each task has a mandatory end time, and once expired, it cannot be used to send additional messages.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. |
| Get by API Get Authorization Shop | |||||
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 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. |
| idempotency_key | string | Y | 372dd4e7-9c02-ddb0-d14b-0b23ce54e142 | A unique key to recognize a request and prevent duplicate processing of the same request, especially in cases of connection issues. Ensure this key is unique for each request to avoid accidental duplicates. |
| Note: We recommend that you generate v4 UUIDs for use as keys. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| task_name | string | Y | Task1 for mega sale | |
| The name of the task. | ||||
| end_time | int | Y | 1744344885 | The time at which the task ends, and messages will no longer be sent. Unix timestamp (seconds). |
| channel | string | Y | TIKTOK_IM | The engagement channel. Only TIKTOK_IM is supported. |
| product_ids | []string | N | [8646958016719848812] | The product IDs that you want to include as interactive cards in the message. Retrieve this value from the Search Products API. |
| Max count: 4 | ||||
| coupon_ids | []string | N | [8646958016219848812] | The coupon IDs that you want to include as interactive cards in the message. |
| Max count: 1 | ||||
| You can only add coupons that have one of these sets of property: |
coupons.display_type=REGULARandcoupons.target_buyer_segment=ALLcoupons.display_type=REGULARandcoupons.target_buyer_segment=REPEAT_CUSTOMERS. Find out the coupon ID and properties from the Search Coupons API. | custom_message |object |N | |The custom message to send to customers. | ^title |string |N |Meet your next favorite thing! |The message title.- Valid format: plain text, unicode emoji (UTF-8)
- Valid length: [1, 70] | ^body |string |N |Check out our newest drop to find your perfect fit. |The message body.
- Valid format: plain text, unicode emoji (UTF-8)
- Valid length: [1, 500] |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/customer_engagement/202502/engagement_tasks/custom?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&idempotency_key=372dd4e7-9c02-ddb0-d14b-0b23ce54e142
Body
{"task_name":"Task1 for mega sale\n","end_time":1744344885,"channel":"TIKTOK_IM","product_ids":[8646958016719848000],"coupon_ids":[8646958016219849000],"custom_message":{"title":"Meet your next favorite thing!","body":"Check out our newest drop to find your perfect fit."}}
§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 | |
| ^task_id | string | 475910475643 | The unique identifier for the customer engagement task. Pass this value in the Send Engagement Message API to associate the task with the message sending operation. |
§9 Response Sample
{"code":0,"data":{"task_id":"475910475643"},"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 |
|---|---|
| 68008004 | Policy violation. The message contains content that violates TikTok Shop policies. Modify it and try again. |
| 68008016 | You're currently ineligible to send customized messages. Please use a message template. |
| 68009001 | Access denied. This endpoint is not available for this shop as the seller does not meet the access criteria for CRM features. See TikTok Shop Academy for details. |
| 68009005 | Failed to create an engagement task. Error details: |