Ответ оператора
Позволяет передавать сообщение оператора из внешней системы пользователю Авто.ру.
Формат запроса
POST https://chat-api-ext.vertis.yandex.net/api/1.x/aggregators/auto/hook
? token=<string>
|
token* |
Внешний идентификатор чата. Задается в личном кабинете дилера в поле ChatId при подключении приложения. Должен уникальным образом идентифицировать одного клиента Авто.ру, для которого выполняются запросы. |
* Обязательный параметр
Формат тела запроса
{
"sender": {
"name": {string},
"photo": {string},
"email": {string}
},
"recipient": {
"id": {string}
},
"message" : {
"type": {string},
"id": {string},
"text": {string},
"file": {string}
}
}
|
sender* |
Информация об операторе. |
-
name*
Имя оператора.
photo
Ссылка на фотографию оператора.
email
Электронная почта оператора.
|
recipient* |
Информация о пользователе. |
-
id*
Идентификатор пользователя, полученный в запросе Сообщение пользователя (параметр sender.id).
|
message* |
Информация о сообщении. |
-
type*
Тип сообшения.
Допустимые значения:
photo— сообщение с изображением;text— текстовое сообщение;seen— событие о прочтении сообщения.
id*
Идентификатор сообщения.
Примечание
Параметр используется для обеспечения идемпотентности. Если запрос повторяется с тем же
message.id, его необходимо проигнорировать.
text
Текст сообщения.
Ограничение.
Параметр обязателен для текстовых сообщений.
file
сылка на оригинальное изображение.
Ограничение.
Параметр обязателен для сообщений с изображением.
* Обязательный параметр
Коды ответа
|
Код |
Причина |
Описание |
|
200 |
OK |
Успешный запрос. |
|
400 |
BAD_REQUEST |
Синтаксическая ошибка в запросе. |
|
500 |
INTERNAL SERVER ERROR |
Внутренняя ошибка сервера. |
Пример
Запрос:
curl -i -X POST 'https://chat-api-ext.vertis.yandex.net/api/1.x/aggregators/auto/hook?token=Vj72x3B9NT' \ -H 'Accept: application/json' \ -d { "sender": { "name": "Alex" }, "recipient": { "id": "a3bc21...", }, "message": { "type": "text", "id": "4568...", "text": "Здравствуйте! Да, продается." } }Ответ:
HTTP/1.1 200 OK Server: nginx Date: Mon, 14 Sep 2020 14:34:59 GMT Connection: keep-alive
Внешний идентификатор чата. Задается в личном кабинете дилера в поле ChatId при подключении приложения. Должен уникальным образом идентифицировать одного клиента Авто.ру, для которого выполняются запросы.
* Обязательный параметр