(33) New message listener

POST

When a creator sends a message to the seller.

Authorizations

• webhookSignature

Request Body^required

Media typeapplication/json

object

type

required

The ID of the webhook type.

integer

Allowed value: 33

shop_id

TikTok shop ID.

string

tts_notification_id

ID of the webhook.

string

timestamp

The UNIX timestamp when this webhook was triggered.

integer format: int64

data

object

index

Index of the message in the conversation. A large index number corresponds to newer message.

string

message_id

Message ID.

string

conversation_id

ID of the conversation to which the message belongs.

string

msg_type

Message type, with possible values:

• TEXT
• PRODUCT_CARD
• TARGET_COLLABORATION_CARD
• FREE_SAMPLE_CARD

string

Allowed values: TEXT PRODUCT_CARD TARGET_COLLABORATION_CARD FREE_SAMPLE_CARD

content

Message content, in JSON serialized string.

• TEXT: {“content”: “simple text”}
• PRODUCT_CARD: {“product_id”: “12345”}
• TARGET_INVITATION_CARD: {“invitation_group_id”: “1234”}
• FREE_SAMPLE_CARD: {“apply_id”: “1234”}

string

create_time

Message creation time, represented as a Unix timestamp (seconds).

string

sender

object

sender_im_user_id

ID in IM system for the sender.

string

Example

{
  "type": 33,
  "shop_id": "7494049642642441621",
  "tts_notification_id": "7327112393057371910",
  "timestamp": 1644412885,
  "data": {
    "index": "1735032460678899",
    "message_id": "7451907556216407553",
    "conversation_id": "7451873679308620048",
    "msg_type": "TEXT",
    "content": "Hello",
    "create_time": "1691411573",
    "sender": {
      "sender_im_user_id": "2368694990397660924"
    }
  }
}

Responses

200

Return HTTP 200 to acknowledge receipt.