Skip to main content

GET Get Message Templates

Get Message Templates Shop Required scope: seller.customer_engagement.read Get a library of customer engagement message templates predefined by TikTok Shop, which you can use directly in your customer engagement communications. Version 202412

GET/customer_engagement/202412/message_templates

Request

Header

PropertiesTypeDescription
content-type RequiredstringAllowed type: application/json
x-tts-access-token RequiredstringThe seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token.

Query

PropertiesTypeDescription
app_key RequiredstringEvery single app will have a unique key. Please use the specific key assigned to your app.
sign RequiredstringSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp RequiredintUnix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
shop_cipher RequiredstringUse 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
locale RequiredstringThe BCP-47 locale codes for displaying the message content, delimited by commas. Default: en-USRefer to Locale codes for the list of supported locale codes.

Example

CurlGoNode.jsJavaEnable word wrap

Response Parameters

PropertiesTypeDescription
codeintThe success or failure status code returned in API response.
messagestringThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstringRequest log
dataobjectSpecific return information

Example

JSONEnable word wrap

Error Code

View common error codes

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

Is this content helpful?Helpful

Not Helpful

PreviousNext