Сообщение пользователя
Позволяет передавать сообщение пользователя Авто.ру на сервер внешней системы.
Формат запроса
Важно.
Запрос отправляется на URL, указанный в личном кабинете дилера.
POST https://api.example.com/
? chat_id=<string>
|
chat_id* |
Внешний идентификатор чата. Задается в личном кабинете дилера в поле ChatId при подключении приложения. Должен уникальным образом идентифицировать одного клиента Авто.ру, для которого выполняются запросы. |
* Обязательный параметр
Формат тела запроса
{
"sender": {
"id": {string},
"name": {string},
"photo": {string},
"url": {string},
"title": {string}
},
"message" : {
"type": {string},
"id": {string},
"text": {string},
"file": {string},
"thumb": {string}
}
}
|
sender* |
Информация о пользователе. |
-
id*
Идентификатор пользователя.
name*
Имя пользователя Авто.ру.
photo*
Фото из объявления, из которого пользователь начал чат.
url*
Ссылка на объявление, из которого пользователь начал чат.
title*
Заголовок чата.
|
message* |
Информация о сообщении. |
-
type*
Тип сообщения.
Допустимые значения:
photo— сообщение с изображением;text— текстовое сообщение.
id*
Идентификатор сообщения.
Примечание
Параметр используется для обеспечения идемпотентности. Если запрос повторяется с тем же
message.id, его необходимо проигнорировать.
text
Текст сообщения.
Ограничение.
Параметр обязателен для текстовых сообщений.
file
Ссылка на оригинальное изображение.
Ограничение.
Параметр обязателен для сообщений с изображением.
thumb
Ссылка на превью изображения.
Ограничение.
Параметр обязателен для сообщений с изображением.
* Обязательный параметр
Коды ответа
|
Код |
Причина |
Описание |
|
200 |
OK |
Успешный запрос. |
|
400 |
BAD_REQUEST |
Синтаксическая ошибка в запросе. |
|
500 |
INTERNAL SERVER ERROR |
Внутренняя ошибка сервера. |
Пример
Запрос:
curl -i -X POST 'https://api.example.com/?chat_id=fh5GkT67' \ -H 'Accept: application/json' \ -d { "sender" : { "id" : "a3bc21...", "name" : "ivanivanov", "photo" : "https://avatars.mds.yandex.net/.../1200x900n", "url" : "https://auto.ru/cars/.../1097255222-276b1ca9", "title" : "Mercedes-Benz E-Класс V (W213, S213, C238), 1670000 руб" }, "message": { "type": "text", "id": "2b17a38c...", "text": "Здравствуйте! Еще продается?" } }Ответ:
HTTP/1.1 200 OK Server: nginx Date: Mon, 14 Sep 2020 14:34:59 GMT Connection: keep-alive
* Обязательный параметр
Внешний идентификатор чата. Задается в личном кабинете дилера в поле ChatId при подключении приложения. Должен уникальным образом идентифицировать одного клиента Авто.ру, для которого выполняются запросы.