GET /chat/message

Метод позволяет получить сообщения чат-рума.

Формат запроса

GET https://apiauto.ru/1.0/chat/message/

? room_id=<string>
& from=<string> 
& [count=<integer>]
& [asc=<boolean>]

room_id*

ID чат-рума

from

ID сообщения, начиная с которого нужно возвращать сообщения в ответе

count

Количество сообщений

asc

Возвращать сообщения по возрастанию или по убыванию номера идентификатора

* Обязательный параметр

Заголовки запроса

Заголовок

Описание

x-session-id

Идентификатор сессии пользователя. Значение можно получить с помощью операции POST /auth/login

x-authorization

Авторизационный токен. См. подробнее Доступ к API

Формат ответа

 {
  "messages": [
    {
      "id": {string},
      "room_id": {string},
      "author": {string},
      "created": {string},
      "payload": {
        "content_type": {string},
        "value": {string}
      },
      "attachments": [
        {
          "image": {
            "sizes": {
              "additionalProp1": {string},
              "additionalProp2": {string},
              "additionalProp3": {string}
            }
          },
        }
      ],
      "me": {boolean},
    }
  ],
  "error": {string},
  "status": {string},
  "detailed_error": {string}
}

messages

Список сообщений


id

Уникальный идентификатор сообщения


room_id

Уникальный идентификатор чат-рума


author

Уникальный идентификатор автора сообщения


created

Время создания чат-рума в формате YYYY-MM-DD:HH-MM-SS.sss.Z.

Составные части формата:
  • YYYY-MM-DD — дата (год, месяц, день);
  • HH-MM-SS — время (часы, минуты, секунды);
  • .sss — миллисекунды;
  • Z — указание на временную зону (UTC).

payload

Содержимое сообщения


content_type

Тип данных в сообщении. Возможные варианты: TEXT_PLAIN, TEXT_HTML


value

Текст сообщения


attachments

Массив вложений


image

Информация об изображении


me

Последнее сообщение написано текущим пользователем (тем, кто сделал запрос). Допустимые значения:

true — да;
false — нет


error

Описание ошибки, если она есть


status

Статус выполнения запроса. Возможные значения: SUCCESS, ERROR


detailed_error

Детальное описание ошибки, если она есть


Коды ответа

Код

Причина

Описание

200

OK

Успешный запрос.

400

BAD_REQUEST

Синтаксическая ошибка в запросе.

401

NO_AUTH

Не удалось авторизовать пользователя по переданным данным.

500

INTERNAL SERVER ERROR

Внутренняя ошибка сервера.

Пример

Запрос:

curl -X 'GET' \
 'https://apiauto.ru/1.0/chat/message?room_id=d7bf06f7c895a30403cb6732d61ecdc8&count=100&asc=true' \
 -H 'accept: application/json'\
 -H 'x-session: ...' \
 -H 'x-authorization: ...' 

Ответ:

{
  "messages": [
    {
      "id": "11f04e2a9a42fe00a95b6bf174b85f15",
      "room_id": "d7bf06f7c895a30403cb6732d61ecdc8",
      "author": "O5zY3TPD_4iQ4IniT8iczUKZlKPQ7EUnvTguP7MjY-u_S4soqCyFK4vKNj0whsWP",
      "created": "2025-06-20T23:02:13.216Z",
      "payload": {
        "content_type": "TEXT_HTML",
        "value": "\nНе упустите это предложение — напишите или позвоните продавцу сегодня!<br>\nА мы подарим вам Отчёт Авто.ру, чтобы было легче принять решение о покупке.<br>\n<a href=\"https://auto.ru/promo/free-report-rules/\">Как получить отчёт</a>\n"
      },
    },
    {
      "id": "11f04e2b0cbabbd0ab841f2854e64edd",
      "room_id": "d7bf06f7c895a30403cb6732d61ecdc8",
      "author": "O5zY3TPD_4iQ4IniT8iczUKZlKPQ7EUnvTguP7MjY-u_S4soqCyFK4vKNj0whsWP",
      "created": "2025-06-20T23:05:25.261Z",
      "payload": {
        "content_type": "TEXT_HTML",
        "value": "\nНе упустите это предложение — напишите или позвоните продавцу сегодня!<br>\nА мы подарим вам Отчёт Авто.ру, чтобы было легче принять решение о покупке.<br>\n<a href=\"https://auto.ru/promo/free-report-rules/\">Как получить отчёт</a>\n"
      },
    },
    {
      "id": "11f060d561c0a100ac686bc64ab9f84e",
      "room_id": "d7bf06f7c895a30403cb6732d61ecdc8",
      "author": "O5zY3TPD_4iQ4IniT8iczUKZlKPQ7EUnvTguP7MjY-u_S4soqCyFK4vKNj0whsWP",
      "created": "2025-07-14T17:10:03.280Z",
      "payload": {
        "content_type": "TEXT_HTML",
        "value": "<b style=\"font-weight: 500; margin-bottom: 2px; display: block;\">Поздравляем с покупкой!</b><div>Машина уже в Гараже. А вместе с ней — чек-лист, чтобы не забыть важное при покупке. Заходите в Гараж почаще: сможете хранить историю обслуживания и получать напоминания о ТО.</div><a href=\"http://ya.ru\" style=\"margin-top: 12px; display: inline-block;\">Ссылка на Чек-лист</a>"
      },
    },
    {
      "id": "11f060d5c99151d0a9f40d9806816e8c",
      "room_id": "d7bf06f7c895a30403cb6732d61ecdc8",
      "author": "O5zY3TPD_4iQ4IniT8iczUKZlKPQ7EUnvTguP7MjY-u_S4soqCyFK4vKNj0whsWP",
      "created": "2025-07-14T17:12:57.453Z",
      "payload": {
        "content_type": "TEXT_HTML",
        "value": "<div style=\"margin-bottom: 8px;\">Вы недавно контактировали с продавцом <a data-action=\"open_reseller_offer\" href=\"http://ya.ru\">[марка-модель-цена]</a>. Как всё прошло? 🚗</div><div>Пожалуйста, расскажите, чем закончилось ваше общение, и поставьте оценку. Ваш отзыв повлияет на рейтинг продавца и поможет другим покупателям сделать правильный выбор!</div><a style=\"display: inline-flex; margin-top: 12px; border-radius: 8px; background: black; padding: 0 16px; height: 32px; text-decoration: none; color: white; font-weight: 500; font-size: 13px; line-height: 16px; align-items: center;\" data-action=\"open_feedback_on_reseller_for\" href=\"http://ya.ru\">Поставить оценку</a>"
      },
    }
  ],
  "status": "SUCCESS"
} 

* Обязательный параметр

ID чат-рума.

ID сообщения, начиная с которого нужно возвращать сообщения в ответе.

Количество сообщений.

Признак. Возвращать сообщения по возрастанию или по убыванию номера идентификатора. Допустимые значения:

  • true — по-возрастанию;
  • false — по убыванию.
Предыдущая
Следующая