Получение доступных чатов

Info

Console

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

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

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

Возвращает чаты с покупателями.

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

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

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

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

Request

POST

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

Path parameters

Name

Description

businessId*

Type: integer<int64>

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

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

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

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

page_token

Type: string

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

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

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

Если задан page_token и в запросе есть параметры page_number и page_size, они игнорируются.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json

{
    "orderIds": [
        0
    ],
    "types": [
        "CHAT"
    ],
    "statuses": [
        "NEW"
    ]
}

Name	Description
orderIds	Type: integer<int64>[] Фильтр по идентификаторам заказов на Маркете. Min items: `1` Unique items
statuses	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` Min items: `1`
types	Type: ChatType[] Фильтр по типам чатов. Тип чата: `CHAT` — чат с покупателем. `ARBITRAGE` — спор. Enum: `CHAT`, `ARBITRAGE` Min items: `1`

ChatStatusType

Статус чата:

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

Type	Description
ChatStatusType	Enum: `NEW`, `WAITING_FOR_CUSTOMER`, `WAITING_FOR_PARTNER`, `WAITING_FOR_ARBITER`, `WAITING_FOR_MARKET`, `FINISHED`

ChatType

Тип чата:

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

Type	Description
ChatType	Enum: `CHAT`, `ARBITRAGE`

Responses

200 OK

Список чатов.

Body

application/json

{
    "status": "OK",
    "result": {
        "chats": [
            {
                "chatId": 0,
                "orderId": 0,
                "type": "CHAT",
                "status": "NEW",
                "createdAt": "2017-11-21T00:00:00+03:00",
                "updatedAt": "2017-11-21T00:00:00+03:00"
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

result

Type: GetChatsInfoDTO

Список чатов.

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

GetChatsInfoDTO

Список чатов.

Name

Description

chats*

Type: GetChatInfoDTO[]

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

paging

Type: ForwardScrollingPagerDTO

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

ApiResponseStatusType

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

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

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

GetChatInfoDTO

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

Name	Description
chatId*	Type: integer<int64> Идентификатор чата. Min value: `1`
createdAt*	Type: string<date-time> Дата и время создания чата. Формат даты: ISO 8601 со смещением относительно UTC. Example: `2017-11-21T00:00:00+03:00`
orderId*	Type: integer<int64> Идентификатор заказа. Min value: `1`
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`

ForwardScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

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

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

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

Получение одного чата

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