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

Get Conversation

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_service/202601/conversations/{conversation_id}

#

§2 Method: [GET]

#

§3 Function Description

Use this API to retrieve information about a conversation by ID.

#

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

Properties Type Require Sample Properties description
conversation_idstringY7494560109732334261Conversation ID
#

§6 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.
need_session_idboolNfalseSet to true when session id is required.
need_session_infoboolNfalseSet to true when session info is required.
#

§7 Request Sample

Query

https://open-api.tiktokglobalshop.com/customer_service/202601/conversations/7494560109732334261?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&need_session_id=false&need_session_info=false
#

§8 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
^conversationobjectConversation info.
^^idstring7494560109732334261Conversation ID
^^participant_countint3Number of participants in the conversation.
  • If there has been no customer service agent in the conversation, the value is 2: the shop and the buyer;
  • Otherwise, the value is 3: the shop, the buyer, and the customer service agent. | ^^participants |[]object | |Conversation participants. | ^^^im_user_id |string |7494560109732334261 |Participant's ID, in IM system. This ID is used in IM system and can not be used to query orders. To query orders, use user_id instead. | ^^^role |string |BUYER |Participant's role. Possible enumerations:
  • BUYER
  • SHOP
  • CUSTOMER_SERVICE | ^^^nickname |string |Albert |Participant's nickname. | ^^^avatar |string |https://p16-oec-ttp.tiktokcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/566c497faaaf4491a84d3ce55d9cb095~tplv-omjb5zjo8w-origin-image.image? |Participant's avatar URL. | ^^^user_id |string |7494560109732334262 |Participant's ID. | ^^^platform |string |TIKTOK_SHOP |Which platform is the buyer from. This field will only be returned when the role is BUYER and the region is Indonesia. Possible enumerations:
  • TIKTOK_SHOP
  • TOKOPEDIA You cannot send platform-specific content to the buyer from a different platform. For example, when you send a product card to the Tokopedia buyer, you must ensure the product is listed on Tokopedia. | ^^create_time |int |1691411573 |Unix timestamp when the conversation was created. In seconds. | ^^unread_count |int |0 |Number of messages unread by the customer service agent. | ^^cur_session_id |string |7494472109882334261 |Current session id. | ^^cur_session |object | |Current session. | ^^^id |string |7494472109882334261 |Current session id. | ^^^phase |string |ASSIGNED |Current phase of the session. Possible enumerations:
  • AUTO_REPLY — The session is being handled by automatic replies or chatbot responses.
  • QUEUED — The session is waiting to be assigned to an agent.
  • ASSIGNED — The session has been assigned to an agent. |
#

§9 Response Sample

{"code":0,"data":{"conversation":{"id":"7494560109732334261","participant_count":3,"participants":[{"im_user_id":"7494560109732334261","role":"BUYER","nickname":"Albert","avatar":"https://p16-oec-ttp.tiktokcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/566c497faaaf4491a84d3ce55d9cb095~tplv-omjb5zjo8w-origin-image.image?","user_id":"7494560109732334262","platform":"TIKTOK_SHOP"}],"create_time":1691411573,"unread_count":0,"cur_session_id":"7494472109882334261","cur_session":{"id":"7494472109882334261","phase":"ASSIGNED"}}},"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
45101001Internal error. Please try again later or contact the technical support team for help.
45101003Record not found. Please check the parameters.
45101004The query quota has been reached (10000 request per day). Please try again tomorrow.
36009003Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support.
#