stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /customer_service/202606/conversations/{conversation_id}/messages
#§2 Method: [POST]
#§3 Function Description
Use this API to send a message to the buyer in a conversation.
§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 Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| conversation_id | string | Y | 7494560109732334262 | Conversation ID |
§6 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. |
§7 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| type | string | Y | TEXT | Message type. Possible enumerations: |
TEXTIMAGEVIDEOPRODUCT_CARDORDER_CARDRETURN_REFUND_CARDCOUPON_CARDLOGISTICS_CARD| content |string |Y |{"content": "test"} |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:
display_type==CHATordisplay_type==REGULARstatus==ONGOINGcreation_source==SELLER_CENTERtarget_buyer_segment!=REPEAT_CUSTOMERS| sender_role |string |N |CUSTOMER_SERVICE |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 |
§8 Request Sample
Query
https://open-api.tiktokglobalshop.com/customer_service/202606/conversations/7494560109732334262/messages?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"type":"TEXT","content":"{\"content\": \"test\"}","sender_role":"CUSTOMER_SERVICE"}
§9 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 | |
| ^message_id | string | 7494560109732334261 | Message ID |
§10 Response Sample
{"code":0,"data":{"message_id":"7494560109732334261"},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§11 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. |
| 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. |