Получение чата по идентификатору

Info

Console

Метод доступен для всех моделей.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

communication — Общение с покупателями
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всех данных

Возвращает чат по его идентификатору.

Подключите API-уведомления

Маркет отправит вам запрос POST notification, когда появится новый чат или сообщение.

Как работать с уведомлениями

⚙️ Лимит: 1 000 запросов в час

Request

GET

https://api.partner.market.yandex.ru/v2/businesses/{businessId}/chat

Path parameters

Name

Description

businessId

Type: integer

Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

Query parameters

Name

Description

chatId

Type: integer

Идентификатор чата.

Min value: 1

Responses

200 OK

Информация о чате.

Body

application/json

{
  "status": "OK"
}

Type: object

ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

Example

{
  "status": "OK"
}

ChatContextType

Тип контекста:

ORDER — чат по заказу. Чаты о заказах и возвратах
RETURN — чат по возврату (FBY, FBS и Экспресс). Чаты о заказах и возвратах
DIRECT — чат, который начал покупатель. Сообщения от покупателей

Type: string

Enum: ORDER, RETURN, DIRECT

ChatCustomerDTO

Информация о покупателе в чате.

Name

Description

name

Type: string

Публичное имя покупателя в Яндекс Паспорте, которое отображается в сервисах Яндекса.

Min length: 1

Example: example

publicId

Type: string

Публичный идентификатор пользователя в Яндекс Паспорте.

Примеры, где используется

Маркет: https://market.yandex.ru/user/{public-id}/reviews
Дзен: https://zen.yandex.ru/user/{public-id}
Отзывы: https://yandex.ru/user/{public-id}

Подробнее о публичных данных читайте в документации Яндекс ID.

Min length: 1

Example: example

Example

{
  "name": "example",
  "publicId": "example"
}

CampaignId

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

блок Идентификатор кампании;
вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не путайте его с:

идентификатором магазина, который отображается в личном кабинете продавца;
рекламными кампаниями.

Type: integer

Min value: 1

ChatFullContextDTO

Информация о заказе или возврате, по которому начат чат.

Name	Description
type	Type: ChatContextType Тип контекста: `ORDER` — чат по заказу. Чаты о заказах и возвратах `RETURN` — чат по возврату (FBY, FBS и Экспресс). Чаты о заказах и возвратах `DIRECT` — чат, который начал покупатель. Сообщения от покупателей Enum: `ORDER`, `RETURN`, `DIRECT`
campaignId	Type: CampaignId Возвращается для заказов и возвратов. Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия. Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули: блок Идентификатор кампании; вкладка Лог запросов → выпадающий список в блоке Показывать логи. ⚠️ Не путайте его с: идентификатором магазина, который отображается в личном кабинете продавца; рекламными кампаниями. Min value: `1` Example: `1`
customer	Type: ChatCustomerDTO Информация о покупателе. Информация о покупателе в чате. Example `{ "name": "example", "publicId": "example" }`
orderId	Type: integer Идентификатор заказа. Возвращается для заказов и возвратов. Min value: `1`
returnId	Type: integer Идентификатор возврата. Возвращается только для возвратов. Min value: `1`

Example

{
  "type": "ORDER",
  "customer": {
    "name": "example",
    "publicId": "example"
  },
  "campaignId": 1,
  "orderId": 1,
  "returnId": 1
}

ChatType

Тип чата:

CHAT — чат с покупателем.
ARBITRAGE — спор.

Type: string

Enum: CHAT, ARBITRAGE

ChatStatusType

Статус чата:

NEW — новый чат.
WAITING_FOR_CUSTOMER — нужен ответ покупателя.
WAITING_FOR_PARTNER — нужен ответ магазина.
WAITING_FOR_ARBITER — нужен ответ арбитра.
WAITING_FOR_MARKET — нужен ответ Маркета.
FINISHED — чат завершен.

Type: string

Enum: NEW, WAITING_FOR_CUSTOMER, WAITING_FOR_PARTNER, WAITING_FOR_ARBITER, WAITING_FOR_MARKET, FINISHED

GetChatInfoDTO

Информация о чате.

Name	Description
chatId	Type: integer Идентификатор чата. Min value: `1`
context	Type: ChatFullContextDTO Информация о заказе или возврате, по которому начат чат. Example `{ "type": "ORDER", "customer": { "name": "example", "publicId": "example" }, "campaignId": 1, "orderId": 1, "returnId": 1 }`
createdAt	Type: string<date-time> Дата и время создания чата. Формат даты: ISO 8601 со смещением относительно UTC. Example: `2017-11-21T00:00:00+03:00`
status	Type: ChatStatusType Статус чата: `NEW` — новый чат. `WAITING_FOR_CUSTOMER` — нужен ответ покупателя. `WAITING_FOR_PARTNER` — нужен ответ магазина. `WAITING_FOR_ARBITER` — нужен ответ арбитра. `WAITING_FOR_MARKET` — нужен ответ Маркета. `FINISHED` — чат завершен. Enum: `NEW`, `WAITING_FOR_CUSTOMER`, `WAITING_FOR_PARTNER`, `WAITING_FOR_ARBITER`, `WAITING_FOR_MARKET`, `FINISHED`
type	Type: ChatType Тип чата: `CHAT` — чат с покупателем. `ARBITRAGE` — спор. Enum: `CHAT`, `ARBITRAGE`
updatedAt	Type: string<date-time> Дата и время последнего сообщения в чате. Формат даты: ISO 8601 со смещением относительно UTC. Example: `2017-11-21T00:00:00+03:00`
orderId	Type: integer Идентификатор заказа. Min value: `1`

Example

{
  "chatId": 1,
  "orderId": 1,
  "context": {
    "type": "ORDER",
    "customer": {
      "name": "example",
      "publicId": "example"
    },
    "campaignId": 1,
    "orderId": 1,
    "returnId": 1
  },
  "type": "CHAT",
  "status": "NEW",
  "createdAt": "2017-11-21T00:00:00+03:00",
  "updatedAt": "2017-11-21T00:00:00+03:00"
}

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

application/json

{
  "status": "OK"
}

Type: object

ApiErrorDTO

Общий формат ошибки.

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

Описание ошибки.

Example: example

Example

{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

Type: ApiResponse

Стандартная обертка для ответов сервера.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: ApiErrorDTO[] | null

Список ошибок.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Example

{
  "status": "OK"
}

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json

{
  "status": "OK"
}

Type: object

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json

{
  "status": "OK"
}

Type: object

404 Not Found

Запрашиваемый ресурс не найден. Подробнее об ошибке

Body

application/json

{
  "status": "OK"
}

Type: object

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json

{
  "status": "OK"
}

Type: object

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json

{
  "status": "OK"
}

Type: object

Была ли статья полезна?

История сообщений

Получение списка чатов