GET /chat/room/light

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

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

GET https://apiauto.ru/1.0/chat/room/light

? [only_unread=<boolean>]

only_unread

Признак. Добавлять в ответ только непрочитанные чаты.

Допустимые значения:
  • true — будут добавлены только непрочитанные чаты;
  • false — будут добавлены прочитанные и непрочитанные чаты

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

Заголовок

Описание

x-session-id

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

x-authorization

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

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

{
  "rooms": [
    {
      "id": {string},
      "created": {string},
      "updated": {string},
      "users": [
        {
          "id": {string},
          "blocked_room": {boolean},
          "average_reply_delay_minutes": {integer},
          "last_seen": {string},
          "description": {string},
          "room_last_read": {string}
        }
      ],
      "me": {string},
      "subject": {
        "offer": {
          "source": {
            "category": {string},
            "id": {string}
          },
          "value": {модель оффера}
        },
        "title": {string},
        "title_v2": {string},
        "image": {
          "additionalProp1": {string},
          "additionalProp2": {string},
          "additionalProp3": {string}
        }
      },
      "last_message": {
        "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}
}

rooms

Массив объектов, каждый из которых представляет чат-рум.

id

ID чат-рума

created

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

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

updated

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

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

users

Массив объектов, каждый из которых представляет участника чат-рума

id

Уникальный (искусственный) в рамках чат-рума идентификатор участника

blocked_room

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

true — заблокирован;
false — не заблокирован

average_reply_delay_minutes

Средняя задержка ответа пользователя за последние 60 дней

last_seen

Время последней активности пользователя (возвращается, если задан hint LAST_SEEN) в формате YYYY-MM-DD:HH-MM-SS.sss.Z.

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

description

string
Дополнительная информация о пользователе, которая может быть показана в интерфейсе чата. Например, статус или роль

room_last_read

Время, когда пользователь последний раз читал сообщения в этом чат-руме в формате YYYY-MM-DD:HH-MM-SS.sss.Z.

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

me

ID текущего пользователя (того, кто сделал запрос) в этом чат-руме

subject

Объект, представляющий тему обсуждения в чат-руме

offer

Данные объявления на Авто.ру. Модель предложения см. в разделе GET /feeds/history/{task_id} в массиве offers

title

Заголовок темы

title_v2

Альтернативный заголовок темы

image

Ообъект с разными размерами изображений, где ключ — строка с размерами, значение — URL. Например:

  • "1200x900": "//avatars.mds.yandex.net/get-autoru-all/1336268/techSupportAutoru/1200x900"
  • "180x135": "//avatars.mds.yandex.net/get-autoru-all/1336268/techSupportAutoru/180x135"
  • "248x186": "//avatars.mds.yandex.net/get-autoru-all/1336268/techSupportAutoru/248x186"
  • "small": "//vertis-frontend.s3.yandex.net/auto/frontend/chat-logo/icon-166x124.png"
  • "thumb_l": "//avatars.mds.yandex.net/get-autoru-all/1336268/techSupportAutoru/thumb_l"


last_message

last_message

Последнее сообщение в чат-руме

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

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

sizes

Объект с URL для разных размеров (ключи — строки с размерами)

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/room/light' \
 -H 'x-session: ...' \
 -H 'x-authorization: ...'

Ответ:

 {
   "rooms": [
   {
       "id": "8dd0aa64a684dec3b88047e4c1ca6a78",
       "created": "2019-02-25T11:49:34.883Z",
       "updated": "2025-08-20T14:35:23.337Z",
       "users": [
         {
           "id": "fb491ecdde6a556e",
           "room_last_read": "2025-08-20T14:40:18.320Z"
         },
         {
           "id": "tHFSUBR3HJjvFNpF16b7M_eK2NBuutJTLsoBzDB3b85EG1wtyv9X3A",
           "room_last_read": "2025-08-20T14:35:23.355Z"
         }
       ],
       "me": "tHFSUBR3HJjvFNpF16b7M_eK2NBuutJTLsoBzDB3b85EG1wtyv9X3A",
       "subject": {
         "title": "Чат с поддержкой",
        "image": {
          "1200x900": "//avatars.mds.yandex.net/get-autoru-all/1336268/techSupportAutoru/1200x900",
          "180x135": "//avatars.mds.yandex.net/get-autoru-all/1336268/techSupportAutoru/180x135",
          "248x186": "//avatars.mds.yandex.net/get-autoru-all/1336268/techSupportAutoru/248x186",
          "small": "//vertis-frontend.s3.yandex.net/auto/frontend/chat-logo/icon-166x124.png",
          "thumb_l": "//avatars.mds.yandex.net/get-autoru-all/1336268/techSupportAutoru/thumb_l",
          "thumb_l_2x": "//avatars.mds.yandex.net/get-autoru-all/1336268/techSupportAutoru/thumb_l_2x"
        },
        "title_v2": "Чат с поддержкой"
      },
      "last_message": {
        "id": "11f07dd2e3e894c0ab302f0b38f5b353",
        "room_id": "8dd0aa64a684dec3b88047e4c1ca6a78",
        "author": "fb491ecdde6a556e",
        "created": "2025-08-20T14:35:16.876Z",
        "payload": {
          "content_type": "TEXT_HTML",
          "value": "Привет! С вами бот 🤖 С чем нужна помощь?"
        },
      },
    },
    {
      "id": "8879709c92e3aa528c68b903687c0e0e",
      "created": "2024-10-15T13:33:58.040Z",
      "updated": "2025-08-20T14:33:00.477Z",
      "users": [
        {
          "id": "d18e891cd0d56f3e",
          "room_last_read": "2024-10-16T09:08:20.924Z"
        },
        {
          "id": "pddQI0dT6aybIi0SBV2wdPN0TUwq2Ca2gg0y3nUcEEZ_6O81WOo0Xg",
          "room_last_read": "2024-10-29T12:52:34.194Z"
        }
      ],
      "me": "pddQI0dT6aybIi0SBV2wdPN0TUwq2Ca2gg0y3nUcEEZ_6O81WOo0Xg",
      "subject": {
        "offer": {
          "source": {
            "category": "cars",
            "id": "1125455382-414bd07f"
          },
        },
        "title": "Чат",
        "title_v2": "Чат"
      },
      "last_message": {
        "id": "11ef8bca4402e5f0b8854ff40ed84c79",
        "room_id": "8879709c92e3aa528c68b903687c0e0e",
        "author": "d18e891cd0d56f3e",
        "created": "2024-10-16T14:23:51.247Z",
        "payload": {
          "content_type": "TEXT_PLAIN"
        },
        "attachments": [
          {
            "image": {
              "sizes": {
                "320x320": "//custodian-download.test.vertis.yandex-team.ru/download/ZBBT_0b6fyISK1pfToDy37ZCT25Q5UIZf9oG6vdWG4vzK1TDz4XbPd0kPZt3axgxkMU8x4EEfOqyn4qlJJBqWW3b2ElGsGXgblGbXvB4w7tavmlZNGDGYqtUd-vvJpyQhCN2CFflkfg/320x320",
                "460x460": "//custodian-download.test.vertis.yandex-team.ru/download/ZBBT_0b6fyISK1pfToDy37ZCT25Q5UIZf9oG6vdWG4vzK1TDz4XbPd0kPZt3axgxkMU8x4EEfOqyn4qlJJBqWW3b2ElGsGXgblGbXvB4w7tavmlZNGDGYqtUd-vvJpyQhCN2CFflkfg/460x460",
                "1200x1200": "//custodian-download.test.vertis.yandex-team.ru/download/ZBBT_0b6fyISK1pfToDy37ZCT25Q5UIZf9oG6vdWG4vzK1TDz4XbPd0kPZt3axgxkMU8x4EEfOqyn4qlJJBqWW3b2ElGsGXgblGbXvB4w7tavmlZNGDGYqtUd-vvJpyQhCN2CFflkfg/1200x1200"
              }
            }
          }
        ],
      },
    },
    {
      "id": "d7bf06f7c895a30403cb6732d61ecdc8",
      "created": "2025-06-20T23:02:13.034Z",
      "updated": "2025-07-18T14:56:29.523Z",
      "users": [
        {
          "id": "Btl1Z7Bm0jtPoJSQvkmoxUulXrL0cUQczsM2FarmYay7fv4k1bk1gQ",
          "room_last_read": "2025-07-18T14:56:29.525Z"
        },
        {
          "id": "MtOslS-_yRyQ4IniT8iczUKZlKPQ7EUnvTguP7MjY-u_S4soqCyFK4vKNj0whsWP",
        }
      ],
      "me": "Btl1Z7Bm0jtPoJSQvkmoxUulXrL0cUQczsM2FarmYay7fv4k1bk1gQ",
      "subject": {
        "offer": {
          "source": {
            "category": "cars",
            "id": "1128547367-53ec285d"
          },
        },
        "title": "Чат",
        "title_v2": "Чат"
      },
      "last_message": {
        "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"
}

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

  • true — будут добавлены только непрочитанные чаты;
  • false — будут добавлены прочитанные и непрочитанные чаты.
Предыдущая
Дополнительные возможности
Следующая
GET /chat/room/by-id