POST Send IM Message
Send IM Message Shop Required scope: seller.affiliate_messages.write The API for sending IM messages. Version 202412
POST/affiliate_seller/202412/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 |
|---|---|---|
| msg_type Required | string | Message type, with possible values:- TEXT- PRODUCT_CARD- TARGET_ COLLABORATION_CARD- FREE_SAMPLE_CARD- IMAGE |
| content Required | string | 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}Note: You can get the value of url by calling Upload Messages Image.target_collaboration_id is Invitation group id. |
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 | | --- | --- | | 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. |
Is this content helpful?Helpful
Not Helpful
PreviousNext