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

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<int64>

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

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

Min value: 1

Body

application/json

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

Name

Description

context

Type: ChatContextDTO

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

orderId

⦸

Type: integer<int64>

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

ChatContextDTO

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

Name

Description

id*

Type: integer<int64>

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

Min value: 1

type*

Type: ChatContextIdentifiableType

Тип чата:

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

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

Enum: ORDER, RETURN

ChatContextIdentifiableType

Тип чата:

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

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

Type	Description
ChatContextIdentifiableType	Enum: `ORDER`, `RETURN`

Responses

200 OK

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

Body

application/json

{
    "status": "OK",
    "result": {
        "chatId": 0
    }
}

Name

Description

status*

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

result

Type: CreateChatResultDTO

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

ApiResponseStatusType

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

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

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

CreateChatResultDTO

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

Name

Description

chatId*

Type: integer<int64>

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

Min value: 1

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

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

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

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