stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_seller/202412/conversations/{conversation_id}/messages
#§2 Method: [POST]
#§3 Function Description
The API for sending IM messages.
§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 | 1234 | 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 |
|---|---|---|---|---|
| msg_type | string | Y | TEXT | Message type, with possible values: |
- TEXT
- PRODUCT_CARD
- TARGET_ COLLABORATION_CARD
- FREE_SAMPLE_CARD
- IMAGE
- CRM_TEXT_WITH_IMAGE_CARD
- CRM_TEXT_WITH_PRODUCTS_CARD | content |string |Y |{"content": "simple text message"} |Message content, in JSON serialized string. Examples:
- TEXT: {"content": "simple text"}
- PRODUCT_CARD: {"product_id": "12345"}
- TARGET_ COLLABORATION_CARD {"target_collaboration_id": "1234"}
- FREE_SAMPLE_CARD {"apply_id": "1234"}
- 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 }
- CRM_TEXT_WITH_PRODUCTS_CARD supports a maximum of 5 product IDs. {"product_ids": "12345,123456", "title":"abc", "content":"abc"}
- CRM_TEXT_WITH_IMAGE_CARD {"image_url": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/2ca53c34ad8443e6b39f4e0153d3aed4~tplv-o3syd03w52-origin-image.image?from=1320446476","title":"abc", "content":"abc"}
Note: You can get the value of url by calling Upload Messages Image. target_collaboration_id is Invitation group id. |
§8 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_seller/202412/conversations/1234/messages?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"msg_type":"TEXT","content":"{\"content\": \"simple text message\"}"}
§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 | 1234444 | The message ID. |
§10 Response Sample
{"code":0,"data":{"message_id":"1234444"},"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 |
|---|---|
| 16030100 | Shop has reached IM send message quota with this creator |
| 16030101 | Seller account is abnormal or you can't contact this creator because shop level didn't meet the GMV requirement. |
| 16032001 | nvalid parameter Creator and Seller, please ensure Region mismatch. |
| 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. |