GET Get Conversation Messages
Get Conversation Messages Shop Required scope: seller.customer_service Use this API to get all messages in a conversation between a buyer and a shop. Calling this API does not mark the messages as read. You are suggested to call Read Message
to mark the messages read. Version 202309
GET/customer_service/202309/conversations/{conversation_id}/messages
Request
Path
| Properties | Type | Description |
|---|---|---|
| conversation_id Required | string | Conversation ID |
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_token | string | Paging cursor, this means where this query should start.For the next page, use "next_page_token" in response. |
| page_size Required | int | Number of conversations in one page Max 10. |
| locale | string | System message's display language. The messages sent by System will be returned in the setting language; The messages sent by the buyer, the shop, the CS agent will not be affected. The default value is en (English).Possible enumerations:- de-DE (German, Germany)- en (English)- en-GB (English, United Kingdom)- es-ES (Spanish, Spain)- es-MX (Spanish, Latin America)- fr-FR (French, France)- id-ID (Indonesian, Indonesia)- it-IT (Italian, Italy)- ja-JP (Japanese)- ms-MY (Malay, Malaysia)- th-TH (Thai, Thailand)- vi-VN (Vietnamese, Vietnam)- pt-BR (Portuguese, Brazil)- zh-CN (Simplified Chinese, China) |
| sort_order | string | Sort order.Possible enumerations:- DESC(default)- ASC |
| sort_field | string | Sort messages by one of the following properties:- create_time (default)- index |
| need_data | bool | Need message.data |
| need_plaintext | bool | Need message.plaintext |
| time_zone | string | Time zone for formatting date and time in messages. The timestamps in messages will be returned in the specified time zone; other message content will not be affected.The value must follow the IANA time zone format (for example, Asia/Shanghai, America/Los_Angeles). The default value is UTC. |
| shop_cipher Required | 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 |
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 | | --- | --- | | 45101001 | Internal error. Please try again later or contact the technical support team for help. | | 45101003 | Record not found. Please check the parameters. | | 45101004 | The query quota has been reached (10000 request per day). Please try again tomorrow. | | 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