Создание нового чата с покупателем

Info

Console

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

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

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

Создает новый чат с покупателем и возвращает информацию о нем или созданном ранее.

Типы чатов, которые может начать продавец:

по заказам;
по возвратам (доступны только для FBY-, FBS- и Экспресс-магазинов).

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

Request

POST

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

Path parameters

Name

Description

businessId

Type: integer

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

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

Min value: 1

Body

application/json

{
  "orderId": 0,
  "context": {
    "type": "ORDER",
    "id": 1
  }
}

Name

Description

context

Type: ChatContextDTO

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

Example

{
  "type": "ORDER",
  "id": 1
}

orderId

Type: integer

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

ChatContextIdentifiableType

Тип чата:

ORDER — по заказам.
RETURN — по возвратам (FBY, FBS и Экспресс).

Подробнее о чатах по заказам и возвратам читайте в Справке Маркета для продавцов.

Type: string

Enum: ORDER, RETURN

ChatContextDTO

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

Name

Description

Type: integer

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

Min value: 1

type

Type: ChatContextIdentifiableType

Тип чата:

ORDER — по заказам.
RETURN — по возвратам (FBY, FBS и Экспресс).

Подробнее о чатах по заказам и возвратам читайте в Справке Маркета для продавцов.

Enum: ORDER, RETURN

Example

{
  "type": "ORDER",
  "id": 1
}

Responses

200 OK

Информация о новом или созданном ранее чате.

Body

application/json

{
  "status": "OK"
}

Type: object

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

Example

{
  "status": "OK"
}

CreateChatResultDTO

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

Name

Description

chatId

Type: integer

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

Min value: 1

Example

{
  "chatId": 1
}

400 Bad Request

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

Body

application/json

{
  "status": "OK"
}

Type: object

ApiErrorDTO

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

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

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

Example: example

Example

{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

Type: ApiResponse

Стандартная обертка для ответов сервера.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: ApiErrorDTO[] | null

Список ошибок.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Example

{
  "status": "OK"
}

401 Unauthorized

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

Body

application/json

{
  "status": "OK"
}

Type: object

403 Forbidden

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

Body

application/json

{
  "status": "OK"
}

Type: object

404 Not Found

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

Body

application/json

{
  "status": "OK"
}

Type: object

420 Method Failure

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

Body

application/json

{
  "status": "OK"
}

Type: object

500 Internal Server Error

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

Body

application/json

{
  "status": "OK"
}

Type: object

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

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

Отправка сообщения