聊天清单 - Ozon Seller API

请求参数

Header 参数

Client-Id

string

用户识别号。

必需

示例值:

Api-Key

string

API-密钥。

必需

示例值:

Body 参数application/json

filter

object (object)

按聊天过滤。

可选

chat_status

string

可选

按聊天状态过滤：

All — 所有聊天。

Opened — 开放的聊天。

Closed — 不开放的聊天。

默认值：All。

unread_only

boolean

可选

按有未读信息的聊天过滤。

limit

integer <int64>

可选

回答中值的数量。默认值为 30。

offset

integer <int64>

可选

回答中要跳过的元素的数量。例如，如果 offset=10，回答将从找到的第11个元素开始。

示例

{
  "filter": {
    "chat_status": "Opened",
    "unread_only": true
  },
  "limit": 1,
  "offset": 0
}

示例代码

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/v2/chat/list' \
--header 'Client-Id: ' \
--header 'Api-Key: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "filter": {
        "chat_status": "Opened",
        "unread_only": true
    },
    "limit": 1,
    "offset": 0
}'

返回响应

🟢200聊天清单

application/json

Body

chats

array [object]

聊天数据。

可选

total_chats_count

integer <int64>

聊天总数。

可选

total_unread_count

integer <int64>

未读信息总数。

可选

示例

{
  "chats": [
    {
      "chat": {
        "created_at": "2022-07-22T08:07:19.581Z",
        "chat_id": "5e767w03-b400-4y1b-a841-75319ca8a5c8",
        "chat_status": "Opened",
        "chat_type": "Seller_Support"
      },
      "first_unread_message_id": "3000000000118021931",
      "last_message_id": "30000000001280042740",
      "unread_count": 1
    }
  ],
  "total_chats_count": 25,
  "total_unread_count": 5
}

🟠400参数有误

🟠403拒绝访问

🟠404未找到答复

🟠409请求冲突

🔴500内部服务器出错