Получение истории сообщений в чате
Возвращает историю сообщений в чате с покупателем.
| ⚙️ Лимит: 10000 запросов в час |
|---|
Request
POST
https://api.partner.market.yandex.ru/businesses/{businessId}/chats/history
Path parameters
|
Name |
Type |
Description |
|
businessId* |
integer<int64> |
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns. |
Query parameters
|
Name |
Type |
Description |
|
chatId* |
integer<int64> |
Идентификатор чата. |
|
page_token |
string |
Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра Если задан |
|
limit |
integer<int32> |
Количество товаров на одной странице.
|
Body
{
"messageIdFrom": 0
}
|
Name |
Type |
Description |
|
messageIdFrom |
integer<int64> |
Идентификатор сообщения, начиная с которого нужно получить все последующие сообщения. |
Responses
200 OK
История сообщений успешно получена.
Body
{
"status": "OK",
"result": {
"orderId": 0,
"messages": [
{
"messageId": 0,
"createdAt": "2022-12-29T18:02:01Z",
"sender": "PARTNER",
"message": "string",
"payload": [
{
"name": "string",
"url": "string",
"size": 0
}
]
}
],
"paging": {
"nextPageToken": "string"
}
}
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
result |
Информация о сообщениях. |
ChatMessagesResultDTO
Информация о сообщениях.
|
Name |
Type |
Description |
|
orderId* |
integer<int64> |
Идентификатор заказа. |
|
messages* |
Информация о сообщениях. |
|
|
paging |
Информация о страницах с результатами. |
ChatMessageDTO
Информация о сообщениях.
|
Name |
Type |
Description |
|
messageId* |
integer<int64> |
Идентификатор сообщения. |
|
createdAt* |
string<date-time> |
Дата и время создания сообщения. Формат даты: ISO 8601 со смещением относительно UTC. Например, 2017-11-21T00:00:00+03:00. |
|
sender* |
Отправитель.
|
|
|
message |
string |
Текст сообщения. Необязательный параметр, если возвращается параметр |
|
payload |
Информация о приложенных к сообщению файлах. Необязательный параметр, если возвращается параметр |
ForwardScrollingPagerDTO
Ссылка на следующую страницу.
|
Name |
Type |
Description |
|
nextPageToken |
string |
Идентификатор следующей страницы результатов. |
ChatMessageSenderType
Кто отправил сообщение:
PARTNER— магазин;CUSTOMER— покупатель;MARKET— Маркет;SUPPORT— сотрудник службы поддержки Маркета.
|
Type |
Description |
|
Enum: |
ChatMessagePayloadDTO
Информация о приложенных к сообщению файлах.
|
Name |
Type |
Description |
|
name* |
string |
Имя файла. |
|
url* |
string |
Ссылка для скачивания файла. |
|
size* |
integer<int32> |
Размер файла в байтах. |
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Type |
Description |
|
code* |
string |
Код ошибки. |
|
message |
string |
Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |