Get Message in the Conversation

资料正文

§1 Path: /affiliate_seller/202412/conversation/{conversation_id}/messages

§2 Method: [GET]

§3 Function Description

Get chat history in one conversation.

§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 Path Parameters

Properties	Type	Require	Sample	Properties description
conversation_id	string	Y	1234567890	The conversation identifier.

§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.
page_size	int	Y	20	The maximum number of queries. The maximum number is 20.
page_token	string	N	b2Zmc2V0PTAK	Pagination offset determines where you begin to query. It's empty when you raise your first request.

§7 Request Sample

Query

https://open-api.tiktokglobalshop.com/affiliate_seller/202412/conversation/1234567890/messages?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&page_size=20&page_token=b2Zmc2V0PTAK

§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
^has_more	bool	true	Whether there are any more messages.
^next_page_token	string	b2Zmc2V0PTAK	Cursor for the next page request.
^messages	[]object
^^conversation_index	string	1735032460678899	Index of the message in the conversation. Higher index corresponds to newer message.
^^message_body	object		Message's content
^^^id	string	7451907556216407553	Message ID.
^^^conversation_id	string	7451873679308620048	Conversation ID to which the message belongs.
^^^type	string	TEXT	Message type, with possible values:

TEXT
PRODUCT_CARD
TARGET_COLLABORATION_CARD
FREE_SAMPLE_CARD
IMAGE
CRM_TEXT_WITH_IMAGE_CARD
CRM_TEXT_WITH_PRODUCTS_CARD
NOTIFICATION
EMOTICONS
SYSTEM The response's message type support more type.Especially image, crm card,notification,emoticons and system. | ^^^content |string |{"content": "simple text message"} |Message content, in JSON serialized string.
TEXT: {"content": "simple text"}
PRODUCT_CARD: {"product_id": "12345"}
TARGET_INVITATION_CARD {"invitation_group_id": "1234"}
FREE_SAMPLE_CARD {"apply_id": "1234"}
IMAGE: { "height": "290", "url": "https://tosv.boei18n.byted.org/obj/temai-im/FszkJ53nSapYG6KDaJQmqR3jjoZGwww304-290", "width": "304" }
CRM_TEXT_WITH_IMAGE_CARD { "title":"abc", "content":"efg", "url":"https://tosv.boei18n.byted.org/obj/temai-im/FszkJ53nSapYG6KDaJQmqR3jjoZGwww304-290" }
CRM_TEXT_WITH_PRODUCTS_CARD { "title":"abc", "content":"efg", "productIds":[123,456,789,222] }
NOTIFICATION,SYSTEM {"content": "notification/system message"}
EMOTICONS { "height": "110", "url": "https://tosv.boei18n.byted.org/obj/temai-im/FszkJ53nSapYG6KDaJQmqR3jjoZGwww304-290", "width": "110" } | ^^^create_time |int |1691411573 |Message creation time, represented as a Unix timestamp (seconds). | ^^^sender_id |string |2368694990397660924 |The message sender im id |

§9 Response Sample

{"code":0,"data":{"has_more":true,"next_page_token":"b2Zmc2V0PTAK","messages":[{"conversation_index":"1735032460678899","message_body":{"id":"7451907556216407553","conversation_id":"7451873679308620048","type":"TEXT","content":"{\"content\": \"simple text message\"}","create_time":1691411573,"sender_id":"2368694990397660924"}}]},"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
16032001	nvalid parameter Creator and Seller, please ensure Region mismatch.
36009003	Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support.