stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_seller/202412/conversations
#§2 Method: [GET]
#§3 Function Description
Get User's Conversation list.
§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 | 20 | The maximum number of queries. The maximum number is 50. |
| page_token | string | N | b2Zmc2V0PTAK | Pagination offset determines where you begin to query. It's empty when you raise your first request. |
| only_need_conversation_id | bool | N | true | - If true, only conversation_id in conversation is returned. |
- If
false, all fields in conversationare returned.true` by default. | conversation_status |string |N |UNREPLY |Filter the list of IM conversations returned based on the status. Possible values: - ALL: Retrieve all conversations regardless of the status.
- UNREAD: Retrieve all conversations with messages that the seller has not read yet. The messages stay unread until explicitly marked as read by calling Mark Conversation Read. Replying to a message does not change the read / unread status.
- UNREPLIED: Retrieve all conversations in which the seller is not the last message sender. This filter helps you to efficiently manage and prioritize conversations.
- STARRED: Retrieve all conversations that seller starred.
- ARCHIVED: Retrieve all conversations that seller archived. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| only_need_conversation_id | bool | N | true | - If true, only conversation_id in data.conversation is returned. |
- If
false, all fields indata.conversationare returned.trueby default. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_seller/202412/conversations?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&page_size=20&page_token=b2Zmc2V0PTAK&only_need_conversation_id=true&conversation_status=UNREPLY
§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 more conversations. |
| ^next_page_token | string | b2Zmc2V0PTAK | Cursor for the next page request. |
| ^conversations | []object | The conversation list. | |
| ^^id | string | 12345678 | Conversation unique ID. |
| ^^unread_count | int | 2 | Number of unread messages. |
| ^^username | string | test_creator_name | The TikTok user name. |
| ^^avatar | string | https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-giso/2bf6a2485ec8bf93483e4a6ed907e6fd~c5_720x720.webp | The URL for the TikTok creator's avatar image file. |
| ^^creator_im_id | string | 12345678 | Creators' IM User ID. |
§9 Response Sample
{"code":0,"data":{"has_more":true,"next_page_token":"b2Zmc2V0PTAK","conversations":[{"id":"12345678","unread_count":2,"username":"test_creator_name","avatar":"https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-giso/2bf6a2485ec8bf93483e4a6ed907e6fd~c5_720x720.webp","creator_im_id":"12345678"}]},"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 |
|---|---|
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |