stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /customer_service/202602/sessions/search
#§2 Method: [POST]
#§3 Function Description
Description of [POST]/customer_service/:version/sessions
§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. |
| page_size | int | Y | 10 | The number of results to be returned per page. |
| Valid range: [1-100] | ||||
| page_token | string | N | 1 | An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page. |
| locale | string | N | en-US | The BCP-47 locale codes for displaying the rejection reason, delimited by commas. Default: en-US |
| Refer to https://partner.tiktokshop.com/docv2/page/678e3a47bae28f030a8c7523 for the list of supported locale codes. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| begin_time_ge | int | Y | 1773222516 | Return sessions whose begin_time is greater than or equal to the specified time. Only data from the last 90 days is supported. |
| begin_time_lt | int | Y | 1773242516 | Return sessions whose begin_time is less than the specified timestamp. |
| buyer_nickname | string | N | Albert | Buyer's nickname. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/customer_service/202602/sessions/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&page_size=10&page_token=1&locale=en-US
Body
{"begin_time_ge":1773222516,"begin_time_lt":1773242516,"buyer_nickname":"Albert"}
§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 | |
| ^next_page_token | string | 10 | If there is no more record, this field will be ""(empty string). |
| ^sessions | []object | Session info. | |
| ^^id | string | 7494560109732334261 | Session id. |
| ^^conversation_id | string | 7601726193700929800 | Conversation id. |
| ^^begin_time | int | 1773222516 | The timestamp when the session began. |
| ^^end_time | int | 1773232516 | The timestamp when the session end. |
| ^^buyer_nickname | string | Albert | Buyer's nickname. |
| ^^chat_tags | []string | ["Logistics"] | AfterSale/Logistics/Presale |
| ^^satisfaction_score | int | 4 | Customer satisfaction rating for the session (e.g., 1–5). Higher scores indicate greater satisfaction. |
| ^^dissatisfaction_reason | string | Slow response or resolution | Reason provided by the buyer for a low satisfaction rating. |
| The language of the reason is determined by the locale request parameter. | |||
| ^^first_response_late | bool | false | Indicates whether the first response exceeded the expected response time or SLA. |
| ^^first_response_time | int | 123 | Time elapsed in seconds between when the buyer sends the first message and when the seller sends the first response. |
§9 Response Sample
{"code":0,"data":{"next_page_token":"10","sessions":[{"id":"7494560109732334261","conversation_id":"7601726193700929800","begin_time":1773222516,"end_time":1773232516,"buyer_nickname":"Albert","chat_tags":["Logistics"],"satisfaction_score":4,"dissatisfaction_reason":"Slow response or resolution","first_response_late":false,"first_response_time":123}]},"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 |
|---|---|
| 45101001 | Internal error. Please try again later or contact the technical support team for help. |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |