---
title: "Get Conversations"
method: GET
path: "/conversations"
tags: ["Conversations"]
---

# Get Conversations

`GET /conversations`

Get Conversations<br>獲取對話列表

## Query parameters

- `platform` 'shop_messages' | 'order_messages' | 'return_order_messages', required
- `customer_id` string
- `page` integer
- `per_page` integer

## Response `200`

OK

- union
  - ShopConversations
    - `pagination` Paginatable
      - `current_page` integer — The current page number<br>當前分頁
      - `per_page` integer — Number of result per page<br>每頁顯示 n 筆資料<br>(Default: 24)
      - `total_count` integer — Number of result in total<br>資料總量
      - `total_pages` integer — Number of pages in total<br>總頁數量
    - `items` ShopConversation[]
      - `id` string — Conversation ID<br>訊息 ID
      - `type` 'shop_messages' | 'order_messages' — Conversation Type<br>訊息平台
      - `customer_id` string — Customer ID<br>客戶 ID
      - `last_message` object
        - `id` string — Conversation ID<br>對話 ID
        - `sender_id` string — Sender ID<br>留言發送方 ID
        - `sender_type` 'Merchant' | 'User' — Sender Type<br>留言發送方
        - `created_at` string — Created At<br>建立時間
        - `value` string — Content<br>對話內容
        - `type` 'text' | 'image' — Conversation Type<br>對話類別
  - OrderConversations
    - `pagination` Paginatable
      - `current_page` integer — The current page number<br>當前分頁
      - `per_page` integer — Number of result per page<br>每頁顯示 n 筆資料<br>(Default: 24)
      - `total_count` integer — Number of result in total<br>資料總量
      - `total_pages` integer — Number of pages in total<br>總頁數量
    - `items` OrderConversation[]
      - `id` string — Conversation ID<br>訊息 ID
      - `type` 'shop_messages' | 'order_messages' — Conversation Type<br>訊息平台
      - `customer_id` string — Customer ID<br>客戶 ID
      - `order_number` string — Order Number<br>訂單號碼
      - `system_order_number` string — 系统生成的訂單號<br>system order number
      - `merchant_order_number` string — 店家自定義訂單號<br>(會根據rollout_key選擇用哪個order_number)
      - `order_id` string — Order ID<br>訂單ID
      - `last_message` object
        - `id` string — Conversation ID<br>對話 ID
        - `sender_id` string — Sender ID<br>留言發送方 ID
        - `sender_type` 'Merchant' | 'User' — Sender Type<br>留言發送方
        - `created_at` string — Created At<br>建立時間
        - `value` string — Content<br>對話內容
        - `type` 'text' | 'image' — Conversation Type<br>對話類別

## Other responses

- `500` — Server error

---

[API](https://skmtc.net/shoplineapp/apis/shopline-open-api.md) · [All operations](https://skmtc.net/shoplineapp/apis/shopline-open-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shoplineapp/shopline-open-api/versions/1675ac12cde7/schema)