快工助手跨境电商知识与商机助手
快工云仓服务介绍

Get Message Templates

TikTok Shop 官方资料 · TikTok Shop Partner Center 开发者文档 · 适合开发者

stable本次发布有变化全部展示

来自 TikTok Shop 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存，可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
TikTok Shop / profile.tiktok.docs_api
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/tiktok_shopaudience/developercategory/api_doctopic/compliancetopic/developer

资料正文

§1 Path: /customer_engagement/202412/message_templates

#

§2 Method: [GET]

#

§3 Function Description

Get a library of customer engagement message templates predefined by TikTok Shop, which you can use directly in your customer engagement communications.

#

§4 Common Parameters

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

Properties Location Type Require Sample Properties description
shop_cipherquerystringYGCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3Use 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-typeheaderstringYapplication/jsonAllowed type: application/json
#

§5 Request Query Parameters

Properties Type Require Sample Properties description
app_keystringY38abcdEvery single app will have a unique key. Please use the specific key assigned to your app.
signstringY5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8cSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestampintY1623812664Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
shop_cipherstringYGCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3Shop_cipher is required for cross-border shops, and optional for local shops. It's unique for each shop. Get the this property from the Get Authorized Shop API dynamically. 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.
localestringYenThe BCP-47 locale codes for displaying the message content, delimited by commas. Default: en-US
Refer to Locale codes for the list of supported locale codes.
#

§6 Request Sample

Query

https://open-api.tiktokglobalshop.com/customer_engagement/202412/message_templates?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&locale=en
#

§7 Response Parameters

Properties Type Sample Properties description
codeint0The success or failure status code returned in API response.
messagestringSuccessThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstring202203070749000101890810281E8C70B7Request log
dataobjectSpecific return information
^message_templates[]objectCustomer engagement message templates predefined by TikTok Shop.
^^idstring8646958016719848812The template ID.
^^message_titlestringMeet your next favorite thing!The message title.
^^message_bodystringWe strive to create products with you in mind. Check out our newest drop to find your perfect fit that’s built for a confidence boost.The message body.
^^product_card_rulesobjectRules on the number and type of interactive product cards that can be included in a message.
^^^min_countint0The minimum number of product cards that must be included.
^^^max_countint4The maximum number of product cards that can be included.
^^coupon_card_rulesobjectRules on the number and type of interactive coupon cards that can be included in a message.
^^^min_countint1The minimum number of coupon cards that must be included.
^^^max_countint1The maximum number of coupon cards that can be included.
^^^coupon_type[]string["REGULAR_ALL,REGULAR_REPEAT"]The types of coupon that can be included in the message.
Possible values:
  • REGULAR_ALL: Regular coupons that target all buyers. Required coupon properties: coupons.display_type=REGULAR and coupons.target_buyer_segment=ALL in the Search Coupons API.
  • REGULAR_REPEAT: Regular coupons that target only repeat buyers. Required coupon properties: coupons.display_type=REGULAR and coupons.target_buyer_segment=REPEAT_CUSTOMERS in the Search Coupons API. |
#

§8 Response Sample

{"code":0,"data":{"message_templates":[{"id":"8646958016719848812","message_title":"Meet your next favorite thing!","message_body":"We strive to create products with you in mind. Check out our newest drop to find your perfect fit that’s built for a confidence boost.","product_card_rules":{"min_count":0,"max_count":4},"coupon_card_rules":{"min_count":1,"max_count":1,"coupon_type":["REGULAR_ALL,REGULAR_REPEAT"]}}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
#

§9 Error Code

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

Code Message
68009001Access 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.
#