Получение доступных чатов
Возвращает ваши чаты с покупателями.
⚙️ Лимит: 10000 запросов в час |
---|
Request
POST
https://api.partner.market.yandex.ru/businesses/{businessId}/chats
Path parameters
Name |
Description |
businessId* |
Type: integer<int64> Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
Min value: |
Query parameters
Name |
Description |
limit |
Type: integer<int32> Количество значений на одной странице.
|
page_token |
Type: string Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуется передавать значение выходного параметра Если задан |
Body
application/json
{
"orderIds": [
0
],
"types": [
"CHAT"
],
"statuses": [
"NEW"
]
}
Name |
Description |
orderIds |
Type: integer<int64>[] Фильтр по идентификаторам заказов на Маркете. Min items: Unique items: |
statuses |
Type: ChatStatusType[] Фильтр по статусам чатов.
Enum: Min items: |
types |
Type: ChatType[] Фильтр по типам чатов.
Enum: Min items: |
ChatStatusType
Статус чата:
NEW
— новый чат.WAITING_FOR_CUSTOMER
— нужен ответ покупателя.WAITING_FOR_PARTNER
— нужен ответ магазина.WAITING_FOR_ARBITER
— нужен ответ арбитра.WAITING_FOR_MARKET
— нужен ответ Маркета.FINISHED
— чат завершен.
Type |
Description |
Enum: |
ChatType
Тип чата:
CHAT
— чат с покупателем.ARBITRAGE
— спор.
Type |
Description |
Enum: |
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 Тип ответа. Enum: |
GetChatsInfoDTO
Список чатов.
Name |
Description |
chats* |
Type: GetChatInfoDTO[] Информация о чатах. |
paging |
Type: ForwardScrollingPagerDTO Информация о страницах с результатами. |
GetChatInfoDTO
Информация о чатах.
Name |
Description |
chatId* |
Type: integer<int64> Идентификатор чата. Min value: |
createdAt* |
Type: string<date-time> Дата и время создания чата. Формат даты: ISO 8601 со смещением относительно UTC. Example: |
orderId* |
Type: integer<int64> Идентификатор заказа. |
status* |
Type: ChatStatusType Статус чата:
Enum: |
type* |
Type: ChatType Тип чата:
Enum: |
updatedAt* |
Type: string<date-time> Дата и время последнего сообщения в чате. Формат даты: ISO 8601 со смещением относительно UTC. Example: |
ForwardScrollingPagerDTO
Ссылка на следующую страницу.
Name |
Description |
nextPageToken |
Type: string Идентификатор следующей страницы результатов. |
400 Bad Request
Запрос содержит неправильные данные.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
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: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
404 Not Found
Запрашиваемый ресурс не найден.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |