聊天历史记录 - Ozon Seller API

请求参数

Header 参数

Client-Id

string

用户识别号。

必需

Api-Key

string

API-密钥。

必需

Body 参数application/json

chat_id

string

聊天识别码。

必需

direction

string

可选

信息排序方向：

Forward — 从旧到新。

Backward — 从新到旧。

默认值是 — Backward。消息的数量可以在 limit参数中设置。

filter

object (ChatHistoryRequestFilter)

消息过滤器。

可选

message_ids

array[string <uint64>]

消息标识符。

可选

from_message_id

integer <uint64>

可选

从该信息开始整理聊天记录的消息识别码。默认为从最后 — 条可见信息。

limit

integer <int64>

可选

答复的信息数量。默认设置为50。最大值是1000。

示例

{
    "chat_id": "18b8e1f9-4ae7-461c-84ea-8e1f54d1a45e",
    "direction": "Forward",
    "filter": {
        "message_ids": [
            "3000000300211559667"
        ]
    },
    "from_message_id": "3000000000118032000",
    "limit": 1
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api-seller.ozon.ru/v3/chat/history' \
--header 'Client-Id;' \
--header 'Api-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chat_id": "18b8e1f9-4ae7-461c-84ea-8e1f54d1a45e",
    "direction": "Forward",
    "filter": {
        "message_ids": [
            "3000000300211559667"
        ]
    },
    "from_message_id": "3000000000118032000",
    "limit": 1
}'

返回响应

🟢200成功

application/json

聊天历史记录

Body

has_next

boolean

可选

表示不是所有信息都在答复中返回。

messages

array[object (v3ChatMessage) {8}]

可选

根据请求正文中的direction参数排序的信息数组。

context

object (ChatMessageContext)

聊天室信息。

可选

created_at

string <date-time>

信息创建日期。

可选

data

array[string]

可选

Markdown格式的带有信息内容的数组。

is_image

boolean

可选

消息包含图片的标志。

is_read

boolean

表示信息已读。

可选

messageId

integer <uint64>

信息识别码。

可选

moderate_image_status

enum<string>

可选

图片审核状态：

SUCCESS — 审核成功了;

MODERATION — 审核中;

FAILED — 审核失败了.

枚举值:

SUCCESSMODERATIONFAILED

user

object (v3User)

可选

关于聊天参与者的信息。

示例

{
    "has_next": true,
    "messages": [
        {
            "context": {
                "order_number": "123456789",
                "sku": "987654321"
            },
            "created_at": "2019-08-24T14:15:22Z",
            "data": [
                "Здравствуйте, у меня вопрос по вашему товару \"Стекло защитное для смартфонов\", артикул 11223. Подойдет ли он на данную [ модель ](https://www.ozon.ru/product/smartfon-samsung-galaxy-a03s-4-64-gb-chernyy) телефона?"
            ],
            "is_image": true,
            "is_read": true,
            "message_id": "3000000000817031942",
            "moderate_image_status": "SUCCESS",
            "user": {
                "id": "115568",
                "type": "Сustomer"
            }
        }
    ]
}

🟠400请求有误

🟠403禁止访问

🟠404记录不存在

🟠409409

🔴500服务器错误