POST Send Message
Send Message Shop Required scope: seller.customer_service Use this API to send a message to the buyer in a conversation. Version 202606
POST/customer_service/202606/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. |
| 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 |
Body
| Properties | Type | Description |
|---|---|---|
| type Required | string | Message type. Possible enumerations:- TEXT- IMAGE- VIDEO- PRODUCT_CARD- ORDER_CARD- RETURN_REFUND_CARD- COUPON_CARD- LOGISTICS_CARD |
| content Required | string | Message content, in JSON serialized string.Examples of content for each type of message are listed below:- TEXT:{ "content": "hi, I want to get refunded."}(Note: Max 2000 characters. Do not use sensitive words that violate TikTok Shop terms & policies.)- VIDEO{ "vid": "v10394g5000cd499vc7og65mqn3r3dg0"}- LOGISTICS_CARD{ "order_id": "580874485811283206", "package_id": "123456" // Optional (recommended for one order with multiple packages; not required for one order with one package)}- PRODUCT_CARD{ "product_id": "7494560109732334265"}- ORDER_CARD:{ "order_id": "7494560109732334267"}- RETURN_REFUND_CARD:{ "order_id": "7494560109732334267", "sku_id": "7494560109732363423"}Note: The order of the RETURN_REFUND_CARD to send must meet after-sale conditions. To check the eligibility, use Get Aftersale Eligibility.- IMAGE:{ "url":"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/2ca53c34ad8443e6b39f4e0153d3aed4~tplv-o3syd03w52-origin-image.image?from=1320446476", "width": 1280, "height": 720}Note: You can get the value of url by calling Upload Buyer Messages Image.- COUPON_CARD:{ "coupon_id": "7262992004278206762"}Note: Coupons that can be sent in a message must meet all the following conditions:1. display_type==CHAT or display_type==REGULAR2. status==ONGOING3. creation_source==SELLER_CENTER4. target_buyer_segment!=REPEAT_CUSTOMERS |
| sender_role | string | Message sending role.- 'CUSTOMER_SERVICE' : Messages replied by real customer service- 'SYSTEM': Replies automatically triggered by the system, such as welcome messages and timeout replies- 'ROBOT': Messages replied by intelligent robot |
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. | | 45101002 | Invalid params. The RETURN_REFUND_CARD must meet the conditions listed above. | | 45101003 | Record not found. Please check the parameters. | | 45101004 | The query quota has been reached (10000 request per day). Please try again tomorrow. | | 45101006 | You cannot send the message containing sensitive content. Please check the message. | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. | | 45102007 | No permission to access this conversation. There may be data corruption. Please try again later or contact the technical support team for help. | | 45109001 | Unable to send messages due to conversation rules. For details, please refer to Customer Service API overview. | | 45111001 | not support | | 45111007 | The buyer has already reached the maximum claim limit for this coupon. | | 45111012 | Failed to send the coupon card message due to exceeding the QPS limit. The QPS limit of sending coupon card messages is 0.5. | | 45111017 | Invalid params. The COUPON_CARD must meet the conditions listed above. |
Is this content helpful?Helpful
Not Helpful
PreviousNext