---
updatedAt: 2026-05-27T07:01:03.000Z
agentTools:
projectIndex: https://open-api.docs.shoplineapp.com/llms.txt
---
# Get Messages
Get Conversations
獲取對話訊息列表
# OpenAPI definition
```json
{
"info": {
"title": "SHOPLINE Open API",
"version": "2.348.2",
"description": "Welcome to the shopline open-api developer hub. You'll find comprehensive guides and documentation to help you start working with shopline open-api as quickly as possible, as well as support if you get stuck. Let's jump right in!"
},
"servers": [
{
"url": "https://open.shopline.io/v1",
"description": "Production"
}
],
"openapi": "3.0.0",
"security": [
{
"bearerAuth": []
}
],
"components": {
"securitySchemes": {
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
},
"schemas": {
"OrderConversationsMessage": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Message ID
訊息 ID",
"example": "58d25b6201cda3475300002b"
},
"type": {
"type": "string",
"description": "Type
訊息類別",
"enum": [
"note",
"message"
]
},
"platform": {
"type": "string",
"description": "Conversation Type
訊息種類",
"enum": [
"shop_messages",
"order_messages"
]
},
"message": {
"type": "object",
"properties": {
"sender_id": {
"type": "string",
"description": "Sender ID
發送者 ID"
},
"sender_type": {
"type": "string",
"description": "Sender Type
發送者類型",
"enum": [
"User",
"Merchant",
"Bot"
]
},
"created_at": {
"type": "string",
"description": "Created At
訊息建立時間"
},
"acting_sender_id": {
"type": "string",
"description": "Performer ID
發送者 ID"
},
"is_sent_by_merchant": {
"type": "boolean",
"description": "Is merchant owner?
是否為 merchant 發送訊息"
},
"content": {
"type": "string",
"description": "Content
文字內容"
},
"attachment": {
"type": "object",
"properties": {
"image_url": {
"type": "string",
"description": "Image Url
圖片連結"
},
"type": {
"type": "string",
"example": "image"
}
}
}
}
}
}
},
"OrderConversationsMessages": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total Number
總筆數",
"example": 24
},
"limit": {
"type": "integer",
"description": "Numbers of Order Messages
顯示筆數",
"example": 24
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderConversationsMessage"
}
}
}
},
"ShopConversationsMessage": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Message ID
訊息 ID",
"example": "58d25b6201cda3475300002b"
},
"platform": {
"type": "string",
"description": "Conversation Type
訊息種類",
"enum": [
"shop_messages",
"order_messages"
]
},
"message": {
"type": "object",
"properties": {
"sender_id": {
"type": "string",
"description": "Sender ID
發送者 ID"
},
"sender_type": {
"type": "string",
"description": "Sender Type
發送者類型",
"enum": [
"User",
"Merchant",
"Bot"
]
},
"created_at": {
"type": "string",
"description": "Created At
訊息建立時間"
},
"acting_sender_id": {
"type": "string",
"description": "Performer ID
發送者 ID"
},
"is_sent_by_merchant": {
"type": "boolean",
"description": "Is Sent by Merchant
是否為 merchant 發送訊息"
},
"content": {
"type": "string",
"description": "Content
文字內容"
},
"attachment": {
"type": "object",
"properties": {
"image_url": {
"type": "string",
"description": "Image Url
圖片連結"
},
"type": {
"type": "string",
"example": "image"
}
}
}
}
}
}
},
"ShopConversationsMessages": {
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total Number
總筆數",
"example": 24
},
"limit": {
"type": "integer",
"description": "Numbers of Shop Messages
顯示筆數",
"example": 24
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShopConversationsMessage"
}
}
}
},
"ServerError": {
"type": "object",
"properties": {
"message": {
"description": "A detailed message of the reason of failure",
"example": "Unable to create EventTrackers",
"type": "string"
},
"code": {
"description": "An error code",
"example": "UnknownError",
"type": "string"
}
}
}
}
},
"paths": {
"/conversations/{conversationId}/messages": {
"get": {
"summary": "Get Messages",
"description": "Get Conversations
獲取對話訊息列表",
"parameters": [
{
"name": "conversationId",
"description": "Conversation's ID
對話ID
Can only input 1 id at once
一次只能輸入一筆",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"example": "622090c66775a37b9fa60799"
},
{
"name": "platform",
"description": "Conversation from shop or order
網店訊息或是訂單訊息
return_order_messages 尚未開放",
"in": "query",
"required": true,
"schema": {
"type": "string",
"enum": [
"shop_messages",
"order_messages",
"return_order_messages"
]
},
"example": "shop_messages"
},
{
"name": "limit",
"description": "Numbers of Messages of Conversations
顯示 n 筆資料",
"in": "query",
"required": false,
"schema": {
"type": "integer"
},
"example": 24
},
{
"name": "start",
"description": "Messages Start From
訊息開始時間",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"example": "2018-01-01 00:00:00"
},
{
"name": "end",
"description": "Messages End Before
訊息結束時間",
"in": "query",
"required": false,
"schema": {
"type": "string"
},
"example": "2018-01-01 00:00:00"
}
],
"tags": [
"Conversations"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/ShopConversationsMessages"
},
{
"$ref": "#/components/schemas/OrderConversationsMessages"
}
]
}
}
}
},
"500": {
"description": "Server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ServerError"
},
"examples": {
"1": {
"summary": "Unknown error",
"value": {
"message": "Unable to get messages",
"code": "UNKNOWN"
}
}
}
}
}
}
}
}
}
},
"tags": [
{
"name": "Conversations",
"description": "Operations about conversations"
}
]
}
```