Получение сообщения в чате

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}/chats/message

Path parameters

Name

Description

businessId

Type: integer

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

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

Min value: 1

Query parameters

Name

Description

chatId

Type: integer

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

Min value: 1

messageId

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"
}

ChatMessageSenderType

Кто отправил сообщение:

PARTNER — магазин.
CUSTOMER — покупатель.
MARKET — Маркет (автоматическое сообщение).
SUPPORT — сотрудник службы поддержки Маркета.

Type: string

Enum: PARTNER, CUSTOMER, MARKET, SUPPORT

Url

Type: string

Min length: 1

Max length: 2000

Example: example

ChatMessagePayloadDTO

Информация о приложенных к сообщению файлах.

Name	Description
name	Type: string Название файла. Example: `example`
size	Type: integer Размер файла в байтах.
url	Type: Url Ссылка для скачивания файла. Min length: `1` Max length: `2000` Example: `example`

Example

{
  "name": "example",
  "url": "example",
  "size": 0
}

ChatMessageDTO

Информация о сообщении.

Name	Description
createdAt	Type: string<date-time> Дата и время создания сообщения. Формат даты: ISO 8601 со смещением относительно UTC. Example: `2017-11-21T00:00:00+03:00`
messageId	Type: integer Идентификатор сообщения. Min value: `1`
sender	Type: ChatMessageSenderType Отправитель. Кто отправил сообщение: `PARTNER` — магазин. `CUSTOMER` — покупатель. `MARKET` — Маркет (автоматическое сообщение). `SUPPORT` — сотрудник службы поддержки Маркета. Enum: `PARTNER`, `CUSTOMER`, `MARKET`, `SUPPORT`
message	Type: string Текст сообщения. Необязательный параметр, если возвращается параметр `payload`. Example: `example`
payload	Type: ChatMessagePayloadDTO[] \| null Информация о приложенных к сообщению файлах. Необязательный параметр, если возвращается параметр `message`. Min items: `1` Example `[ { "name": "example", "url": "example", "size": 0 } ]`

Example

{
  "messageId": 1,
  "createdAt": "2017-11-21T00:00:00+03:00",
  "sender": "PARTNER",
  "message": "example",
  "payload": [
    {
      "name": "example",
      "url": "example",
      "size": 0
    }
  ]
}

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

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

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

Создание нового чата