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

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

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

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

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

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>

Количество значений на одной странице.

Min value: 1
Example: 20

page_token

Type: string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуем передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры page и pageSize, они игнорируются.
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,
        "context": {
            "type": "ORDER",
            "orderId": 0,
            "returnId": 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

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

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

Enum: OK, ERROR

ChatMessagesResultDTO

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

Name

Description

context*

Type: ChatFullContextDTO

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

messages*

Type: ChatMessageDTO[]

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

orderId

Type: integer<int64>

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

paging

Type: ForwardScrollingPagerDTO

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

ApiResponseStatusType

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

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

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

ChatFullContextDTO

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

Name

Description

type*

Type: ChatContextType

Тип чата:

Enum: ORDER, RETURN, DIRECT

orderId

Type: integer<int64>

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

Возвращается для заказов и возвратов.

Min value: 1

returnId

Type: integer<int64>

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

Возвращается только для возвратов.

Min value: 1

ChatMessageDTO

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

Name

Description

createdAt*

Type: string<date-time>

Дата и время создания сообщения.

Формат даты: ISO 8601 со смещением относительно UTC.

Example: 2017-11-21T00:00:00+03:00

messageId*

Type: integer<int64>

Идентификатор сообщения.

Min value: 1

sender*

Type: ChatMessageSenderType

Отправитель.

Enum: PARTNER, CUSTOMER, MARKET, SUPPORT

message

Type: string

Текст сообщения.

Необязательный параметр, если возвращается параметр payload.

payload

Type: ChatMessagePayloadDTO[]

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

Необязательный параметр, если возвращается параметр message.
Информация о приложенных к сообщению файлах.

Min items: 1

ForwardScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

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

ChatContextType

Тип чата:

Type

Description

ChatContextType

Enum: ORDER, RETURN, DIRECT

ChatMessageSenderType

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

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

Type

Description

ChatMessageSenderType

Enum: PARTNER, CUSTOMER, MARKET, SUPPORT

ChatMessagePayloadDTO

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

Name

Description

name*

Type: string

Название файла.

size*

Type: integer<int32>

Размер файла в байтах.

url*

Type: string

Ссылка для скачивания файла.

Min length: 1

Max length: 2000

400 Bad Request

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

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[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

403 Forbidden

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

404 Not Found

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

420 Method Failure

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

500 Internal Server Error

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

No longer supported, please use an alternative and newer version.