GET Get Conversation List
Get Conversation List Shop Required scope: seller.affiliate_messages.write Get User's Conversation list. Version 202412
GET/affiliate_seller/202412/conversations
Request
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | int | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| page_size Required | int | The maximum number of queries. The maximum number is 50. |
| page_token | string | Pagination offset determines where you begin to query. It's empty when you raise your first request. |
| only_need_conversation_id | bool | - If true, only conversation_id in conversation is returned. - If false, all fields in conversation` are returned.true by default. |
| conversation_status | string | 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. |
| shop_cipher | string | 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 |
Body
| Properties | Type | Description |
|---|---|---|
| only_need_conversation_id | bool | - If true, only conversation_id in data.conversation is returned. - If false, all fields in data.conversation are returned.true by default. |
Example
CurlGoNode.jsJavaEnable word wrap
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
Error Code
View common error codes
| Code | Message | | --- | --- | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
Is this content helpful?Helpful
Not Helpful
PreviousNext