聊天清单 - Ozon Seller API

请求参数

Header 参数

Client-Id

string

用户识别号。

必需

示例值:

Api-Key

string

API-密钥。

必需

示例值:

Body 参数application/json

chat_id_list

array[string]

可选

需要输出信息的带有聊天识别码的数组。

page

integer <int32>

答复中的页数。

可选

page_size

integer <int32>

可选

每页的聊天次数。默认值为100。最大值是1000。

with

object (object)

可选

要添加到答复中的额外字段。

first_unread_message_id

boolean

可选

答复中first_unread_message_id参数生成属性。如果true，您将得到答复中第一条未读信息的识别码。

unread_count

boolean

可选

答复中unread_count参数生成属性。如果true，您将在答复中得到未读聊天信息的数量。

示例

{
  "chat_id_list": [
    "83ef37bf-f13d-494c-a906-1e444d633d27"
  ],
  "page": 1,
  "page_size": 10,
  "with": {
    "first_unread_message_id": true,
    "unread_count": true
  }
}

示例代码

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/v1/chat/list' \
--header 'Client-Id: ' \
--header 'Api-Key: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chat_id_list": [
        "83ef37bf-f13d-494c-a906-1e444d633d27"
    ],
    "page": 1,
    "page_size": 10,
    "with": {
        "first_unread_message_id": true,
        "unread_count": true
    }
}'

返回响应

🟢200聊天清单

application/json

Body

result

array[object (Chat models) {5}]

可选

first_unread_message_id

integer <uint64>

可选

第一条未读聊天信息的识别码。

id

string

聊天识别码。

可选

last_message_id

integer <uint64>

可选

最后一条聊天信息的识别码。

unread_count

integer <int64>

可选

聊天中未读消息的数量。

users

array[object (object) {2}]

可选

聊天室参与者的名单。

total_unread_count

integer <int64>

未读消息的总数。

可选

示例

{
  "result": [
    {
      "id": "83ef37bf-f13d-494c-a906-1e444d633d27",
      "users": [
        {
          "id": "123",
          "type": "seller"
        },
        {
          "id": "71252940",
          "type": "customer"
        }
      ],
      "last_message_id": 3000000001834744300,
      "unread_count": 0,
      "first_unread_message_id": 0
    }
  ],
  "total_unread_count": 0
}

🟠400参数有误

🟠403拒绝访问

🟠404未找到答复

🟠409请求冲突

🔴500内部服务器出错