stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /customer_engagement/202412/messages
#§2 Method: [POST]
#§3 Function Description
Send messages to specific customers for a particular engagement task.
§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. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| buyer_emails | []string | Y | ["v43424bDOUSGKQQ7YLNEGXPED3CNCQO24@scs.tiktokw.us","v4b1232DOUSGKQQ7YLNEMPPEPBORFEQ2A@scs.tiktokw.us"] | The anonymized email address of the buyer. Retrieve this value from the Get Order Details API. |
| Note: You can only send messages to buyers who have placed at least one order with the shop in the past 365 days. | ||||
| task_id | string | N | [1381478460934] | The ID of the associated customer engagement task. Use the value returned when you call the Create Engagement Task API. |
| Note: Ensure the task is still active. You cannot send messages to tasks that have ended. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/customer_engagement/202412/messages?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"buyer_emails":["v43424bDOUSGKQQ7YLNEGXPED3CNCQO24@scs.tiktokw.us","v4b1232DOUSGKQQ7YLNEMPPEPBORFEQ2A@scs.tiktokw.us"],"task_id":"[1381478460934]"}
§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 | |
| ^errors | []object | The list of errors that occurred. | |
| ^^code | int | 68009003 | The error code. |
| ^^message | string | The user adresss is invalid | The error message. |
| ^^detail | object | The details of the error. | |
| ^^^buyer_email | string | v4b1232DOUSGKQQ7YLNEMPPEPBORFEQ2A@scs.tiktokw.us | The list of buyer email addresses where message delivery failed. |
§9 Response Sample
{"code":0,"data":{"errors":[{"code":68009003,"message":"The user adresss is invalid","detail":{"buyer_email":"v4b1232DOUSGKQQ7YLNEMPPEPBORFEQ2A@scs.tiktokw.us"}}]},"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 |
|---|---|
| 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. |
| 68009002 | The specified task has ended, and sending of messages is no longer allowed. |
| 68009003 | The user adresss is invalid |
| 68009004 | Unable to send messages to the specified buyer email as the buyer has not placed an order with the shop in the past 365 days. |