Message Types

Context

This API enables you to retrieve standardized card information for displaying conversational data. You can choose to use it based on your specific requirements. Our overall data is divided into three parts, and the content contained within these three sections may vary depending on the scenario, user, or purpose. Content The field content contains metadata of the message content, including only a limited set of key fields. Custom UI? Build from Raw Data The field data encapsulates the business data related to the message, such as order, product, or logistics information. Developers can use this field to build custom UI representations based on their own requirements. This field is returned only when request.query.need_data=true. Note that business data may be time-sensitive. Need Speed? Use Plaintext. The field plaintext is a plain text representation of the message intended for UI display. It already includes relevant business information, and developers may directly use this field for UI rendering without additional processing. This field is returned only when request.query.need_plaintext=true. Note that business data may be time-sensitive.

TEXT

content

Properties

Example

{
  "content": "simple text"
}

IMAGE / EMOTICONS

content

{
   "url": "https://tosv.boei18n.byted.org/obj/temai-im/FszkJ53nSapYG6KDaJQmqR3jjoZGwww304-290",
  "width": 300,
  "height": 300
}

Properties

VIDEO

content

{
  "url": "https://video-boei18n.byted.org/storage/v1/tos-boei18n-v-c72c01/e8240f35244646428df9c3244d1a7408?x-tos-algorithm=v2&x-tos-authkey=5bf25627da095a5cba28ace592de46cc&x-tos-expires=1681980481&x-tos-signature=r_bRxtrvGhXAuZgMmNhlZ_Upqzg",
  "cover": "https://p-boei18n.byted.org/tos-boei18n-v-c72c01/o8keEOhzTcNCcJyAbkWZwpLIyTfkJxcGbRBvLP~tplv-jvtte31kaf-origin-jpeg.jpeg?",
  "width": 640,
  "height": 360,
  "duration": "20.504",
  "vid": "v0e30cg700f7cgcmu8jc77u9e2bdp95g",
  "expire_time": "1681980481",
  "format": "mp4",
  "size": 400000,
  "bit_rate": 156067,
  "quality": "original",
  "codec_type": "h264"
}

Properties

ORDER_CARD

content

Properties

Example

{
  "order_id": "123"
}

data

Properties

Example

{
  "order_id": "123",
  "order_status": "Delivered",
  "product_id": "1234",
  "product_name": "abc",
  "product_image": "https://p16-oec-sg.ibyteimg.com/tos-alisg-i-aphluv4xwc-sg/1a80a431f63f447dbcb7f19b666757ea~tplv-aphluv4xwc-resize-webp:800:800.webp?dr=15582&t=555f072d&ps=933b5bde&shp=f359665f&shcp=5566cfe3&idc=my2&from=4082722399",
  "paid_price": "Rp16.000",
  "quantity": 3,
  "order_link": "https://seller-us.tiktok.com/order/detail?order_no=123"
}

plaintext

Example

Order card shared:
- Order ID: 582362672348497014; 
- Current order status: Delivered; 
- Number of items: 3; 
- Order payment amount: Rp16.000. 

View full details at: https://abc.com/

PRODUCT_CARD

content

Properties

Example

{
  "product_id": "1234"
}

data

Properties

Example

{
  "product_id": "1234",
  "product_name": "abc",
  "product_image": "https://p16-oec-sg.ibyteimg.com/tos-alisg-i-aphluv4xwc-sg/1a80a431f63f447dbcb7f19b666757ea~tplv-aphluv4xwc-resize-webp:800:800.webp?dr=15582&t=555f072d&ps=933b5bde&shp=f359665f&shcp=5566cfe3&idc=my2&from=4082722399",
  "product_highest_price": "139.000₫",
  "product_lowest_price": "119.000₫",
  "sold_quantity": 40013,
  "product_link": "https://seller-us.tiktok.com/product/manage?search_content=1234"
}

plaintext

Example

Product card shared:
- Product ID: 1732529206731441911; 
- Product name: abc; 
- Product lowest price: 119.000₫; 
- Product highest price: 139.000₫;
- Sold: 40642. 

View full details at: https://abc.com/

RETURN_REFUND_CARD

content

Properties

Example

