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

Info

Console

Возвращает историю сообщений в чате с покупателем.

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

Request

POST

https://api.partner.market.yandex.ru/businesses/{businessId}/chats/history

Path parameters

Name

Description

businessId*

Type: integer<int64>

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

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

Min value: 1

Query parameters

Name	Description
chatId*	Type: integer<int64> Идентификатор чата. Min value: `1`
limit	Type: integer<int32> Количество значений на одной странице. Example: `20`
page_token	Type: string Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра `nextPageToken`, полученное при последнем запросе. Если задан `page_token` и в запросе есть параметры `offset`, `page_number` и `page_size`, они игнорируются. Example: `eyBuZXh0SWQ6IDIzNDIgfQ==`

Body

application/json

{
    "messageIdFrom": 0
}

Name

Description

messageIdFrom

Type: integer<int64>

Идентификатор сообщения, начиная с которого нужно получить все последующие сообщения.

Min value: 1

Responses

200 OK

История сообщений успешно получена.

Body

application/json

{
    "status": "OK",
    "result": {
        "orderId": 0,
        "messages": [
            {
                "messageId": 0,
                "createdAt": "2017-11-21T00:00:00+03:00",
                "sender": "PARTNER",
                "message": "string",
                "payload": [
                    {
                        "name": "string",
                        "url": "string",
                        "size": 0
                    }
                ]
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

result

Type: ChatMessagesResultDTO

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

ChatMessagesResultDTO

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

Name	Description
messages*	Type: ChatMessageDTO[] Информация о сообщениях. Информация о сообщениях.
orderId*	Type: integer<int64> Идентификатор заказа.
paging	Type: ForwardScrollingPagerDTO Информация о страницах с результатами.

ApiResponseStatusType

Тип ответа.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

ChatMessageDTO

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

Name	Description
createdAt*	Type: string<date-time> Дата и время создания сообщения. Формат даты: ISO 8601 со смещением относительно UTC. Example: `2017-11-21T00:00:00+03:00`
messageId*	Type: integer<int64> Идентификатор сообщения.
sender*	Type: ChatMessageSenderType Отправитель. Enum: `PARTNER`, `CUSTOMER`, `MARKET`, `SUPPORT`
message	Type: string Текст сообщения. Необязательный параметр, если возвращается параметр `payload`.
payload	Type: ChatMessagePayloadDTO[] Информация о приложенных к сообщению файлах. Необязательный параметр, если возвращается параметр `message`. Информация о приложенных к сообщению файлах.

ForwardScrollingPagerDTO

Ссылка на следующую страницу.

Name

Description

nextPageToken

Type: string

Идентификатор следующей страницы результатов.

ChatMessageSenderType

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

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

Type	Description
ChatMessageSenderType	Enum: `PARTNER`, `CUSTOMER`, `MARKET`, `SUPPORT`

ChatMessagePayloadDTO

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

Name	Description
name*	Type: string Имя файла. Min length: `1`
size*	Type: integer<int32> Размер файла в байтах.
url*	Type: string Ссылка для скачивания файла.

400 Bad Request

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

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

ApiErrorDTO

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

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

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

401 Unauthorized

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

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

403 Forbidden

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

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

404 Not Found

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

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

420 Method Failure

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

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

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

Заказы, которые повлияли на индекс качества

Список чатов