Get Latest Unread Messages

资料正文

§1 Path: /affiliate_seller/202412/conversations/messages/list/newest

§2 Method: [GET]

§3 Function Description

Get the unread messages from the last minute. You are recommended to use the Webhook, New Message Listener, for the message notification.

§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 Sample

Query

https://open-api.tiktokglobalshop.com/affiliate_seller/202412/conversations/messages/list/newest?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY

§7 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
^newest_message_list	[]object		The list of unread messages from the last minute.
^^conversation_id	string	12345	The converastion id to which the message belongs
^^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" } | ^^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. | ^^sender_id |string |12345678 |sender's IM id | ^^unread_message_count |int |1 |The number of unread messages of the sender in the conversation. |

§8 Response Sample

{"code":0,"data":{"newest_message_list":[{"conversation_id":"12345","content":"{\"content\": \"simple text message\"}","type":"TEXT","sender_id":"12345678","unread_message_count":1}]},"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