{
  "order_id": "123",
  "sku_id": "1234"
}

data

Properties

Example

{
  "sku_id": "1",
  "order_id": "123",
  "order_status": "Delivered",
  "product_id": "1234",
  "product_name": "abc",
  "product_image": "https://p16-oec-sg.ibyteimg.com/tos-alisg-i-aphluv4xwc-sg/1a80a431f63f447dbcb7f19b666757ea~tplv-aphluv4xwc-resize-webp:800:800.webp?dr=15582&t=555f072d&ps=933b5bde&shp=f359665f&shcp=5566cfe3&idc=my2&from=4082722399",
  "paid_price": "Rp10.667",
  "quantity": 2,
  "order_link": "https://seller-us.tiktok/com/order/detail?order_no=123"
}

plaintext

Example

Return/refund form shared:
- SKU ID: 1; 
- Order ID: 123;
- Order status: Delivered; 
- Product ID: 1234; 
- Product name: abc; 
- Number of items: 2; 
- Reverse amount: Rp10.667.

COUPON_CARD

content

Properties

Example

{
  "coupon_id": "12"
}

data

Properties

Example

{
  "coupon_id": "12",
  "coupon_title": "cheap",
  "coupon_type": "Regular",
  "discount": "₱26.00 off",
  "threshold": "on order over ₱196.00",
  "scope": "Selected products",
  "start_time": 1768634640,
  "end_time": 1773829080,
  "coupon_link": "https://seller-us.toktok.com/promotion/marketing-tools/voucher/view/12"
}

plaintext

Example

Coupon shared:
- Coupon ID: 12; 
- Coupon title: cheap; 
- Coupon discount: ₱26.00 off;
- Coupon scope: Selected products;
- Coupon condition: on order over ₱196.00; 
- Coupon validity: Jan 17, 2026 3:24 PM to Mar 18, 2026 6:18 PM GMT+08:00. 

View full details at: https://abc.com/

LOGISTICS_CARD

content

Properties

Example

{
  "order_id": "123",
  "package_id": "12345"
}

data

Properties

• Package

• Tracking

Example

{
  "packages": [
    {
      "package_id": "12345",
      "product_name": "abc",
      "product_image": "https://p16-oec-sg.ibyteimg.com/tos-alisg-i-aphluv4xwc-sg/1a80a431f63f447dbcb7f19b666757ea~tplv-aphluv4xwc-resize-webp:800:800.webp?dr=15582&t=555f072d&ps=933b5bde&shp=f359665f&shcp=5566cfe3&idc=my2&from=4082722399",
      "paid_price": "$0.01",
      "quantity": 1,
      "predict_delivery_time_min": 1763198750000,
      "predict_delivery_time_max": 1763457950000,
      "delivery_option": "Standard shipping",
      "tracking_number": "1ZCIETST0422222228",
      "shipping_provider_name": "UPS",
      "tracking": [
        {
          "description": "Package has been delivered!",
          "update_time_millis": 1763954669267
        },
        {
          "description": "Arrived at the carrier's facility.",
          "update_time_millis": 1763954598311
        }
      ]
    }
  ]
}

plaintext

Example

Logistics card shared:
- Order ID: 123;
- Package ID: 12345;
- Number of items: 1; 
- Order payment amount: Rp63.852; 
- Delivery option: Economy shipping
- J&T Express: JX7053814071; 
- Estimated delivery date: Jan 17, 2026 3:24 PM - Mar 18, 2026 6:18 PM GMT+08:00; 
- Logistics latest update: 
  Jan 30, 2026 2:35 AM
  Your package has left the sorting center in Tangerang City.
  Jan 30, 2026 1:48 AM
  Your package has arrived at the sorting center in Tangerang City.
  Jan 29, 2026 9:03 PM
  Your package has been collected by our carrier in Tangerang Regency.
  Jan 29, 2026 1:34 PM
  The seller is preparing your package, and will hand it over to our carrier for shipping..

View full details at: https://abc.com/

[Others]

OTHER / NOTIFICATION / ALLOCATED_SERVICE / BUYER_ENTER_FROM_TRANSFER

content

Properties

Example

{
  "content": "...."
}