`.\n\n### Дата и время\nДанные могут быть переданы в одном из форматов:
\n- без явного указания таймзоны - для времени (date-time): 2020-07-18T04:52:33.051204 и для даты (date): 2020-07-18. В данных запросах дата и время передаются в таймозонеEurope/Moscow
\n- с явно указанной таймзоной в ответе: 2020-07-18T04:52:33.051204+00:00
\n\n\nВо всех запросах дата и время передаются и возвращаются в таймзоне `Europe/Moscow`.\n\n### Список значений\nДля передачи в параметрах запроса списка значений нужно передавать элементы списка по отдельности: `?offersIds=196032948&offersIds=196032949`\n\n\n### Ограничения\n\nЧтобы данные передавались стабильно, без задержек и блокировок, рекомендуем:\n- отправлять не более 10 запросов в секунду на каждый конкретный метод*;
\n- выполнять запросы равномерно.
\n\n* Для некоторых методов эти значения могут меняться в зависимости от количества передаваемого контента.
\n\n
\n\n### История изменений\n - `2026-08-26` Добавили метод [расчёта актуальных тарифов](#tag/tariffs/paths/~1v1~1calculate-tariffs~1/post) размещения и продвижения.\n - `2026-04-10` Добавили методы для [загрузки](#tag/chats/paths/~1v1~1upload-file/post) и [отправки файлов](#tag/chats/paths/~1v1~1send-message-with-files~1/post) в чаты.\n - `2025-05-22` Добавили методы для работы с [рассылками предложений](#tag/proposals).\n - `2023-08-04` Добавили возможность подписаться на системные [сообщения](#tag/chats) от Циан.\n - `2022-11-10` Добавили методы для работы с [сообщениями](#tag/chats).\n - `2021-06-08` Добавили версию v2 АПИ [Получить объявления](#tag/offers/paths/~1v2~1get-my-offers/get) с поддержкой пагинации. Версия v1 АПИ помечена как deprecated.\n - `2021-05-12` Поправили часовой пояс в ответе запроса [Получить отчет по звонкам](#tag/calls/paths/~1v1~1get-calls-report/get). Теперь возвращается `Europe/Moscow`\n - `2021-02-11` Теперь у нас есть история изменений! Добавили поле `datetime` c датой и временем звонка в ответ запроса [Получить отчет по звонкам](#tag/calls/paths/~1v1~1get-calls-report/get)"},"tags":[{"name":"auction","x-displayName":"Аукцион","description":"Общие методы API для работы с аукционом"},{"name":"billing","x-displayName":"Биллинг","description":"Общие методы API для работы с биллингом"},{"name":"calls","x-displayName":"Звонки","description":"Общие методы API для работы со звонками"},{"name":"moderation","x-displayName":"Модерация","description":"Общие методы API для работы с модерацией"},{"name":"offers","x-displayName":"Объявления","description":"Общие методы API для работы с объявлениями"},{"name":"importOrders","x-displayName":"Отчеты по импорту объявлений","description":"Общие методы API для работы с отчетами по импорту объявлений"},{"name":"estimation","x-displayName":"Оценка недвижимости","description":"Общие методы API для оценки недвижимости"},{"name":"proposals","x-displayName":"Рассылки предложений","description":"Общие методы API для работы с рассылками предложений"},{"name":"chats","x-displayName":"Сообщения","description":"Общие методы API для работы с сообщениями
\n\nВажно! \n При работе с сообщениями дата и время передается с явно указанной таймзоной в ответе: 2020-07-18T04:52:33.051204+00:00
"},{"name":"agents","x-displayName":"Сотрудники","description":"Общие методы API для работы с сотрудниками"},{"name":"statistics","x-displayName":"Статистика по объявлениям","description":"Общие методы API для работы со статистикой по объявлениям"},{"name":"tariffs","x-displayName":"Тарифы","description":"Методы API для расчёта актуальных тарифов размещения и продвижения"},{"name":"notifications","x-displayName":"Уведомления","description":"Общие методы API для работы с уведомлениями"}],"paths":{"/v1/get-my-balance":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BalanceModelSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[],"tags":["billing"],"summary":"Получить текущий баланс","description":"Метод API позволяет получить текущий баланс пользователя, количество бонусов, количество баллов, которые можно потратить на аукцион."}},"/v1/get-auction":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetOffersAuctionInfoResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"offerIds","required":true,"description":"Ids объявлений","schema":{"title":"offer_ids","type":"array","items":{"title":"offer_ids","type":"integer","format":"int64"}}}],"tags":["auction"],"summary":"Получить информацию по ставкам на объявления","description":"Метод позволяет получить информацию по примененным к объявлению ставкам."}},"/v1/get-auction-predictions":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetOffersPredictionsResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetOffersPredictionsRequestSchema"}}}},"tags":["auction"],"summary":"Получить информацию по прогнозам показов по объявлениям","description":"Метод позволяет получить информацию по прогнозам показов для переданных объявлений."}},"/v1/get-cpc-promotion-competitions/":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCpcPromotionCompetitionsResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCpcPromotionCompetitionsRequestSchema"}}}},"tags":["auction"],"summary":"Получить информацию о срс-продвижении","description":"Метод API позволяет получить сводку по CPC-продвижению для объявлений агентства: конкуренцию, признак примененного продвижения, остаток дневного лимита и статистику платных просмотров за текущие сутки.\n\nЗапрос выполняется в одном из двух режимов:\n- по списку `announcementIds`;\n- по объявлениям пользователя через `userId` с пагинацией `page` и `pageSize`, если список `announcementIds` не передан или пуст.\n\nВ ответе возвращаются массив `announcements`, общее число найденных объявлений `totalCount` и флаг `nextPage`. Для каждого объявления отдаются агрегированные поля конкуренции, `isPromotionApplied`, `paidViewsCount` и `amountSpent`.\n\nОсобенности для клиентов:\n- в режиме списка чужие и несуществующие `announcementIds` пропускаются;\n- `isPromotionApplied` учитывает только активную CPC-ставку;\n- в конкуренции учитываются объявления с активной ставкой и ставкой в статусе `LimitExceeded`;\n- `paidViewsCount` и `amountSpent` считаются только за текущий день;\n- поля текущей ставки и статуса ставки отдельно не возвращаются."}},"/v1/get-cpc-promotion-parameters/":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCpcPromotionParametersResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"tags":["auction"],"summary":"Получить информацию о параметрах срс-ставок в кластерах","description":"Метод API позволяет получить справочные параметры CPC-продвижения, которые нужны клиенту для работы с настройками ставок.\n\nВ ответе возвращается плоский массив `configurations` со строковыми идентификаторами доступных конфигураций CPC-продвижения.\n\nОсобенности для клиентов:\n- ответ предназначен как справочник параметров, а не как расчет по конкретному объявлению;"}},"/v1/get-offer-active-services":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActualAppliedServicesApiResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"offerIds","required":true,"description":"Список объявлений","schema":{"title":"offer_ids","type":"array","items":{"title":"offer_ids","type":"integer","format":"int64"}}}],"tags":["billing"],"summary":"Получить активные услуги по объявлениям","description":"Метод API позволяет получить активные на текущую дату услуги, примененные к выбранному объявлению или нескольким объявлениям агентства.\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/get-offer-active-services?offerIds=214937422&offerIds=218965501"}},"/v1/get-operations":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationsByUserListResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"employeeId","required":false,"description":"Id сотрудника для получения событий по нему. Если не передан - вернёт операции для мастер-аккаунта.","schema":{"title":"employee_id","type":"integer","format":"int64"}},{"in":"query","name":"from","required":true,"description":"Начало периода","schema":{"title":"from_","type":"string","format":"date-time"}},{"in":"query","name":"operationType","required":true,"description":"Тип операций для поиска","schema":{"enum":["all","balance","deposit","withdrawal"],"type":"string","x-withdrawal":"Списания","x-deposit":"Пополения","x-balance":"Состояние счета","x-all":"Все операции","description":"\n\t\n `withdrawal`: Списания\t\n `deposit`: Пополения\t\n `balance`: Состояние счета\t\n `all`: Все операции"}},{"in":"query","name":"page","required":true,"description":"Номер страницы (начиная с 1).","schema":{"title":"page","type":"integer","format":"int64"}},{"in":"query","name":"pageSize","required":true,"description":"Размер страницы (начиная с 1).","schema":{"title":"page_size","type":"integer","format":"int64"}},{"in":"query","name":"paymentType","required":false,"description":"Тип списаний для поиска","schema":{"enum":["all","bonus","money","points"],"type":"string","x-money":"За деньги","x-points":"За баллы","x-all":"Все","x-bonus":"Бонусами на продвижение","description":"\n\t\n `money`: За деньги\t\n `points`: За баллы\t\n `all`: Все\t\n `bonus`: Бонусами на продвижение"}},{"in":"query","name":"to","required":true,"description":"Конец периода","schema":{"title":"to","type":"string","format":"date-time"}}],"tags":["billing"],"summary":"Получить список операций","description":"Метод API позволяет получить биллинговые операции (списание, пополнение, срез по балансу) для каждого из сотрудников мастер-аккаунта."}},"/v1/get-agents":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentsListResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"page","required":true,"description":"Номер запрашиваемой страницы.","schema":{"title":"page","type":"integer","format":"int64"}},{"in":"query","name":"pageSize","required":true,"description":"Размер страницы.","schema":{"title":"page_size","type":"integer","format":"int64"}},{"in":"query","name":"query","required":false,"description":"Поисковый запрос","schema":{"title":"query","type":"string"}},{"in":"query","name":"statuses","required":false,"description":"Статусы","schema":{"title":"statuses","type":"array","items":{"enum":["active","blocked","deleted","deletedAndHidden","processing","request"],"type":"string","x-request":"Отправлена заявка на добавление агента к агентству","x-active":"Активный агент","x-processing":"Агент в процессе активации/блокировки","x-blocked":"Заблокированный агент","x-deleted":"Удаленный агент","x-deletedAndHidden":"Удаленный агент","description":"\n\t\n `request`: Отправлена заявка на добавление агента к агентству\t\n `active`: Активный агент\t\n `processing`: Агент в процессе активации/блокировки\t\n `blocked`: Заблокированный агент\t\n `deleted`: Удаленный агент\t\n `deletedAndHidden`: Удаленный агент"},"description":"\n\t\n `request`: Отправлена заявка на добавление агента к агентству\t\n `active`: Активный агент\t\n `processing`: Агент в процессе активации/блокировки\t\n `blocked`: Заблокированный агент\t\n `deleted`: Удаленный агент\t\n `deletedAndHidden`: Удаленный агент"}},{"in":"query","name":"userIds","required":false,"description":"Список сотрудников, которых нужно вернуть в ответе. Если не задан - вернуть информацию по всем сотрудникам.","schema":{"title":"user_ids","type":"array","items":{"title":"user_ids","type":"integer","format":"int64"}}}],"tags":["agents"],"summary":"Получить список сотрудников","description":"Метод API позволяет получить список сотрудников агентства, зная идентификатор мастер-аккаунта агентства."}},"/v1/get-my-offers":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementInfoResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"source","required":false,"description":"Источник объявления","schema":{"enum":["manual","upload"],"type":"string","x-manual":"Ручное","x-upload":"Импорт","description":"\n\t\n `manual`: Ручное\t\n `upload`: Импорт"}},{"in":"query","name":"statuses","required":false,"description":"Статусы","schema":{"title":"statuses","type":"array","items":{"enum":["inactive","published","refusedByModerator","removedByModerator"],"type":"string","x-published":"Опубликован","x-inactive":"Неактивен","x-refusedByModerator":"Отклонен модератором","x-removedByModerator":"Удален модератором","description":"\n\t\n `published`: Опубликован\t\n `inactive`: Неактивен\t\n `refusedByModerator`: Отклонен модератором\t\n `removedByModerator`: Удален модератором"},"description":"\n\t\n `published`: Опубликован\t\n `inactive`: Неактивен\t\n `refusedByModerator`: Отклонен модератором\t\n `removedByModerator`: Удален модератором"}},{"in":"query","name":"usersIds","required":false,"description":"Список пользователей (сабов)","schema":{"title":"users_ids","type":"array","items":{"title":"users_ids","type":"integer","format":"int64"}}}],"tags":["offers"],"summary":"Получить объявления","description":"\nС помощью метода можно получить объявления по агентству, отфильтровав объявления по статусу, источнику и списку сотрудников.\n\nПредположим, агентству нужно получить все свои объявления: уже снятые с публикации и опубликованные на текущий момент. При этом необходимо видеть только те объявления, которые были созданы агентом вручную, а не загружены через XML-фид. Объявления должны быть отфильтрованы по id агента, который опубликовал их.\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/get-my-offers?source=manual&statuses=inactive&statuses=published\n\nВозможно получить только те объявления, которые были созданы определенными агентами (id 106815 и 106816). Для этого в параметры запроса нужно передать еще поле usersIds c идентификаторами сотрудников.\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/get-my-offers?source=manual&statuses=inactive&statuses=published&usersIds=106815&usersIds=106816\n\nПараметры не являются обязательными для заполнения. В случае отправки пустого запроса в ответе будут указаны все когда-либо существовавшие объявления агентства.","deprecated":"true"}},"/v2/get-my-offers":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnnouncementInfoV2ResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"page","required":true,"description":"Номер страницы выдачи","schema":{"title":"page","type":"integer","format":"int64"}},{"in":"query","name":"pageSize","required":true,"description":"Размер страницы выдачи","schema":{"title":"page_size","type":"integer","format":"int64"}},{"in":"query","name":"source","required":false,"description":"Источник объявления","schema":{"enum":["manual","upload"],"type":"string","x-manual":"Ручное","x-upload":"Импорт","description":"\n\t\n `manual`: Ручное\t\n `upload`: Импорт"}},{"in":"query","name":"statuses","required":false,"description":"Статусы","schema":{"title":"statuses","type":"array","items":{"enum":["inactive","published","refusedByModerator","removedByModerator"],"type":"string","x-published":"Опубликован","x-inactive":"Неактивен","x-refusedByModerator":"Отклонен модератором","x-removedByModerator":"Удален модератором","description":"\n\t\n `published`: Опубликован\t\n `inactive`: Неактивен\t\n `refusedByModerator`: Отклонен модератором\t\n `removedByModerator`: Удален модератором"},"description":"\n\t\n `published`: Опубликован\t\n `inactive`: Неактивен\t\n `refusedByModerator`: Отклонен модератором\t\n `removedByModerator`: Удален модератором"}},{"in":"query","name":"usersIds","required":false,"description":"Список пользователей (сабов)","schema":{"title":"users_ids","type":"array","items":{"title":"users_ids","type":"integer","format":"int64"}}}],"tags":["offers"],"summary":"Получить объявления","description":"С помощью метода можно получить объявления по агентству, отфильтровав объявления по статусу, источнику и списку сотрудников.\n\nПредположим, агентству нужно получить все свои объявления: уже снятые с публикации и опубликованные на текущий момент. При этом необходимо видеть только те объявления, которые были созданы агентом вручную, а не загружены через XML-фид. Объявления должны быть отфильтрованы по id агента, который опубликовал их.\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v2/get-my-offers?source=manual&statuses=inactive&statuses=published&page=1&pageSize=10\n\nВозможно получить только те объявления, которые были созданы определенными агентами (id 106815 и 106816). Для этого в параметры запроса нужно передать еще поле usersIds c идентификаторами сотрудников.\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v2/get-my-offers?source=manual&statuses=inactive&statuses=published&usersIds=106815&usersIds=106816&page=1&pageSize=10\n\nВсе параметры, кроме `page` и `pageSize`, не являются обязательными для заполнения."}},"/v1/get-my-offers-detail":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetOffersInfoByIdsResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"offerIds","required":true,"description":"Список id объявлений","schema":{"title":"offer_ids","type":"array","items":{"title":"offer_ids","type":"integer","format":"int64"}}}],"tags":["offers"],"summary":"Получить информацию об объявлениях","description":"\nС помощью метода можно получить детальную информацию по объявлениям агентства."}},"/v1/get-last-order-info":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LastOrderReportInfoResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[],"tags":["importOrders"],"summary":"Получить состояние импорта объявлений","description":"Метод позволяет получить состояние последнего актуального отчета по импорту объявлений и возвращает информацию об отчете: URL XML-фида, дату проверки фида, наличие или отсутствие проблем с объявлениями и фотографиями в объявлении, номер заказа (номер выгрузки) фида, дату последней обработки фида."}},"/v1/get-order":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnloadReportResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[],"tags":["importOrders"],"summary":"Получить отчет по импорту объявлений","description":"Метод позволяет получить последний актуальный отчет по импорту объявлений и возвращает информацию об отчете: URL XML-фида, дату проверки фида, наличие или отсутствие проблем с объявлениями и фотографиями в объявлении, номер заказа (номер выгрузки) фида, дату последней обработки фида."}},"/v1/get-images-report":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageReportResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"page","required":true,"description":"Номер страницы (должен начинаться с 1)","schema":{"title":"page","type":"integer","format":"int64"}},{"in":"query","name":"pageSize","required":true,"description":"Размер страницы (от 1 до 500)","schema":{"title":"page_size","type":"integer","format":"int64"}}],"tags":["importOrders"],"summary":"Получить отчет об изображениях","description":"Метод позволяет получить последний актуальный отчет об изображениях объявлений в XML-фиде."}},"/v1/get-views-statistics-by-days":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetOfferStatisticsByDaysResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"dateFrom","required":true,"description":"Дата с которой искать","schema":{"title":"date_from","type":"string","format":"date"}},{"in":"query","name":"dateTo","required":true,"description":"Дата до которой искать","schema":{"title":"date_to","type":"string","format":"date"}},{"in":"query","name":"offerId","required":true,"description":"ID объявления","schema":{"title":"offer_id","type":"integer","format":"int64"}}],"tags":["statistics"],"summary":"Получить статистику объявления по дням","description":"Метод возвращает статистику вашего объявления за указанный период по дням.\n\nОграничения на диапазон дат в этом методе.\n- Дата начала периода должна быть строго больше даты конца периода.\n- Возможно запрашивать диапазон не более 180 дней.\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/get-views-statistics-by-days?offerId=196032948&dateFrom=2020-06-01&dateTo=2020-06-15"}},"/v1/get-views-statistics":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetOffersStatisticsResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"offersIds","required":true,"description":"Список ID объявлений","schema":{"title":"offers_ids","type":"array","items":{"title":"offers_ids","type":"integer","format":"int64"}}}],"tags":["statistics"],"summary":"Получить статистику объявлений за все время","description":"Метод возвращает статистику ваших объявлений за все время.\n\nМаксимально допустимое количество id объявлений – 50.\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/get-views-statistics?offersIds=196032948&offersIds=196032949"}},"/v1/get-calls-report":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallsReportForAgencyResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"dateFrom","required":false,"description":"Дата начала периода (включительно)","schema":{"title":"date_from","type":"string","format":"date"}},{"in":"query","name":"dateTo","required":false,"description":"Дата конца периода (включительно)","schema":{"title":"date_to","type":"string","format":"date"}},{"in":"query","name":"employeeId","required":false,"description":"ID сотрудника","schema":{"title":"employee_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic"}},{"in":"query","name":"page","required":true,"description":"Номер страницы","schema":{"title":"page","type":"integer","format":"int64"}},{"in":"query","name":"pageSize","required":true,"description":"Размер страницы","schema":{"title":"page_size","type":"integer","format":"int64"}}],"tags":["calls"],"summary":"Получить отчет по звонкам","description":"Получить отчет по звонкам с фильтрацией по датам и ID сотрудника","deprecated":"true"}},"/v2/get-calls-report":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCallsReportForAgencyResponseV2SchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"dateFrom","required":false,"description":"Дата начала периода (включительно)","schema":{"title":"date_from","type":"string","format":"date"}},{"in":"query","name":"dateTo","required":false,"description":"Дата конца периода (включительно)","schema":{"title":"date_to","type":"string","format":"date"}},{"in":"query","name":"employeeId","required":false,"description":"ID сотрудника","schema":{"title":"employee_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic"}},{"in":"query","name":"page","required":true,"description":"Номер страницы","schema":{"title":"page","type":"integer","format":"int64"}},{"in":"query","name":"pageSize","required":true,"description":"Размер страницы","schema":{"title":"page_size","type":"integer","format":"int64"}}],"tags":["calls"],"summary":"Получить отчет по звонкам","description":"Метод позволяет получить отчёт по звонкам с фильтрацией по датам и ID сотрудника, с привязкой к конкретным объявлениям. \nПривязку звонков к объявлениям можно будет получать только с даты подключения метода, по старым звонкам получить привязку не получится. \n\nКак будут передаваться данные по объявлениям:\n\n- Id — если получилось определить, по какому объявлению был звонок;\n- externalId — для всех новых звонков, если его поменять — у старых звонков по объекту останется прежний ID;\n- url — только пока объявление опубликовано."}},"/v1/get-call-record":{"get":{"responses":{"200":{"content":{"audio/mpeg":{"examples":{"response":{"value":"Запись звонка (бинарные данные)"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"callId","required":true,"description":"ID звонка","schema":{"title":"call_id","type":"integer","format":"int64"}}],"tags":["calls"],"summary":"Получить запись звонка","description":"Получить запись звонка по `callId`. В ответе будет файл в формате `audio/mpeg`."}},"/v1/get-complaints":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetModerationComplaintResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"dateFrom","required":false,"description":"Дата с которой искать","schema":{"title":"date_from","type":"string","format":"date-time"}},{"in":"query","name":"dateTo","required":false,"description":"Дата до которой искать","schema":{"title":"date_to","type":"string","format":"date-time"}},{"in":"query","name":"page","required":true,"description":"Номер страницы","schema":{"title":"page","type":"integer","format":"int64"}},{"in":"query","name":"pageSize","required":true,"description":"Размер страницы","schema":{"title":"page_size","type":"integer","format":"int64"}}],"tags":["moderation"],"summary":"Получить жалобы","description":"Метод API позволяет получить жалобы на объявления."}},"/v1/get-stale-offers":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNotActualAnnouncementsByMasterUserIdResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[],"tags":["moderation"],"summary":"Получить подозрения на неактуальность объявлений","description":"Метод отдаёт список ID объявлений, заподозренных в неактуальности, даты их автоматического снятия с публикации и ID проверок на неактуальность."}},"/v1/confirm-offer-staleness-suspicion":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseSchema"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"guid","required":true,"description":"Идентификатор проверки на актуальность.\n Технический идентификатор записи, человека не идентифицирует — ПДн не является.","schema":{"title":"guid","type":"string","format":"uuid"}}],"tags":["moderation"],"summary":"Подтвердить подозрение на неактуальность объявления","description":"Метод принимает ID проверки на неактуальность. Если объявление с сайта, оно переместится в архив. Если объявление из выгрузок, оно отправится в черновик.\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/confirm-offer-staleness-suspicion?guid=8c88a97c-ed5d-4958-a762-7741d51b3f7b"}},"/v1/reject-offer-staleness-suspicion":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseSchema"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"guid","required":true,"description":"Идентификатор проверки на актуальность.\n Технический идентификатор записи, человека не идентифицирует — ПДн не является.","schema":{"title":"guid","type":"string","format":"uuid"}}],"tags":["moderation"],"summary":"Отклонить подозрение на неактуальность объявления","description":"Метод принимает ID проверки на неактуальность и возвращает объявлению статус актуального.\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/reject-offer-staleness-suspicion?guid=8c88a97c-ed5d-4958-a762-7741d51b3f7b"}},"/v1/get-notifications":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserNotificationsApiResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"dateFrom","required":false,"description":"Дата с которой искать сообщения","schema":{"title":"date_from","type":"string","format":"date-time"}},{"in":"query","name":"dateTo","required":false,"description":"Дата по которую искать сообщения","schema":{"title":"date_to","type":"string","format":"date-time"}},{"in":"query","name":"employeeId","required":false,"description":"id пользователя сотрудника агентства","schema":{"title":"employee_id","type":"integer","format":"int64"}},{"in":"query","name":"page","required":true,"description":"Номер страницы","schema":{"title":"page","type":"integer","format":"int64"}},{"in":"query","name":"pageSize","required":true,"description":"Размер страницы","schema":{"title":"page_size","type":"integer","format":"int64"}}],"tags":["notifications"],"summary":"Получить уведомления","description":"Метод API позволяет посмотреть уведомления, полученные агентством.\n\nВ присылаемых пользователю уведомлениях может быть информация о пополнении счета, активации тарифа, предупреждения о санкциях, информация от службы качества, и др.\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/get-notifications?page=1&dateFrom=2020-09-21T14:15:46.743046Z&dateTo=2020-10-05T15:47:46.743046Z&employeeId=123456&pageSize=100"}},"/v1/get-moderation-notifications":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserNotificationsApiResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"dateFrom","required":false,"description":"Дата с которой искать сообщения","schema":{"title":"date_from","type":"string","format":"date-time"}},{"in":"query","name":"dateTo","required":false,"description":"Дата по которую искать сообщения","schema":{"title":"date_to","type":"string","format":"date-time"}},{"in":"query","name":"employeeId","required":false,"description":"id пользователя сотрудника агентства","schema":{"title":"employee_id","type":"integer","format":"int64"}},{"in":"query","name":"page","required":true,"description":"Номер страницы","schema":{"title":"page","type":"integer","format":"int64"}},{"in":"query","name":"pageSize","required":true,"description":"Размер страницы","schema":{"title":"page_size","type":"integer","format":"int64"}}],"tags":["notifications"],"summary":"Получить уведомления от модерации","description":"Метод API позволяет посмотреть модерационные уведомления, полученные агентством.\n\nВ присылаемых пользователю уведомлениях может быть информация о санкциях, информация от службы качества и др.\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/get-moderation-notifications?page=1&dateFrom=2020-09-21T14:15:46.743046Z&dateTo=2020-10-05T15:47:46.743046Z&userId=123456&pageSize=100"}},"/v1/get-moderation-unread-count":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserUnreadNotificationsCountResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"employeeId","required":false,"description":"Id пользователя сотрудника агентства","schema":{"title":"employee_id","type":"integer","format":"int64"}}],"tags":["notifications"],"summary":"Получить число непрочитанных уведомлений от модерации","description":"Метод API позволяет посмотреть модерационные уведомления, полученные агентством.\n\nВ присылаемых пользователю уведомлениях может быть информация о санкциях, информация от службы качества и др.\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/get-moderation-notifications?page=1&dateFrom=2020-09-21T14:15:46.743046Z&dateTo=2020-10-05T15:47:46.743046Z&userId=123456&pageSize=100"}},"/v1/mark-all-notifications-as-read":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseSchema"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarkAllNotificationsAsReadRequestV2Schema"}}}},"tags":["notifications"],"summary":"Пометить все уведомления как прочитанные","description":"Метод API отмечает все имеющиеся уведомления как прочитанные.\n\nПример:\n\n curl -X POST -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/mark-all-notifications-as-read/ --header 'Content-Type: application/json' --data-raw '{\"userId\": 123456, \"employeeId\": 123456}'"}},"/v1/get-estimation-and-bti":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEstimationAndBtiResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"address","required":true,"description":"Адрес","schema":{"title":"address","type":"string","x-sensitiveData":"pdnClient"}},{"in":"query","name":"fiasHouseId","required":false,"description":"ФИАС id дома","schema":{"title":"fias_house_id","type":"string"}},{"in":"query","name":"floorType","required":false,"description":"Тип этажа","schema":{"enum":["last","one","other","two"],"type":"string","x-one":"1 этаж","x-two":"2 этаж","x-last":"Последний этаж","x-other":"Другой этаж","description":"\n\t\n `one`: 1 этаж\t\n `two`: 2 этаж\t\n `last`: Последний этаж\t\n `other`: Другой этаж"}},{"in":"query","name":"repairType","required":false,"description":"Тип ремонта","schema":{"enum":["cosmetic","design","euro","no"],"type":"string","x-cosmetic":"Косметический","x-design":"Дизайнерский","x-euro":"Евроремонт","x-no":"Без ремонта","description":"\n\t\n `cosmetic`: Косметический\t\n `design`: Дизайнерский\t\n `euro`: Евроремонт\t\n `no`: Без ремонта"}}],"tags":["estimation"],"summary":"Получить оценку по адресу","description":"Метод API позволяет получить оценку м² в многоэтажном доме и данные БТИ по адресу.\n\nДоступ к методу платный. Для получения доступа, напишите на b2bdatasales@cian.ru"}},"/v3/subscribe-webhooks":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3SubscribeWebhooksResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3SubscribeWebhooksRequestSchema"}}}},"tags":["chats"],"summary":"Зарегистрировать получателя вебхуков (v3)","description":"С помощью метода можно подключить отправку вебхуков на переданный URL. \nВ параметрах можно указать, какие типы сообщений передавать в хуке:\n\n**Чаты по объявлениям пользователя:**\n\n- [offersMessagesIncoming] — только входящие сообщения по объявлениям пользователя\n- [offersMessagesIncoming, offersMessagesLkOutgoing] — все сообщения по объявлениям пользователя, отправленные не через API\n- [offersMessagesIncoming, offersMessagesLkOutgoing, offersMessagesApiOutgoing] — все сообщения по объявлениям пользователя\n\n**Чаты по чужим объектам, на которые откликнулся пользователь:**\n\n- [inquiryOffersMessagesIncoming] — только входящие сообщения в чатах по чужим объектам\n- [inquiryOffersMessagesIncoming, inquiryOffersMessagesLkOutgoing] — все сообщения в чатах по чужим объектам, отправленные не через API\n- [inquiryOffersMessagesIncoming, inquiryOffersMessagesLkOutgoing, inquiryOffersMessagesApiOutgoing] — все сообщения в чатах по чужим объектам\n\n**Чаты по новостройкам:**\n\n- [newbuildingMessagesIncoming] — только входящие сообщения по новостройкам\n- [newbuildingMessagesIncoming, newbuildingMessagesLkOutgoing] — все сообщения по новостройкам, отправленные не через API\n- [newbuildingMessagesIncoming, newbuildingMessagesLkOutgoing, newbuildingMessagesApiOutgoing] — все сообщения по новостройкам\n\n**Чаты с другими пользователями не по конкретному объекту:**\n\n- [agentMessagesIncoming] — только входящие сообщения в чатах с другими пользователями\n- [agentMessagesIncoming, agentMessagesLkOutgoing] — все сообщения в чатах с другими пользователями, отправленные не через API\n- [agentMessagesIncoming, agentMessagesLkOutgoing, agentMessagesApiOutgoing] — все сообщения в чатах с другими пользователями\n\n**Прочие типы:**\n\n- [systemMessages] — системные сообщения от Циан и модерации;\n- [chatsReadability] — вебхук о прочитанности чата;\n\nНапример: \n- [offersMessagesIncoming] — только входящие сообщения по объявлениям пользователя\n- [offersMessagesIncoming, systemMessages] — только входящие по объявлениям пользователя и системные сообщения\n- [offersMessagesIncoming, offersMessagesLkOutgoing, systemMessages] — все сообщения по объявлениям пользователя, отправленные не через API, а также системные сообщения от Циана и модерации\n\n\nВажно!\n- В вебхуке будут приходить все новые сообщения всех выбранных типов — это может быть одно или несколько сообщений.\n- Если сообщения не удаётся доставить на URL в течение 72 часов, этот URL будет автоматически отключен.\n- В ответе метода указаны модели вебхуков, которые будут отправляться на указанные URL.\n\n\nПример:\n\n curl -X POST -H 'Authorization: Bearer ' https://public-api.cian.ru/v3/subscribe-webhooks --header 'Content-Type: application/json' --data-raw '{\"url\": \"https://example.com\", \"webhookTypes\": [\"offersMessagesIncoming\", \"agentMessagesIncoming\"]}'"}},"/v3/unsubscribe-webhooks":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseSchema"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3UnsubscribeWebhooksRequestSchema"}}}},"tags":["chats"],"summary":"Отписать получателя от вебхуков (v3)","description":"Используйте метод, чтобы отключить URL от получения вебхуков с новыми сообщениями.\n\nВ параметрах можно указать, какие URL и/или webhookType отключить:\n- url: отключит все типы вебхуков, подключенные к указанному URL\n- webhookType: отключит переданный тип вебхука от всех URL \n- url + webhookType: отключит URL у переданного типа вебхука\n\nПример:\n\n curl -X POST -H 'Authorization: Bearer ' https://public-api.cian.ru/v3/unsubscribe-webhooks --header 'Content-Type: application/json' --data-raw '{\"url\": \"https://example.com\", \"webhookType\": \"offersMessages\"}'"}},"/v3/get-webhooks-subscriptions":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V3GetWebhooksSubscriptionsResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[],"tags":["chats"],"summary":"Получить текущие подписки вебхуков (v3)","description":"Используйте метод, чтобы получить список активных подписок на получение вебхуков, включая новые типы подписок: сообщения в чатах по чужим объектам и с другими пользователями.\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v3/get-webhooks-subscriptions --header 'Content-Type: application/json'"}},"/v1/send-test-webhook":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1SendTestWebhooksResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1SendTestWebhooksRequestSchema"}}}},"tags":["chats"],"summary":"Отправить тестовый вебхук на зарегистрированный url","description":"После вызова метода отправим тестовый вебхук на подключенный URL.\n\nПример:\n\n curl -X POST -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/send-test-webhook --header 'Content-Type: application/json' --data-raw '{\"webhookType\": \"offersMessages\"}'\n"}},"/v1/get-chat":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiGetChatResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"chatId","required":true,"description":"ID чата","schema":{"title":"chat_id","type":"integer","format":"int64"}}],"tags":["chats"],"summary":"Получить информацию по чату","description":"Метод возвращает массив данных по аналогии с данными из уведомлений о новых сообщениях (вебхук). \n\nПозволяет узнать данные о последнем сообщении в чате, его авторе и объекте, по которому создан чат.\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/get-chat?chatId=1"}},"/v1/get-chats":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiGetChatsResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"chatCreatedFrom","required":false,"description":"Дата и время создания чата, с которого выгружать чаты включительно. Если параметр не указан, то по умолчанию используется месяц полгода назад от `chatCreatedTill`.","schema":{"title":"chat_created_from","type":"string","format":"date-time"}},{"in":"query","name":"chatCreatedTill","required":false,"description":"Дата и время создания чата, до которого выгружать чаты включительно. Если параметр не указан, то по умолчанию используется текущее время.","schema":{"title":"chat_created_till","type":"string","format":"date-time"}},{"in":"query","name":"employeeId","required":false,"description":"ID кабинета сотрудника в Циане. Список активных сотрудников можно получить по [методу](https://public-api.cian.ru/docs/latest#tag/agents/paths/~1v1~1get-agents/get) или найти в Личном кабинете в разделе Сотрудники. Метод работает только с сотрудниками этого агентства недвижимости, если такого сотрудника нет, вернется пустой ответ.","schema":{"title":"employee_id","type":"integer","format":"int64"}},{"in":"query","name":"orderBy","required":false,"description":"Поле, используемое для сортировки чатов в ответе метода. Сортировать можно по ID чата (`chatId`), дате создания чата (`createdAt`) или дате последнего сообщения в чате (`updatedAt`). Если параметр не указан, то по умолчанию используется значение `updatedAt`.","schema":{"enum":["chatId","createdAt","updatedAt"],"type":"string","x-createdAt":"Время создания чата","x-updatedAt":"Время обновления чата","x-chatId":"Идентификатор чата","description":"\n\t\n `createdAt`: Время создания чата\t\n `updatedAt`: Время обновления чата\t\n `chatId`: Идентификатор чата"}},{"in":"query","name":"orderDir","required":false,"description":"Направление сортировки: `asc` - по возрастанию значения поля `orderBy`, `desc` - по убыванию значения поля `orderBy`. Если параметр не указан, то по умолчанию используется значение `desc`.","schema":{"enum":["asc","desc"],"type":"string","x-asc":"По возрастанию","x-desc":"По убыванию","description":"\n\t\n `asc`: По возрастанию\t\n `desc`: По убыванию"}},{"in":"query","name":"page","required":true,"description":"Номер страницы, если количество чатов в ответе метода превышает `pageSize`. Обязательный параметр. Страницы нумеруются с 1. Если указан несуществующий номер страницы, вернется пустой ответ.","schema":{"title":"page","type":"integer","format":"int64"}},{"in":"query","name":"pageSize","required":true,"description":"Количество чатов, возвращаемое методом за один вызов. Обязательный параметр. Минимальное значение 1, максимальное значение 100.","schema":{"title":"page_size","type":"integer","format":"int64"}}],"tags":["chats"],"summary":"Получить информацию по чатам","description":"Метод позволяет получить массив всех чатов агентства или только определенного сотрудника с учетом параметров сортировки и пагинации за выбранный период. Максимальный размер окна выборки по дате создания - полгода.\n\nВ объекте каждого чата: данные о последнем сообщении, его авторе и объявлении, по которому создан чат.\n\nПри активной подписке в вебхуках на системные сообщения systemMessages по этому методу можно получать также данные по системным чатам (Циан и модерация).\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/get-chats?page=1&pageSize=100&orderBy=chatId&chatCreatedFrom=2024-10-04+07:56:31&chatCreatedTill=2025-02-24+07:56:31"}},"/v1/read-chat":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseSchema"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiReadChatRequestSchema"}}}},"tags":["chats"],"summary":"Пометить чат прочитанным","description":"Метод позволяет пометить чат прочитанным.\n\nПример:\n\n curl -X POST -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/read-chat?chatId=1"}},"/v1/get-messages":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiGetMessagesResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"chatId","required":true,"description":"ID чата","schema":{"title":"chat_id","type":"integer","format":"int64"}},{"in":"query","name":"page","required":true,"description":"Номер страницы, если количество сообщений в ответе метода превышает `pageSize`. Обязательный параметр. Страницы нумеруются с 1. Если указан несуществующий номер страницы, вернется пустой ответ.","schema":{"title":"page","type":"integer","format":"int64"}},{"in":"query","name":"pageSize","required":true,"description":"Количество сообщений, возвращаемое методом за один вызов. Обязательный параметр. Минимальное значение 1, максимальное значение 100.","schema":{"title":"page_size","type":"integer","format":"int64"}},{"in":"query","name":"readChat","required":false,"description":"Пометить ли чат прочитанным, по умолчанию True","schema":{"title":"read_chat","type":"boolean"}}],"tags":["chats"],"summary":"Получить список сообщений","description":"Метод позволяет вернуть список всех сообщений в заданном ID чата: для этого укажите количество сообщений в ответе и номер страницы.\n\nМетод возвращает список всех сообщений в чате, данные о пользователях в чате, а также общее количество всех сообщений в чате.\n\nВажно!\n- По системным чатам (Циан и модерация) будут доступны только последние 100 сообщений.\n\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/get-messages?page=1&pageSize=100&chatId=1"}},"/v1/get-message-file":{"get":{"responses":{"200":{"content":{"application/octet-stream":{"examples":{"response":{"value":"binary data"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"fileId","required":true,"description":"Идентификатор файла","schema":{"title":"file_id","type":"string"}}],"tags":["chats"],"summary":"Получить файл","description":"Метод позволяет получить файл по его уникальному идентификатору.\n\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/get-message-file?fileId=d5c09995-5677-4303-923e-401182574cc5"}},"/v1/send-message":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiSendMessageResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiSendMessageRequestSchema"}}}},"tags":["chats"],"summary":"Отправить сообщение","description":"Метод позволяет отправлять текстовые сообщения от имени автора объявления.\n\nПример:\n\n curl -X POST -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/send-message --header 'Content-Type: application/json' --data-raw '{\"chatId\": 1, \"content\": {\"text\": \"Это тестовое сообщение\"}}'"}},"/v1/upload-file":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddFilesResponseV2SchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}}}}}},"tags":["chats"],"summary":"Загрузить файл","description":"Метод используется для загрузки файлов: JPEG, GIF, PNG, TIFF, HEIC, HEIF, DOC, PDF.\n\nОсобенности работы с загрузкой изображений:\n- Можно загружать несколько файлов\n- Если несколько файлов в запросе, их порядок в ответе такое же как при запросе\n- Максимальный размер запроса — 50 МБ\n\nПример:\n\n curl --location 'https://public-api.cian.ru/v1/upload-file' --form 'photo_balcony=@\"/tmp/photo_balcony.png\"' --form 'room=@\"/tmp/room.jpeg\"'"}},"/v1/send-message-with-files":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiSendMessageResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicApiSendMessageWithFilesRequestSchema"}}}},"tags":["chats"],"summary":"Отправить сообщение с файлами","description":"Метод позволяет отправлять сообщения с файлами от имени автора объявления.\n\nПеред отправкой сообщения с файлами необходимо загрузить файлы \nчерез метод [`/v1/upload-file/`](#tag/chats/paths/~1v1~1upload-file/post), получить идентификаторы файлов (uid)\nи использовать их при отправке сообщения.\n\nПример:\n\n curl -X POST -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/send-message-with-files --header 'Content-Type: application/json' --data-raw '{\"chatId\": 1, \"content\": {\"text\": \"Это сообщение с файлом\", \"files\": [{\"uid\": \"file-uid-123\", \"name\": \"document.pdf\"}]}}'"}},"/v2/subscribe-webhooks":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2SubscribeWebhooksResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2SubscribeWebhooksRequestSchema"}}}},"tags":["chats"],"summary":"Зарегистрировать получателя вебхуков (v2)","description":"С помощью метода можно подключить отправку вебхуков на переданный URL. \nВ параметрах можно указать, какие сообщения передавать в хуке:\n\n- [offersMessagesIncoming] — все входящие сообщения по объявлениям;\n- [offersMessagesIncoming, offersMessagesLkOutgoing] — все входящие и исходящие по объявлениям, отправленные не через API;\n- [offersMessagesIncoming, offersMessagesLkOutgoing, offersMessagesApiOutgoing] — все входящие и все исходящие сообщения по объявлениям.\n- [newbuildingMessagesIncoming] - все входящие сообщения по новостройкам;\n- [newbuildingMessagesIncoming, newbuildingMessagesLkOutgoing] — все входящие и исходящие по новостройкам, отправленные не через API;\n- [newbuildingMessagesIncoming, newbuildingMessagesLkOutgoing, newbuildingMessagesApiOutgoing] — все входящие и все исходящие сообщения по новостройкам.\n- [systemMessages] — системные сообщения от Циан и модерации;\n- [chatsReadability] — вебхук о прочитанности чата;\n\nНапример: \n- [offersMessagesIncoming] — только входящие сообщения по объявлениям;\n- [offersMessagesIncoming, systemMessages] — только входящие по объявлениям и системные сообщения;\n- [offersMessagesIncoming, offersMessagesLkOutgoing, systemMessages] — все входящие и исходящие по объявлениям, отправленные не через API, а также системные сообщения от Циан и модерации.\n\n\nВажно!\n- В вебхуке будут приходить все новые сообщения по всем чатам — это может быть одно или несколько сообщений.\n- Если в течение больше 72 часов не удается доставить сообщения на URL, он будет автоматически отключен.\n- В ответе метода указаны модели вебхуков, которые будут отправляться на указанные URL.\n\n\nПример:\n\n curl -X POST -H 'Authorization: Bearer ' https://public-api.cian.ru/v2/subscribe-webhooks --header 'Content-Type: application/json' --data-raw '{\"url\": \"https://example.com\", \"webhookTypes\": [\"offersMessagesIncoming\"]}'\n","deprecated":"true"}},"/v2/unsubscribe-webhooks":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseSchema"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V2UnsubscribeWebhooksRequestSchema"}}}},"tags":["chats"],"summary":"Отписать получателя от вебхуков (v2)","description":"Используйте метод для отключения URL от получения вебхуков новых сообщений.\n\nВ параметрах можно указать, какие URL и/или webhookType отключить:\n- url: отключит все типы вебхуков, подключенные к указанному URL.\n- webhookType: отключит переданный тип вебхука полностью (все URL). \n- url + webhookType: отключит URL у переданного тип вебхука.\n\nПример:\n\n curl -X POST -H 'Authorization: Bearer ' https://public-api.cian.ru/v2/unsubscribe-webhooks --header 'Content-Type: application/json' --data-raw '{\"url\": \"https://example.com\", \"webhookType\": \"offersMessages\"}'","deprecated":"true"}},"/v1/get-webhooks-subscriptions":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetWebhooksSubscriptionsResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[],"tags":["chats"],"summary":"Получить текущие подписки вебхуков (v1)","description":"Используйте метод для получения списка текущих подписок на получение вебхуков.\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/get-webhooks-subscriptions --header 'Content-Type: application/json'","deprecated":"true"}},"/v1/subscribe-offers-messages-webhook":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseSchema"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscribeOffersMessagesWebhooksRequestSchema"}}}},"tags":["chats"],"summary":"Зарегистрировать получателя вебхуков о новых сообщениях в чатах по объявлениям","description":"С помощью метода можно подключить получение новых сообщений на переданный URL. \nВ параметрах можно указать, какие сообщения передавать в хуке:\n\n- только входящие сообщения (по умолчанию);\n- все входящие и исходящие, отправленные не через API;\n- все входящие и исходящие сообщения.\n\nВ вебхуке будут приходить все новые сообщения по всем чатам — это может быть одно или несколько сообщений.\n\nПример:\n\n curl -X POST -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/subscribe-offers-messages-webhook --header 'Content-Type: application/json' --data-raw '{\"url\": \"https://example.com\", \"deliveryStrategy\": \"incoming\"}'\n","deprecated":"true"}},"/v1/unsubscribe-offers-messages-webhook":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmptyResponseSchema"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnsubscribeOffersMessagesWebhooksRequestSchema"}}}},"tags":["chats"],"summary":"Отписать получателя вебхуков о новых сообщениях в чатах по объявлениям","description":"Используйте метод для отключения URL от получения вебхуков новых сообщений.\n\n\nПример:\n\n curl -X POST -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/unsubscribe-offers-messages-webhook --header 'Content-Type: application/json'","deprecated":"true"}},"/v1/get-search-coverage":{"get":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOfferCoverageResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"parameters":[{"in":"query","name":"dateFrom","required":true,"description":"Дата начала периода","schema":{"title":"date_from","type":"string","format":"date"}},{"in":"query","name":"dateTo","required":true,"description":"Дата конца периода","schema":{"title":"date_to","type":"string","format":"date"}},{"in":"query","name":"offerId","required":true,"description":"ID объявления в ЦИАН","schema":{"title":"offer_id","type":"integer","format":"int64"}}],"tags":["statistics"],"summary":"Получить охват по объявлению","description":"Устаревшее API\n\nМетод позволяет получить охват по объявлению. Охват – это доля увидевших ваше объявление из тех пользователей, под чей поиск подошёл ваш объект. Остальные пользователи не долистали результаты поиска до вашего объявления.\n\nПример:\n\n curl -X GET -H 'Authorization: Bearer ' https://public-api.cian.ru/v1/get-search-coverage?dateTo=2019-10-30&dateFrom=2019-09-10&offerId=116033160","deprecated":"true"}},"/v1/get-available-offers":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAvailableOffersResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetAvailableOffersRequestSchema"}}}},"tags":["proposals"],"summary":"Проверка доступности объявлений для рассылки","description":"Метод позволяет проверить, доступны ли указанные объявления для создания рассылок предложений. Для каждого объявления возвращается статус доступности и, в случае недоступности, причины.\n\nПроверка учитывает:\n- Принадлежность объявления пользователю\n- Категорию объявления (поддерживается ли данный тип недвижимости)\n- Особые характеристики объявления, влияющие на возможность создания рассылок"}},"/v1/get-mailing-parameters":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetMailingParametersResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1GetMailingParametersRequestSchema"}}}},"tags":["proposals"],"summary":"Получение параметров для формирования предложений","description":"Метод предоставляет информацию о доступных параметрах для создания рассылок предложений по указанным объявлениям.\n\nОграничение:\n- Количество одновременных рассылок может быть ограничено, максимальное значение будет указано в ошибке\n\nВозвращаемые данные включают:\n- Общие параметры, применимые ко всем объявлениям:\n - Все доступные типы предложений (скидка, быстрый выход на сделку, просмотр объекта и проч.)\n - Допустимые сроки действия предложений\n\n- Параметры для каждого конкретного объявления:\n - Максимальный и минимальный размер скидки\n - Количество потенциальных получателей\n - Доступные типы предложений для конкретного объявления"}},"/v1/create-mailings":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateMailingsResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/V1CreateMailingsRequestSchema"}}}},"tags":["proposals"],"summary":"Создание рассылок предложений","description":"Метод принимает список объявлений с параметрами для создания рассылок и сохраняет их в системе.\n\nОграничение:\n- Количество одновременных рассылок может быть ограничено, максимальное значение будет указано в ошибке\n\nДля каждого объявления можно указать:\n- Тип предложения (скидка, готовность к быстрой сделке, просмотр объекта, юридическое сопровождение и др.)\n- Размер скидки (для предложений типа «скидка»: конкретная сумма в рублях, долларах или евро)\n- Количество получателей\n- Срок действия предложения\n\nСистема проводит валидацию параметров и возвращает статус обработки для каждого объявления."}},"/v1/calculate-tariffs/":{"post":{"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalculateTariffsResponseSchemaWrapper"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseSchemaWrapper"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CalculateTariffsRequestSchema"}}}},"tags":["tariffs"],"summary":"Рассчитать актуальные тарифы размещения и продвижения","description":"Метод возвращает актуальную стоимость публикации объявления и стоимость продвижения (кроме продвижения с оплатой за уникальный просмотр).\n\nApi-интерфейс носит исключительно информационный характер. Данные, полученные Пользователем с использованием api-интерфейса являются актуальными исключительно на момент их запроса. Фактическая стоимость размещения и продвижения объявления по указанным Пользователем параметрам отображается непосредственно перед оплатой соответствующего объявления на сайте cian.ru\n\nПоддерживаются все категории XML-фидов, кроме посуточной аренды и новостроек. Для доступа к этому API необходимо обладать подпиской с уровнем Silver, Gold или Platinum, а также подключёнными XML-фидами."}}},"components":{"schemas":{"BonusBalanceSchema":{"type":"object","properties":{"amount":{"title":"amount","type":"number","format":"decimal","description":"Остаток бонуса"},"endDate":{"title":"end_date","type":"string","format":"date-time","description":"Последний день срока действия бонуса"}},"required":["amount"]},"BalanceModelSchema":{"type":"object","properties":{"auctionPoints":{"type":"array","items":{"$ref":"#/components/schemas/BonusBalanceSchema"},"description":"Баллы на аукцион и сроки их истечения"},"bonuses":{"type":"array","items":{"$ref":"#/components/schemas/BonusBalanceSchema"},"description":"Бонусы и сроки их истечения (включая бессрочные бонусы)."},"discountBonuses":{"type":"array","items":{"$ref":"#/components/schemas/BonusBalanceSchema"},"description":"Новые вид бонусов, которые не смешиваются с рублями."},"heldAmount":{"title":"held_amount","type":"number","format":"decimal","description":"Захолдированные средства"},"totalBalance":{"title":"total_balance","type":"number","format":"decimal","description":"Полный суммарный баланс пользователя на текущий момент, без кеша. Включает все виды денег (бонусы и т.п.)"}},"required":["heldAmount","totalBalance"]},"BalanceModelSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/BalanceModelSchema","description":"Результат"}},"required":["operationId","result"]},"ErrorSchema":{"type":"object","properties":{"code":{"title":"code","type":"string","description":"Код ошибки"},"key":{"title":"key","type":"string","description":"Название поля"},"message":{"title":"message","type":"string","description":"Сообщение об ошибке"}}},"ErrorResponseSchema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorSchema"},"description":"Ошибки"},"message":{"title":"message","type":"string","description":"Сообщение об ошибке"}},"required":["message"]},"ErrorResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/ErrorResponseSchema","description":"Результат"}},"required":["operationId","result"]},"OfferAuctionInfoSchema":{"type":"object","properties":{"currentBet":{"title":"current_bet","type":"number","format":"double","description":"Текущая ставка"},"leaderBet":{"title":"leader_bet","type":"number","format":"double","description":"Ставка лидера"},"offerId":{"title":"offer_id","type":"integer","format":"int64","description":"Id объявления"},"page":{"title":"page","type":"integer","format":"int64","description":"Страница"},"position":{"title":"position","type":"integer","format":"int64","description":"Позиция в выдаче"}},"required":["offerId","page","position"]},"V1GetOffersAuctionInfoResponseSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OfferAuctionInfoSchema"},"description":"Конкуренция по объявлениям"}},"required":["items"]},"V1GetOffersAuctionInfoResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/V1GetOffersAuctionInfoResponseSchema","description":"Результат"}},"required":["operationId","result"]},"PredictionSchema":{"type":"object","properties":{"bet":{"title":"bet","type":"integer","format":"int64","description":"Ставка к топу"},"promotionType":{"enum":["noPromotion","premium","standard","top"],"type":"string","x-noPromotion":"Без продвижения. Объявление без ставки","x-standard":"Стандарт. Платное или бесплатное размещение с минимальной ставкой","x-premium":"Премиум. Соответствует услуге PremiumObject","x-top":"Топ. Соответствует услуге Top3","description":"\n\t\n `noPromotion`: Без продвижения. Объявление без ставки\t\n `standard`: Стандарт. Платное или бесплатное размещение с минимальной ставкой\t\n `premium`: Премиум. Соответствует услуге PremiumObject\t\n `top`: Топ. Соответствует услуге Top3"},"requestedBet":{"title":"requested_bet","type":"integer","format":"int64","description":"Запрошенная ставка к топу"},"upperUplift":{"title":"upper_uplift","type":"integer","format":"int64","description":"Верхняя граница прироста показов относительно noPromotion"}},"required":["promotionType","upperUplift"]},"OfferPredictionsSchema":{"type":"object","properties":{"date":{"title":"date","type":"string","format":"date","description":"Дата составления прогноза"},"offerId":{"title":"offer_id","type":"integer","format":"int64","description":"Идентификатор объявления"},"predictions":{"type":"array","items":{"$ref":"#/components/schemas/PredictionSchema"},"description":"Прогнозы по уровням продвижения и ставкам к топу, если были запрошены ставки к топу"}},"required":["date","offerId","predictions"]},"V1GetOffersPredictionsResponseSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OfferPredictionsSchema"},"description":"Прогнозы по объявлениям"}},"required":["items"]},"V1GetOffersPredictionsResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/V1GetOffersPredictionsResponseSchema","description":"Результат"}},"required":["operationId","result"]},"V1GetOffersPredictionsRequestSchema":{"type":"object","properties":{"bets":{"title":"bets","type":"array","items":{"title":"bets","type":"integer","format":"int64"},"description":"Ставки к топу, по которым нужно вернуть прогнозы (максимум 20шт. по всем объявлениям)"},"offerIds":{"title":"offer_ids","type":"array","items":{"title":"offer_ids","type":"integer","format":"int64"},"description":"Ids объявлений (максимум 20шт.)"}},"required":["offerIds"]},"CpcPromotionCompetitionAnnouncementDtoSchema":{"type":"object","properties":{"amountSpent":{"title":"amount_spent","type":"integer","format":"int64","description":"Потраченные на продвижение объявление средства (баллы/рубли) за текущий день."},"announcementId":{"title":"announcement_id","type":"integer","format":"int64","description":"Id объявления."},"competitorsWithPromotion":{"title":"competitors_with_promotion","type":"integer","format":"int64","description":"Количество конкурентов с продвижением."},"competitorsWithoutPromotion":{"title":"competitors_without_promotion","type":"integer","format":"int64","description":"Количество конкурентов без продвижения."},"isPromotionApplied":{"title":"is_promotion_applied","type":"boolean","description":"Применено ли продвижение к объявлению."},"leftLimit":{"title":"left_limit","type":"integer","format":"int64","description":"Остаток лимита на продвижение до конца дня."},"maxCompetitorBet":{"title":"max_competitor_bet","type":"integer","format":"int64","description":"Максимальная ставка конкурентов с продвижением."},"minAheadOfCompetitorsBet":{"title":"min_ahead_of_competitors_bet","type":"integer","format":"int64","description":"Ставка для опережения всех конкурентов с продвижением."},"minCompetitorBet":{"title":"min_competitor_bet","type":"integer","format":"int64","description":"Минимальная ставка конкурентов с продвижением."},"paidClicksCount":{"title":"paid_clicks_count","type":"integer","format":"int64","description":"Количество полученных просмотров объявления от продвижения за текущий день."},"percentageOutranked":{"title":"percentage_outranked","type":"integer","format":"int64","description":"Процент опережаеемых конкурентов с продвижением при указанной ставке."}},"required":["amountSpent","announcementId","competitorsWithPromotion","competitorsWithoutPromotion","isPromotionApplied","leftLimit","minAheadOfCompetitorsBet","paidClicksCount","percentageOutranked"]},"GetCpcPromotionCompetitionsResponseSchema":{"type":"object","properties":{"announcements":{"type":"array","items":{"$ref":"#/components/schemas/CpcPromotionCompetitionAnnouncementDtoSchema"},"description":"Массив данных по объявлениям."},"nextPage":{"title":"next_page","type":"boolean","description":"Есть ли следующая страница."},"totalCount":{"title":"total_count","type":"integer","format":"int64","description":"Сколько объявлений всего найдено."}},"required":["announcements","nextPage","totalCount"]},"GetCpcPromotionCompetitionsResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/GetCpcPromotionCompetitionsResponseSchema","description":"Результат"}},"required":["operationId","result"]},"GetCpcPromotionCompetitionsRequestSchema":{"type":"object","properties":{"announcementIds":{"title":"announcement_ids","type":"array","items":{"title":"announcement_ids","type":"integer","format":"int64"},"description":"Список конкретных объявлений; если передан, ручка работает в режиме \"по списку\"."},"page":{"title":"page","type":"integer","format":"int64","description":"Номер страницы; нужен если announcementIds не передан или пустой."},"pageSize":{"title":"page_size","type":"integer","format":"int64","description":"Размер страницы в режиме пагинации."}}},"CpcPromotionBetConfigurationItemDtoSchema":{"type":"object","properties":{"betStep":{"title":"bet_step","type":"integer","format":"int64","description":"Шаг изменения ставки."},"category":{"enum":["bedRent","buildingRent","buildingSale","businessRent","businessSale","carServiceRent","carServiceSale","commercialLandRent","commercialLandSale","cottageRent","cottageSale","dailyBedRent","dailyFlatRent","dailyHouseRent","dailyRoomRent","domesticServicesRent","domesticServicesSale","flatRent","flatSale","flatShareSale","freeAppointmentObjectRent","freeAppointmentObjectSale","garageRent","garageSale","houseRent","houseSale","houseShareRent","houseShareSale","industryRent","industrySale","landSale","newBuildingFlatSale","officeRent","officeSale","publicCateringRent","publicCateringSale","roomRent","roomSale","shoppingAreaRent","shoppingAreaSale","townhouseRent","townhouseSale","warehouseRent","warehouseSale"],"type":"string","x-bedRent":"Койко-место = 0","x-buildingRent":"Здание = 1","x-buildingSale":"Здание = 2","x-businessRent":"Готовый бизнес = 3","x-businessSale":"Готовый бизнес = 4","x-carServiceRent":"Аренда автосервис = 5","x-carServiceSale":"Продажа автосервиса = 6","x-commercialLandRent":"Коммерческая земля = 7","x-commercialLandSale":"Коммерческая земля = 8","x-cottageRent":"Коттедж = 9","x-cottageSale":"Коттедж = 10","x-dailyBedRent":"Посуточная аренда койко-места = 11","x-dailyFlatRent":"Посуточная аренда квартиры = 12","x-dailyHouseRent":"Посуточная аренда дома, дачи, коттеджа = 13","x-dailyRoomRent":"Посуточная аренда комнаты = 14","x-domesticServicesRent":"Аренда помещения под бытовые услуги = 15","x-domesticServicesSale":"Продажа помещения под бытовые услуги = 16","x-flatRent":"Квартира = 17","x-flatSale":"Квартира = 18","x-flatShareSale":"Доля в квартире = 19","x-freeAppointmentObjectRent":"Помещение свободного назначения = 20","x-freeAppointmentObjectSale":"Помещение свободного назначения = 21","x-garageRent":"Гараж = 22","x-garageSale":"Гараж = 23","x-houseRent":"Дом/дача = 24","x-houseSale":"Дом/дача = 25","x-houseShareRent":"Часть дома = 26","x-houseShareSale":"Часть дома = 27","x-industryRent":"Производство = 28","x-industrySale":"Производство = 29","x-landSale":"Участок = 30","x-newBuildingFlatSale":"Квартира в новостройке = 31","x-officeRent":"Офис = 32","x-officeSale":"Офис = 33","x-publicCateringRent":"Аренда общепита = 34","x-publicCateringSale":"Продажа общепита = 35","x-roomRent":"Комната = 36","x-roomSale":"Комната = 37","x-shoppingAreaRent":"Торговая площадь = 38","x-shoppingAreaSale":"Торговая площадь = 39","x-townhouseRent":"Таунхаус = 40","x-townhouseSale":"Таунхаус = 41","x-warehouseRent":"Склад = 42","x-warehouseSale":"Склад = 43","description":"\n\t\n `bedRent`: Койко-место = 0\t\n `buildingRent`: Здание = 1\t\n `buildingSale`: Здание = 2\t\n `businessRent`: Готовый бизнес = 3\t\n `businessSale`: Готовый бизнес = 4\t\n `carServiceRent`: Аренда автосервис = 5\t\n `carServiceSale`: Продажа автосервиса = 6\t\n `commercialLandRent`: Коммерческая земля = 7\t\n `commercialLandSale`: Коммерческая земля = 8\t\n `cottageRent`: Коттедж = 9\t\n `cottageSale`: Коттедж = 10\t\n `dailyBedRent`: Посуточная аренда койко-места = 11\t\n `dailyFlatRent`: Посуточная аренда квартиры = 12\t\n `dailyHouseRent`: Посуточная аренда дома, дачи, коттеджа = 13\t\n `dailyRoomRent`: Посуточная аренда комнаты = 14\t\n `domesticServicesRent`: Аренда помещения под бытовые услуги = 15\t\n `domesticServicesSale`: Продажа помещения под бытовые услуги = 16\t\n `flatRent`: Квартира = 17\t\n `flatSale`: Квартира = 18\t\n `flatShareSale`: Доля в квартире = 19\t\n `freeAppointmentObjectRent`: Помещение свободного назначения = 20\t\n `freeAppointmentObjectSale`: Помещение свободного назначения = 21\t\n `garageRent`: Гараж = 22\t\n `garageSale`: Гараж = 23\t\n `houseRent`: Дом/дача = 24\t\n `houseSale`: Дом/дача = 25\t\n `houseShareRent`: Часть дома = 26\t\n `houseShareSale`: Часть дома = 27\t\n `industryRent`: Производство = 28\t\n `industrySale`: Производство = 29\t\n `landSale`: Участок = 30\t\n `newBuildingFlatSale`: Квартира в новостройке = 31\t\n `officeRent`: Офис = 32\t\n `officeSale`: Офис = 33\t\n `publicCateringRent`: Аренда общепита = 34\t\n `publicCateringSale`: Продажа общепита = 35\t\n `roomRent`: Комната = 36\t\n `roomSale`: Комната = 37\t\n `shoppingAreaRent`: Торговая площадь = 38\t\n `shoppingAreaSale`: Торговая площадь = 39\t\n `townhouseRent`: Таунхаус = 40\t\n `townhouseSale`: Таунхаус = 41\t\n `warehouseRent`: Склад = 42\t\n `warehouseSale`: Склад = 43"},"id":{"title":"id","type":"integer","format":"int64","description":"Id конфигурации."},"limitStep":{"title":"limit_step","type":"integer","format":"int64","description":"Шаг изменения дневного лимита."},"minBet":{"title":"min_bet","type":"integer","format":"int64","description":"Минимальная ставка."},"minLimit":{"title":"min_limit","type":"integer","format":"int64","description":"Минимальный дневной лимит."},"polygonId":{"title":"polygon_id","type":"integer","format":"int64","description":"Id полигона, для которого действует конфигурация."}},"required":["betStep","id","limitStep","minBet","minLimit"]},"GetCpcPromotionParametersResponseSchema":{"type":"object","properties":{"configurations":{"type":"array","items":{"$ref":"#/components/schemas/CpcPromotionBetConfigurationItemDtoSchema"},"description":"Массив конфигураций CPC."}},"required":["configurations"]},"GetCpcPromotionParametersResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/GetCpcPromotionParametersResponseSchema","description":"Результат"}},"required":["operationId","result"]},"OfferAppliedServiceModelSchema":{"type":"object","properties":{"closedDate":{"title":"closed_date","type":"string","format":"date-time","description":"Дата закрытия контракта"},"paidByServicePackage":{"title":"paid_by_service_package","type":"boolean","description":"Оплачен за счет Пакета прожвижения"},"paidTill":{"title":"paid_till","type":"string","format":"date-time","description":"Оплачена до"},"price":{"title":"price","type":"number","format":"decimal","description":"Стоимость за тарифицационный период"},"serviceTypes":{"title":"service_types","type":"array","items":{"enum":["BonusPaymentExpiration","DebitObject","FreeObject","Highlight","OrderCancellation","OrderTransfer","Penalty","PremiumObject","ServicePackageActivation","StatusPro","SubscriptionForPackage","TechSpend","TechTransfer","Top3","XmlImport","auction","calltracking","cplCalltracking","demand","demandPackage","dynamic"],"type":"string","x-DebitObject":"Платная публикация","x-PremiumObject":"Премиум публикация","x-Top3":"Тор 3","x-Highlight":"Выделение цветом","x-calltracking":"Подмена номера, Calltracking, оно же \"защита номера\"","x-FreeObject":"Бесплатная публикация","x-XmlImport":"Выгрузка объявлений через XML","x-SubscriptionForPackage":"Абонентская плата за пакет","x-StatusPro":"Признак статуса ПРО","x-ServicePackageActivation":"Массовый пакет","x-Penalty":"Штрафное списание","x-OrderCancellation":"Отмена платежа","x-OrderTransfer":"перенос платежа","x-TechSpend":"Произвольное списание","x-TechTransfer":"Перенос произвольной суммы","x-BonusPaymentExpiration":"Списание истекшего бонусного пополнения","x-auction":"Списание за аукцион","x-demand":"Списание за заявку на спрос","x-demandPackage":"Списание за пакет заявок на спрос","x-cplCalltracking":"Коллтрекинг по модели CPL","x-dynamic":"Динамическая услуга","description":"\n\t\n `DebitObject`: Платная публикация\t\n `PremiumObject`: Премиум публикация\t\n `Top3`: Тор 3\t\n `Highlight`: Выделение цветом\t\n `calltracking`: Подмена номера, Calltracking, оно же \"защита номера\"\t\n `FreeObject`: Бесплатная публикация\t\n `XmlImport`: Выгрузка объявлений через XML\t\n `SubscriptionForPackage`: Абонентская плата за пакет\t\n `StatusPro`: Признак статуса ПРО\t\n `ServicePackageActivation`: Массовый пакет\t\n `Penalty`: Штрафное списание\t\n `OrderCancellation`: Отмена платежа\t\n `OrderTransfer`: перенос платежа\t\n `TechSpend`: Произвольное списание\t\n `TechTransfer`: Перенос произвольной суммы\t\n `BonusPaymentExpiration`: Списание истекшего бонусного пополнения\t\n `auction`: Списание за аукцион\t\n `demand`: Списание за заявку на спрос\t\n `demandPackage`: Списание за пакет заявок на спрос\t\n `cplCalltracking`: Коллтрекинг по модели CPL\t\n `dynamic`: Динамическая услуга"},"description":"\n\t\n `DebitObject`: Платная публикация\t\n `PremiumObject`: Премиум публикация\t\n `Top3`: Тор 3\t\n `Highlight`: Выделение цветом\t\n `calltracking`: Подмена номера, Calltracking, оно же \"защита номера\"\t\n `FreeObject`: Бесплатная публикация\t\n `XmlImport`: Выгрузка объявлений через XML\t\n `SubscriptionForPackage`: Абонентская плата за пакет\t\n `StatusPro`: Признак статуса ПРО\t\n `ServicePackageActivation`: Массовый пакет\t\n `Penalty`: Штрафное списание\t\n `OrderCancellation`: Отмена платежа\t\n `OrderTransfer`: перенос платежа\t\n `TechSpend`: Произвольное списание\t\n `TechTransfer`: Перенос произвольной суммы\t\n `BonusPaymentExpiration`: Списание истекшего бонусного пополнения\t\n `auction`: Списание за аукцион\t\n `demand`: Списание за заявку на спрос\t\n `demandPackage`: Списание за пакет заявок на спрос\t\n `cplCalltracking`: Коллтрекинг по модели CPL\t\n `dynamic`: Динамическая услуга"},"startDate":{"title":"start_date","type":"string","format":"date-time","description":"Дата подключения"},"tarifficationDuration":{"title":"tariffication_duration","type":"integer","format":"int64","description":"Период оплаты услуги в микросекундах"}},"required":["paidByServicePackage","price","serviceTypes","startDate","tarifficationDuration"]},"OfferAppliedServicesModelSchema":{"type":"object","properties":{"actorUserId":{"title":"actor_user_id","type":"integer","format":"int64","description":"Инициатор подключения услуги"},"autoProlongEnabled":{"title":"auto_prolong_enabled","type":"boolean","description":"Автоматическая пролонгация услуги"},"offerId":{"title":"offer_id","type":"integer","format":"int64","description":"Id объявления"},"publishedUserId":{"title":"published_user_id","type":"integer","format":"int64","description":"Пользователь оплативший услугу"},"services":{"type":"array","items":{"$ref":"#/components/schemas/OfferAppliedServiceModelSchema"},"description":"Подключенные услуги"}},"required":["actorUserId","autoProlongEnabled","offerId","publishedUserId","services"]},"GetActualAppliedServicesApiResponseSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OfferAppliedServicesModelSchema"},"description":"Объявления с подключенными услугами"}},"required":["items"]},"GetActualAppliedServicesApiResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/GetActualAppliedServicesApiResponseSchema","description":"Результат"}},"required":["operationId","result"]},"OperationByUserModelSchema":{"type":"object","properties":{"amount":{"title":"amount","type":"number","format":"decimal","description":"Сумма операции"},"comment":{"title":"comment","type":"string","description":"Описание для пользователя"},"date":{"title":"date","type":"string","format":"date-time","description":"Дата совершения операции"},"discountBonusesAmount":{"title":"discount_bonuses_amount","type":"number","format":"decimal","description":"Сумма операции бонусами на продвижение"},"logObjectType":{"enum":["flat","flat2","office","suburban","user","vc"],"type":"string","x-flat":"Аренда квартир","x-user":"Пользователь","x-office":"Аренда продажа офисов","x-suburban":"Аренда, продажа загородной недвижимости","x-vc":"Вакансии","x-flat2":"Продажа квартир","description":"\n\t\n `flat`: Аренда квартир\t\n `user`: Пользователь\t\n `office`: Аренда продажа офисов\t\n `suburban`: Аренда, продажа загородной недвижимости\t\n `vc`: Вакансии\t\n `flat2`: Продажа квартир"},"offerId":{"title":"offer_id","type":"integer","format":"int64","description":"Id объявления"},"paymentType":{"enum":["bonus","money","points"],"type":"string","x-money":"За деньги","x-points":"За баллы","x-bonus":"Бонусами на продвижение","description":"\n\t\n `money`: За деньги\t\n `points`: За баллы\t\n `bonus`: Бонусами на продвижение"},"pointsAmount":{"title":"points_amount","type":"number","format":"decimal","description":"Сумма операции баллами"},"type":{"enum":["balance","deposit","hold","infoMessage","withdrawal"],"type":"string","x-withdrawal":"Списание","x-deposit":"Пополнение","x-balance":"Срез по балансу","x-infoMessage":"Информационное сообщение","x-hold":"Резервирование средств под услугу","description":"\n\t\n `withdrawal`: Списание\t\n `deposit`: Пополнение\t\n `balance`: Срез по балансу\t\n `infoMessage`: Информационное сообщение\t\n `hold`: Резервирование средств под услугу"},"userId":{"title":"user_id","type":"integer","format":"int64","description":"Id пользователя"}},"required":["amount","date","logObjectType","paymentType","pointsAmount","type","userId"]},"OperationsByUserListResponseSchema":{"type":"object","properties":{"operations":{"type":"array","items":{"$ref":"#/components/schemas/OperationByUserModelSchema"},"description":"Список операций"}}},"OperationsByUserListResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/OperationsByUserListResponseSchema","description":"Результат"}},"required":["operationId","result"]},"AgentBalanceResponseSchema":{"type":"object","properties":{"auctionPoints":{"title":"auction_points","type":"number","format":"decimal","description":"Суммарный баланс неистекших баллов на аукцион"},"balance":{"title":"balance","type":"number","format":"decimal","description":"Полный суммарный баланс пользователя на текущий момент. Включает все виды денег (бонусы и т.п.)"}},"required":["auctionPoints","balance"]},"AgentServicePackagesLimitsSchema":{"type":"object","properties":{"highlightCount":{"title":"highlight_count","type":"integer","format":"int64","description":"Количество задействованных слотов в категории Выделение цветом"},"highlightLimit":{"title":"highlight_limit","type":"integer","format":"int64","description":"Лимит объявлений в категории Выделение цветом"},"paidCount":{"title":"paid_count","type":"integer","format":"int64","description":"Количество задействованных слотов в категории Платное"},"paidLimit":{"title":"paid_limit","type":"integer","format":"int64","description":"Лимит объявлений в категории Платное"},"premiumCount":{"title":"premium_count","type":"integer","format":"int64","description":"Количество задействованных слотов в категории Премиум"},"premiumLimit":{"title":"premium_limit","type":"integer","format":"int64","description":"Лимит объявлений в категории Премиум"},"top3Count":{"title":"top3_count","type":"integer","format":"int64","description":"Количество задействованных слотов в категории ТОП3"},"top3Limit":{"title":"top3_limit","type":"integer","format":"int64","description":"Лимит объявлений в категории ТОП3"}},"required":["highlightCount","paidCount","premiumCount","top3Count"]},"AgentSpendLimitResponseSchema":{"type":"object","properties":{"allowVas":{"title":"allow_vas","type":"boolean","description":"Разрешение на использование VAS"},"limit":{"title":"limit","type":"number","format":"decimal","description":"Значение лимита"},"remainingBalance":{"title":"remaining_balance","type":"number","format":"decimal","description":"Остаток лимита"},"servicePackagesLimits":{"$ref":"#/components/schemas/AgentServicePackagesLimitsSchema"}},"required":["allowVas","servicePackagesLimits"]},"AgentPhoneResponseSchema":{"type":"object","properties":{"isConfirmed":{"title":"is_confirmed","type":"boolean","description":"Признак подтвержденности номера"},"isMain":{"title":"is_main","type":"boolean","description":"Признак основного номера"},"phone":{"title":"phone","type":"string","x-sensitiveData":"pdnContact","description":"Номер телефона"}},"required":["isConfirmed","isMain"]},"AgentResponseSchema":{"type":"object","properties":{"balance":{"$ref":"#/components/schemas/AgentBalanceResponseSchema"},"email":{"title":"email","type":"string","x-sensitiveData":"pdnContact","description":"Адрес email"},"firstName":{"title":"first_name","type":"string","x-sensitiveData":"pdnPublic","description":"Имя"},"lastName":{"title":"last_name","type":"string","x-sensitiveData":"pdnPublic","description":"Фамилия"},"limits":{"$ref":"#/components/schemas/AgentSpendLimitResponseSchema"},"phones":{"type":"array","items":{"$ref":"#/components/schemas/AgentPhoneResponseSchema"},"description":"Телефоны сотрудника"},"state":{"enum":["active","blocked","deleted","deletedAndHidden","processing","request"],"type":"string","x-request":"Отправлена заявка на добавление агента к агентству","x-active":"Активный агент","x-processing":"Агент в процессе активации/блокировки","x-blocked":"Заблокированный агент","x-deleted":"Удаленный агент","x-deletedAndHidden":"Удаленный агент","description":"\n\t\n `request`: Отправлена заявка на добавление агента к агентству\t\n `active`: Активный агент\t\n `processing`: Агент в процессе активации/блокировки\t\n `blocked`: Заблокированный агент\t\n `deleted`: Удаленный агент\t\n `deletedAndHidden`: Удаленный агент"},"userId":{"title":"user_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"Id пользователя"}},"required":["phones","state","userId"]},"AgentsListResponseSchema":{"type":"object","properties":{"agents":{"type":"array","items":{"$ref":"#/components/schemas/AgentResponseSchema"},"description":"Сотрудники"},"page":{"title":"page","type":"integer","format":"int64","description":"Номер страницы"},"pageSize":{"title":"page_size","type":"integer","format":"int64","description":"Размер страницы"},"pagesCount":{"title":"pages_count","type":"integer","format":"int64","description":"Количество страниц"},"totalCount":{"title":"total_count","type":"integer","format":"int64","description":"Общее количество сабегетов"}},"required":["agents","page","pageSize","pagesCount","totalCount"]},"AgentsListResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/AgentsListResponseSchema","description":"Результат"}},"required":["operationId","result"]},"AnnouncementInfoModelSchema":{"type":"object","properties":{"creationDate":{"title":"creation_date","type":"string","format":"date-time","description":"Дата создания объявления"},"id":{"title":"id","type":"integer","format":"int64","description":"Id объявления"},"source":{"enum":["manual","upload"],"type":"string","x-manual":"Ручное","x-upload":"Импорт","description":"\n\t\n `manual`: Ручное\t\n `upload`: Импорт"},"status":{"enum":["inactive","published","refusedByModerator","removedByModerator"],"type":"string","x-published":"Опубликован","x-inactive":"Неактивен","x-refusedByModerator":"Отклонен модератором","x-removedByModerator":"Удален модератором","description":"\n\t\n `published`: Опубликован\t\n `inactive`: Неактивен\t\n `refusedByModerator`: Отклонен модератором\t\n `removedByModerator`: Удален модератором"},"userId":{"title":"user_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"Id пользователя"}},"required":["creationDate","id","source","status","userId"]},"AnnouncementInfoResponseSchema":{"type":"object","properties":{"announcements":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementInfoModelSchema"},"description":"Объявления"}},"required":["announcements"]},"AnnouncementInfoResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/AnnouncementInfoResponseSchema","description":"Результат"}},"required":["operationId","result"]},"AnnouncementInfoV2ResponseSchema":{"type":"object","properties":{"announcements":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementInfoModelSchema"},"description":"Объявления"},"totalCount":{"title":"total_count","type":"integer","format":"int64","description":"Кол-во найденных по фильтру объявлений"}},"required":["announcements","totalCount"]},"AnnouncementInfoV2ResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/AnnouncementInfoV2ResponseSchema","description":"Результат"}},"required":["operationId","result"]},"PhotoSchema":{"type":"object","properties":{"miniUrl":{"title":"mini_url","type":"string","description":"URL превью"},"url":{"title":"url","type":"string","description":"URL оригинала"}}},"OfferSchema":{"type":"object","properties":{"externalId":{"title":"external_id","type":"string","description":"ID объекта в агентстве"},"id":{"title":"id","type":"integer","format":"int64","description":"ID объекта в Циане"},"url":{"title":"url","type":"string","description":"URL объекта в Циане"},"userId":{"title":"user_id","type":"integer","format":"int64","description":"ID владельца объявления"}},"required":["id","url","userId"]},"V1GetOffersInfoByIdsResponseSchema":{"type":"object","properties":{"offers":{"type":"array","items":{"$ref":"#/components/schemas/OfferSchema"},"description":"Список объявлений"}},"required":["offers"]},"V1GetOffersInfoByIdsResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/V1GetOffersInfoByIdsResponseSchema","description":"Результат"}},"required":["operationId","result"]},"LastOrderReportInfoResponseSchema":{"type":"object","properties":{"activeFeedUrls":{"title":"active_feed_urls","type":"array","items":{"title":"active_feed_urls","type":"string"},"x-sensitiveData":"pdnPublic","description":"URL-ы активных фидов по заказу"},"hasImagesProblems":{"title":"has_images_problems","type":"boolean","description":"Есть ли проблемы с фотографиями"},"hasOffersProblems":{"title":"has_offers_problems","type":"boolean","description":"Есть ли проблемы с объявлениями"},"lastFeedCheckDate":{"title":"last_feed_check_date","type":"string","format":"date-time","description":"Дата последней проверки"},"lastProcessDate":{"title":"last_process_date","type":"string","format":"date-time","description":"Дата последнего процессинга"},"orderId":{"title":"order_id","type":"integer","format":"int64","description":"Id заказа"}},"required":["activeFeedUrls","hasImagesProblems","hasOffersProblems","orderId"]},"LastOrderReportInfoResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/LastOrderReportInfoResponseSchema","description":"Результат"}},"required":["operationId","result"]},"AnnouncementReportItemResponseSchema":{"type":"object","properties":{"errors":{"title":"errors","type":"array","items":{"title":"errors","type":"string"},"description":"Список ошибок публикации объявления."},"externalId":{"title":"external_id","type":"string","description":"Внешний Id объявления."},"offerId":{"title":"offer_id","type":"integer","format":"int64","description":"Id объявления."},"status":{"enum":["Blocked","Deactivated","Deleted","Draft","Moderate","Published","Refused","RemovedByModerator","Sold"],"type":"string","x-Draft":"11 - Черновик","x-Published":"12 - Опубликовано","x-Deactivated":"14 - Деактивировано (ранее было скрыто Hidden)","x-Refused":"15 - Отклонено модератором","x-Deleted":"16 - Удалён","x-Sold":"17 - Продано/Сдано","x-Moderate":"18 - Требует модерации\r\nДанный статус исчез - оставим для совместимости","x-RemovedByModerator":"19 - Удалено модератором","x-Blocked":"20 - объявление снято с публикации по причине применения санкции \"приостановки публикации\"","description":"\n\t\n `Draft`: 11 - Черновик\t\n `Published`: 12 - Опубликовано\t\n `Deactivated`: 14 - Деактивировано (ранее было скрыто Hidden)\t\n `Refused`: 15 - Отклонено модератором\t\n `Deleted`: 16 - Удалён\t\n `Sold`: 17 - Продано/Сдано\t\n `Moderate`: 18 - Требует модерации\r\nДанный статус исчез - оставим для совместимости\t\n `RemovedByModerator`: 19 - Удалено модератором\t\n `Blocked`: 20 - объявление снято с публикации по причине применения санкции \"приостановки публикации\""},"url":{"title":"url","type":"string","description":"Ссылка на объявление."},"warnings":{"title":"warnings","type":"array","items":{"title":"warnings","type":"string"},"description":"Предупреждения при публикации объявления."}}},"UnloadReportResponseSchema":{"type":"object","properties":{"offers":{"type":"array","items":{"$ref":"#/components/schemas/AnnouncementReportItemResponseSchema"},"description":"Записи отчёта"}}},"UnloadReportResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/UnloadReportResponseSchema","description":"Результат"}},"required":["operationId","result"]},"ImageReportItemResponseSchema":{"type":"object","properties":{"errorText":{"title":"error_text","type":"string","description":"Текст ошибки"},"errorType":{"enum":["emptyResult","imageDuplicate","imageLimitExceeded","invalidOperation","notFound","notImage","notSupportedResolution","notSupportedSize","serverTimeout","timeout","unknownError"],"type":"string","x-imageLimitExceeded":"Превышен лимит на количество изображений","x-serverTimeout":"Сервер не ответил за отведенное время","x-invalidOperation":"InvalidOperationException","x-timeout":"Сервер не ответил за отведенное время","x-imageDuplicate":"Дубликат изображения","x-notSupportedResolution":"Неподдерживаемое разрешение","x-notFound":"Изображение не найдено","x-notImage":"Данные не являются изображением","x-emptyResult":"Пустой ответ от сервера","x-notSupportedSize":"Неподдерживаемый размер","x-unknownError":"Неизвестная ошибка","description":"\n\t\n `imageLimitExceeded`: Превышен лимит на количество изображений\t\n `serverTimeout`: Сервер не ответил за отведенное время\t\n `invalidOperation`: InvalidOperationException\t\n `timeout`: Сервер не ответил за отведенное время\t\n `imageDuplicate`: Дубликат изображения\t\n `notSupportedResolution`: Неподдерживаемое разрешение\t\n `notFound`: Изображение не найдено\t\n `notImage`: Данные не являются изображением\t\n `emptyResult`: Пустой ответ от сервера\t\n `notSupportedSize`: Неподдерживаемый размер\t\n `unknownError`: Неизвестная ошибка"},"offerId":{"title":"offer_id","type":"integer","format":"int64","description":"Id объявления"},"url":{"title":"url","type":"string","description":"URL изображения"}},"required":["offerId","url"]},"ImageReportResponseSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ImageReportItemResponseSchema"},"description":"Изображения"}},"required":["items"]},"ImageReportResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/ImageReportResponseSchema","description":"Результат"}},"required":["operationId","result"]},"OfferAddToFavoritesStatisticsByDaysSchema":{"type":"object","properties":{"addToFavorites":{"title":"add_to_favorites","type":"integer","format":"int64","description":"Количество добавлений в избранное за день"},"date":{"title":"date","type":"string","format":"date","description":"Дата"}},"required":["addToFavorites","date"]},"OfferCallsStatisticsByDaysSchema":{"type":"object","properties":{"calls":{"title":"calls","type":"integer","format":"int64","description":"Количество звонков за день"},"date":{"title":"date","type":"string","format":"date","description":"Дата"}},"required":["calls","date"]},"OfferChatsStatisticsByDaysSchema":{"type":"object","properties":{"chats":{"title":"chats","type":"integer","format":"int64","description":"Количество сообщений в чат за день"},"date":{"title":"date","type":"string","format":"date","description":"Дата"}},"required":["chats","date"]},"OfferPhoneShowsStatisticsByDaysSchema":{"type":"object","properties":{"date":{"title":"date","type":"string","format":"date","description":"Дата"},"phoneShows":{"title":"phone_shows","type":"integer","format":"int64","description":"Количество показов номера за день (сумма метрик phone_views и phone_views_and_chats)"}},"required":["date","phoneShows"]},"OfferPhoneViewsAndChatsStatisticsByDaysSchema":{"type":"object","properties":{"date":{"title":"date","type":"string","format":"date","description":"Дата"},"phoneViewsAndChats":{"title":"phone_views_and_chats","type":"integer","format":"int64","description":"Количество просмотров номера с сообщением в чат за день"}},"required":["date","phoneViewsAndChats"]},"OfferPhoneViewsStatisticsByDaysSchema":{"type":"object","properties":{"date":{"title":"date","type":"string","format":"date","description":"Дата"},"phoneViews":{"title":"phone_views","type":"integer","format":"int64","description":"Количество просмотров номера за день"}},"required":["date","phoneViews"]},"OfferResponsesStatisticsByDaysSchema":{"type":"object","properties":{"date":{"title":"date","type":"string","format":"date","description":"Дата"},"responses":{"title":"responses","type":"integer","format":"int64","description":"Количество откликов за день (сумма метрик phone_views, phone_views_and_chats, chats)"}},"required":["date","responses"]},"OfferShowsStatisticsByDaysSchema":{"type":"object","properties":{"date":{"title":"date","type":"string","format":"date","description":"Дата"},"shows":{"title":"shows","type":"integer","format":"int64","description":"Количество показов за день"},"showsBase":{"title":"shows_base","type":"integer","format":"int64","description":"Количество базовых показов за день"},"showsFromPromotion":{"title":"shows_from_promotion","type":"integer","format":"int64","description":"Количество показов от продвижения за день"}},"required":["date","shows","showsBase","showsFromPromotion"]},"OfferViewsStatisticsByDaysSchema":{"type":"object","properties":{"date":{"title":"date","type":"string","format":"date","description":"Дата"},"views":{"title":"views","type":"integer","format":"int64","description":"Количество просмотров объявления за день"}},"required":["date","views"]},"V1GetOfferStatisticsByDaysResponseSchema":{"type":"object","properties":{"addToFavoritesByDays":{"type":"array","items":{"$ref":"#/components/schemas/OfferAddToFavoritesStatisticsByDaysSchema"},"description":"Статистика добавлений в избранное по дням"},"callsByDays":{"type":"array","items":{"$ref":"#/components/schemas/OfferCallsStatisticsByDaysSchema"},"description":"Статистика звонков по дням"},"chatsByDays":{"type":"array","items":{"$ref":"#/components/schemas/OfferChatsStatisticsByDaysSchema"},"description":"Статистика сообщений в чат по дням"},"offerId":{"title":"offer_id","type":"integer","format":"int64","description":"ID объявления"},"phoneShowsByDays":{"type":"array","items":{"$ref":"#/components/schemas/OfferPhoneShowsStatisticsByDaysSchema"},"description":"Статистика показов номера по дням (сумма метрик phone_views и phone_views_and_chats)"},"phoneViewsAndChatsByDays":{"type":"array","items":{"$ref":"#/components/schemas/OfferPhoneViewsAndChatsStatisticsByDaysSchema"},"description":"Статистика просмотров номера с сообщением в чат по дням"},"phoneViewsByDays":{"type":"array","items":{"$ref":"#/components/schemas/OfferPhoneViewsStatisticsByDaysSchema"},"description":"Статистика просмотров номера по дням"},"responsesByDays":{"type":"array","items":{"$ref":"#/components/schemas/OfferResponsesStatisticsByDaysSchema"},"description":"Статистика откликов по дням (сумма метрик phone_views, phone_views_and_chats, chats)"},"showsByDays":{"type":"array","items":{"$ref":"#/components/schemas/OfferShowsStatisticsByDaysSchema"},"description":"Статистика показов объявления по дням"},"viewsByDays":{"type":"array","items":{"$ref":"#/components/schemas/OfferViewsStatisticsByDaysSchema"},"description":"Статистика просмотров объявления по дням"}},"required":["addToFavoritesByDays","callsByDays","chatsByDays","offerId","phoneShowsByDays","phoneViewsAndChatsByDays","phoneViewsByDays","responsesByDays","showsByDays","viewsByDays"]},"V1GetOfferStatisticsByDaysResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/V1GetOfferStatisticsByDaysResponseSchema","description":"Результат"}},"required":["operationId","result"]},"OffersStatisticsSchema":{"type":"object","properties":{"addToFavorites":{"title":"add_to_favorites","type":"integer","format":"int64","description":"Количество добавлений в избранное за все время"},"calls":{"title":"calls","type":"integer","format":"int64","description":"Количество звонков за все время"},"chats":{"title":"chats","type":"integer","format":"int64","description":"Количество сообщений в чат за все время"},"offerId":{"title":"offer_id","type":"integer","format":"int64","description":"ID объявления"},"phoneShows":{"title":"phone_shows","type":"integer","format":"int64","description":"Количество показов номера за все время (сумма метрик phone_views и phone_views_and_chats)"},"phoneViews":{"title":"phone_views","type":"integer","format":"int64","description":"Количество просмотров номера за все время"},"phoneViewsAndChats":{"title":"phone_views_and_chats","type":"integer","format":"int64","description":"Количество просмотров номера с сообщением в чат за все время"},"responses":{"title":"responses","type":"integer","format":"int64","description":"Количество откликов за все время (сумма метрик phone_views и phone_views_and_chats и chats)"},"showsBase":{"title":"shows_base","type":"integer","format":"int64","description":"Количество базовых показов за все время"},"showsFromPromotion":{"title":"shows_from_promotion","type":"integer","format":"int64","description":"Количество показов от продвижения за все время"},"totalShows":{"title":"total_shows","type":"integer","format":"int64","description":"Количество показов за все время"},"totalViews":{"title":"total_views","type":"integer","format":"int64","description":"Количество просмотров объявления за все время"}},"required":["addToFavorites","calls","chats","offerId","phoneShows","phoneViews","phoneViewsAndChats","responses","showsBase","showsFromPromotion","totalShows","totalViews"]},"V1GetOffersStatisticsResponseSchema":{"type":"object","properties":{"statistics":{"type":"array","items":{"$ref":"#/components/schemas/OffersStatisticsSchema"},"description":"Статистика по объявлениям за все время"}},"required":["statistics"]},"V1GetOffersStatisticsResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/V1GetOffersStatisticsResponseSchema","description":"Результат"}},"required":["operationId","result"]},"CallForAgencySchema":{"type":"object","properties":{"callId":{"title":"call_id","type":"integer","format":"int64","description":"ID звонка"},"calltrackingPhone":{"title":"calltracking_phone","type":"string","x-sensitiveData":"pdnContact","description":"Подменный номер"},"date":{"title":"date","type":"string","format":"date","description":"Дата звонка"},"datetime":{"title":"datetime","type":"string","format":"date-time","description":"Дата и время звонка"},"destinationPhone":{"title":"destination_phone","type":"string","x-sensitiveData":"pdnContact","description":"Входящий номер"},"duration":{"title":"duration","type":"integer","format":"int64","description":"Продолжительность в секундах"},"employerId":{"title":"employer_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"ID сотрудника"},"sourcePhone":{"title":"source_phone","type":"string","x-sensitiveData":"pdnContact","description":"Исходящий номер"},"status":{"enum":["busy","hgup","noAnswer","success","techProblem","turnedOff","unknown"],"type":"string","x-success":"Успешный","x-busy":"Занято","x-hgup":"Сбросили","x-turnedOff":"Выключен","x-noAnswer":"Без ответа","x-unknown":"Неизвестно","x-techProblem":"Техническая ошибка","description":"\n\t\n `success`: Успешный\t\n `busy`: Занято\t\n `hgup`: Сбросили\t\n `turnedOff`: Выключен\t\n `noAnswer`: Без ответа\t\n `unknown`: Неизвестно\t\n `techProblem`: Техническая ошибка"}},"required":["callId","calltrackingPhone","date","datetime","destinationPhone","duration","employerId","sourcePhone","status"]},"GetCallsReportForAgencyResponseSchema":{"type":"object","properties":{"calls":{"type":"array","items":{"$ref":"#/components/schemas/CallForAgencySchema"},"description":"Звонки"},"totalCount":{"title":"total_count","type":"integer","format":"int64","description":"Количество звонков"}},"required":["calls","totalCount"]},"GetCallsReportForAgencyResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/GetCallsReportForAgencyResponseSchema","description":"Результат"}},"required":["operationId","result"]},"CallOfferSchema":{"type":"object","properties":{"externalId":{"title":"external_id","type":"string","description":"ID объявления в вашей системе"},"id":{"title":"id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"ID объявления на Циан"},"url":{"title":"url","type":"string","description":"Ссылка на страницу опубликованного объявления"}},"required":["id"]},"CallForAgencyV2Schema":{"type":"object","properties":{"callId":{"title":"call_id","type":"integer","format":"int64","description":"ID звонка"},"calltrackingPhone":{"title":"calltracking_phone","type":"string","x-sensitiveData":"pdnContact","description":"Подменный номер"},"date":{"title":"date","type":"string","format":"date","description":"Дата звонка"},"datetime":{"title":"datetime","type":"string","format":"date-time","description":"Дата и время звонка"},"destinationPhone":{"title":"destination_phone","type":"string","x-sensitiveData":"pdnContact","description":"Входящий номер"},"duration":{"title":"duration","type":"integer","format":"int64","description":"Продолжительность в секундах"},"employeeId":{"title":"employee_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"ID сотрудника"},"offer":{"$ref":"#/components/schemas/CallOfferSchema","description":"Объект объявления по звонку"},"sourcePhone":{"title":"source_phone","type":"string","x-sensitiveData":"pdnContact","description":"Исходящий номер"},"status":{"enum":["busy","hgup","noAnswer","success","techProblem","turnedOff","unknown"],"type":"string","x-success":"Успешный","x-busy":"Занято","x-hgup":"Сбросили","x-turnedOff":"Выключен","x-noAnswer":"Без ответа","x-unknown":"Неизвестно","x-techProblem":"Техническая ошибка","description":"\n\t\n `success`: Успешный\t\n `busy`: Занято\t\n `hgup`: Сбросили\t\n `turnedOff`: Выключен\t\n `noAnswer`: Без ответа\t\n `unknown`: Неизвестно\t\n `techProblem`: Техническая ошибка"}},"required":["callId","calltrackingPhone","date","datetime","destinationPhone","duration","employeeId","sourcePhone","status"]},"GetCallsReportForAgencyResponseV2Schema":{"type":"object","properties":{"calls":{"type":"array","items":{"$ref":"#/components/schemas/CallForAgencyV2Schema"},"description":"Звонки"},"totalCount":{"title":"total_count","type":"integer","format":"int64","description":"Количество звонков"}},"required":["calls","totalCount"]},"GetCallsReportForAgencyResponseV2SchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/GetCallsReportForAgencyResponseV2Schema","description":"Результат"}},"required":["operationId","result"]},"EmptyResponseSchema":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"}},"required":["operationId"]},"GetModerationComplaintResponseItemSchema":{"type":"object","properties":{"creationDate":{"title":"creation_date","type":"string","format":"date-time","description":"Дата создания"},"id":{"title":"id","type":"integer","format":"int64","description":"Id жалобы"},"offerId":{"title":"offer_id","type":"integer","format":"int64","description":"Id объявления"},"text":{"title":"text","type":"string","x-sensitiveData":"pdn","description":"Текст жалобы. Содержит Html"},"userId":{"title":"user_id","type":"integer","format":"int64","description":"Id пользователя"}},"required":["creationDate","id","offerId","userId"]},"GetModerationComplaintResponseSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/GetModerationComplaintResponseItemSchema"},"description":"Жалобы"},"totalCount":{"title":"total_count","type":"integer","format":"int64","description":"Общее количество"}},"required":["totalCount"]},"GetModerationComplaintResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/GetModerationComplaintResponseSchema","description":"Результат"}},"required":["operationId","result"]},"NotActualAnnouncementModelSchema":{"type":"object","properties":{"checkGuid":{"title":"check_guid","type":"string","format":"uuid","description":"Guid проверки на актуальность"},"notActualDate":{"title":"not_actual_date","type":"string","format":"date-time","description":"Дата, когда объявление станет неактуальным и будет автоматически снято с публикации"},"objectId":{"title":"object_id","type":"integer","format":"int64","description":"Id объявления"}},"required":["checkGuid","notActualDate","objectId"]},"GetNotActualAnnouncementsByMasterUserIdResponseSchema":{"type":"object","properties":{"confirmationRequired":{"type":"array","items":{"$ref":"#/components/schemas/NotActualAnnouncementModelSchema"},"description":"Список объявлений, которые ожидают подтверждения"}},"required":["confirmationRequired"]},"GetNotActualAnnouncementsByMasterUserIdResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/GetNotActualAnnouncementsByMasterUserIdResponseSchema","description":"Результат"}},"required":["operationId","result"]},"UserNotificationsApiItemSchema":{"type":"object","properties":{"date":{"title":"date","type":"string","format":"date-time","description":"Дата отправки"},"id":{"title":"id","type":"integer","format":"int64","description":"Id уведомления"},"isRead":{"title":"is_read","type":"boolean","description":"Сообщение прочитано"},"severityLevel":{"enum":["error","neutral","positive","warning"],"type":"string","x-neutral":"Нейтральный","x-positive":"Положительный","x-warning":"Предупреждение","x-error":"Ошибка","description":"\n\t\n `neutral`: Нейтральный\t\n `positive`: Положительный\t\n `warning`: Предупреждение\t\n `error`: Ошибка"},"text":{"title":"text","type":"string","description":"Текст сообщения. Содержит Html."},"type":{"enum":["marketing","moderation","service"],"type":"string","x-service":"Сервисное","x-marketing":"Маркетинговое","x-moderation":"Модерационное","description":"\n\t\n `service`: Сервисное\t\n `marketing`: Маркетинговое\t\n `moderation`: Модерационное"}},"required":["date","id","isRead","text","type"]},"GetUserNotificationsApiResponseSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationsApiItemSchema"},"description":"Уведомления"},"totalCount":{"title":"total_count","type":"integer","format":"int64","description":"Общее количество"}},"required":["items","totalCount"]},"GetUserNotificationsApiResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/GetUserNotificationsApiResponseSchema","description":"Результат"}},"required":["operationId","result"]},"GetUserUnreadNotificationsCountResponseSchema":{"type":"object","properties":{"totalCount":{"title":"total_count","type":"integer","format":"int64","description":"Общее количество непрочитанных актуальных уведомлений"}},"required":["totalCount"]},"GetUserUnreadNotificationsCountResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/GetUserUnreadNotificationsCountResponseSchema","description":"Результат"}},"required":["operationId","result"]},"MarkAllNotificationsAsReadRequestV2Schema":{"type":"object","properties":{"employeeId":{"title":"employee_id","type":"integer","format":"int64","description":"Id пользователя сотрудника агентства"}}},"BtiDataSchema":{"type":"object","properties":{"ceilingHeight":{"title":"ceiling_height","type":"number","format":"double","description":"Высота потолков"},"chuteCount":{"title":"chute_count","type":"integer","format":"int64","description":"Количество мусоропроводов"},"entrances":{"title":"entrances","type":"integer","format":"int64","description":"Число подъездов"},"flatCount":{"title":"flat_count","type":"integer","format":"int64","description":"Число квартир"},"floorMax":{"title":"floor_max","type":"integer","format":"int64","description":"Этажность"},"hasPlayground":{"title":"has_playground","type":"boolean","description":"Наличие детской площадки"},"hasSportsground":{"title":"has_sportsground","type":"boolean","description":"Наличие спортивной площадки"},"houseGasSupplyType":{"enum":["autonomous","central","unknown","without"],"type":"string","x-autonomous":"Автономное","x-central":"Центральное","x-unknown":"Не известно","x-without":"Отсутствует","description":"\n\t\n `autonomous`: Автономное\t\n `central`: Центральное\t\n `unknown`: Не известно\t\n `without`: Отсутствует"},"houseHeatSupplyType":{"enum":["autonomous","autonomousBoiler","autonomousGas","boiler","central","coal","diesel","electric","fireplace","gas","gasWaterHeater","has","itp","none","other","solidFuelBoiler","stove","without"],"type":"string","x-autonomous":"Автономное","x-autonomousBoiler":"Автономная котельная (крышная, встроенно-пристроенная)","x-autonomousGas":"Автономное газовое","x-boiler":"Котел | Квартирное (квартирный котел)","x-central":"Центральное","x-coal":"Центральное угольное","x-diesel":"Дизельное","x-electric":"Электрическое","x-fireplace":"Камин","x-gas":"Центральное газовое","x-gasWaterHeater":"Газовый водонагреватель","x-has":"Есть","x-itp":"Индивидуальный тепловой пункт (ИТП)","x-none":"Не указано","x-other":"Другое","x-solidFuelBoiler":"Твердотопливный котел","x-stove":"Печь","x-without":"Нет(без отопления)","description":"\n\t\n `autonomous`: Автономное\t\n `autonomousBoiler`: Автономная котельная (крышная, встроенно-пристроенная)\t\n `autonomousGas`: Автономное газовое\t\n `boiler`: Котел | Квартирное (квартирный котел)\t\n `central`: Центральное\t\n `coal`: Центральное угольное\t\n `diesel`: Дизельное\t\n `electric`: Электрическое\t\n `fireplace`: Камин\t\n `gas`: Центральное газовое\t\n `gasWaterHeater`: Газовый водонагреватель\t\n `has`: Есть\t\n `itp`: Индивидуальный тепловой пункт (ИТП)\t\n `none`: Не указано\t\n `other`: Другое\t\n `solidFuelBoiler`: Твердотопливный котел\t\n `stove`: Печь\t\n `without`: Нет(без отопления)"},"houseMaterialType":{"enum":["aerocreteBlock","block","boards","brick","custom","foamConcreteBlock","gasSilicateBlock","monolith","monolithBrick","none","old","panel","stalin","wireframe","wood"],"type":"string","x-aerocreteBlock":"Газобетонный блок","x-block":"Блочный","x-boards":"Щитовой","x-brick":"Кирпичный","x-custom":"Другое","x-foamConcreteBlock":"Пенобетонный блок","x-gasSilicateBlock":"Газосиликатный блок","x-monolith":"Монолитный","x-monolithBrick":"Монолитно кирпичный","x-none":"Не указано","x-old":"Старый фонд","x-panel":"Панельный","x-stalin":"Сталинский","x-wireframe":"Каркасный","x-wood":"Деревянный","description":"\n\t\n `aerocreteBlock`: Газобетонный блок\t\n `block`: Блочный\t\n `boards`: Щитовой\t\n `brick`: Кирпичный\t\n `custom`: Другое\t\n `foamConcreteBlock`: Пенобетонный блок\t\n `gasSilicateBlock`: Газосиликатный блок\t\n `monolith`: Монолитный\t\n `monolithBrick`: Монолитно кирпичный\t\n `none`: Не указано\t\n `old`: Старый фонд\t\n `panel`: Панельный\t\n `stalin`: Сталинский\t\n `wireframe`: Каркасный\t\n `wood`: Деревянный"},"houseOverhaulFundType":{"enum":["regionalOp","specialOrg","specialRegionalOp","undefined","unknown"],"type":"string","x-regionalOp":"На счете регионального оператора","x-specialOrg":"На специальном счете организации","x-specialRegionalOp":"На специальном счете у регионального оператора","x-undefined":"Не определён","x-unknown":"Не известно","description":"\n\t\n `regionalOp`: На счете регионального оператора\t\n `specialOrg`: На специальном счете организации\t\n `specialRegionalOp`: На специальном счете у регионального оператора\t\n `undefined`: Не определён\t\n `unknown`: Не известно"},"houseOverlapType":{"enum":["concrete","mixed","other","unknown","wood"],"type":"string","x-concrete":"Железобетонные","x-mixed":"Смешанные","x-other":"Другие","x-unknown":"Не известно","x-wood":"Деревянные","description":"\n\t\n `concrete`: Железобетонные\t\n `mixed`: Смешанные\t\n `other`: Другие\t\n `unknown`: Не известно\t\n `wood`: Деревянные"},"isEmergency":{"title":"is_emergency","type":"boolean","description":"Признан аварийным"},"lifts":{"title":"lifts","type":"integer","format":"int64","description":"Количество лифтов"},"yearRelease":{"title":"year_release","type":"integer","format":"int64","description":"Год постройки"}}},"SaleRoomsStatSchema":{"type":"object","properties":{"priceSqm":{"title":"price_sqm","type":"number","format":"double","description":"Прогнозируемая цена кв. м. (средняя)"},"priceSqmMax":{"title":"price_sqm_max","type":"number","format":"double","description":"Прогнозируемая цена кв. м. (максимальная)"},"priceSqmMin":{"title":"price_sqm_min","type":"number","format":"double","description":"Прогнозируемая цена кв. м. (минимальная)"},"roomsCount":{"title":"rooms_count","type":"integer","format":"int64","description":"Количество комнат"}}},"EstimationByRoomSchema":{"type":"object","properties":{"roomsStats":{"type":"array","items":{"$ref":"#/components/schemas/SaleRoomsStatSchema"},"description":"Массив статистических данных для квартир в соответствии с их комнатностью"}},"required":["roomsStats"]},"GetEstimationAndBtiResponseSchema":{"type":"object","properties":{"btiData":{"$ref":"#/components/schemas/BtiDataSchema","description":"Данные БТИ"},"estimationByRoom":{"$ref":"#/components/schemas/EstimationByRoomSchema","description":"Оценка в разрезе комнатности"}}},"GetEstimationAndBtiResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/GetEstimationAndBtiResponseSchema","description":"Результат"}},"required":["operationId","result"]},"MessageFileSchema":{"type":"object","properties":{"fileId":{"title":"file_id","type":"string","description":"ID файла"},"mimeType":{"title":"mime_type","type":"string","description":"MIME тип файла"},"name":{"title":"name","type":"string","description":"Имя файла"}},"required":["fileId","name"]},"OfferInMessageSchema":{"type":"object","properties":{"formattedAddress":{"title":"formatted_address","type":"string","x-sensitiveData":"pdnClient","description":"\n Метро, улица с домом, населенный пункт, дом (если нет улицы), потом район, область.\n Виды субъектов сокращаются в написании:\n Республика — респ., Край — край, Автономная область — а. обл., Автономный округ — а. окр., Область — обл.\n "},"formattedInfo":{"title":"formatted_info","type":"string","description":"Строка с прочей информацией об объявлении"},"formattedPrice":{"title":"formatted_price","type":"string","description":"Строка с ценой объявления"},"photoUrls":{"title":"photo_urls","type":"array","items":{"title":"photo_urls","type":"string"},"description":"Фотографии объявления"},"realtyOfferId":{"title":"realty_offer_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"Идентификатор объявления в Базе Данных Microsoft SQL Server Realty"},"url":{"title":"url","type":"string","description":"Ссылка вида https://www.cian.ru/deal_type/offer_type/offer_id/"}},"required":["formattedAddress","formattedInfo","formattedPrice","photoUrls","realtyOfferId","url"]},"AgentChatMessageContentSchema":{"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/MessageFileSchema"},"description":"Файлы"},"offers":{"type":"array","items":{"$ref":"#/components/schemas/OfferInMessageSchema"},"description":"Объявления в сообщении"},"text":{"title":"text","type":"string","x-sensitiveData":"pdn","description":"Текстовые данные сообщения"}}},"AgentChatMessageSchema":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/AgentChatMessageContentSchema"},"createdAt":{"title":"created_at","type":"string","format":"date-time","description":"Время создания сообщения"},"direction":{"enum":["in","out"],"type":"string","x-in":"Входящее","x-out":"Исходящее","description":"\n\t\n `in`: Входящее\t\n `out`: Исходящее"},"messageId":{"title":"message_id","type":"string","description":"ID сообщения"},"userId":{"title":"user_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"ID автора сообщения"},"userRole":{"enum":["companion","initiator","master","opponent"],"type":"string","x-initiator":"Клиент, который проявил интерес к бизнес-предложению (откликнулся по объявлению, оставил заявку)","x-opponent":"То, кто реагирует на интерес initiator (публикует объявление, получает заявку)","x-master":"\n В случае агентств недвижимости — руководитель opponent (может добавиться в чат, где уже есть initiator и opponent)\n ","x-companion":"Все остальные возможные участники чата (в том числе чат-боты)","description":"\n\t\n `initiator`: Клиент, который проявил интерес к бизнес-предложению (откликнулся по объявлению, оставил заявку)\t\n `opponent`: То, кто реагирует на интерес initiator (публикует объявление, получает заявку)\t\n `master`: \n В случае агентств недвижимости — руководитель opponent (может добавиться в чат, где уже есть initiator и opponent)\n \t\n `companion`: Все остальные возможные участники чата (в том числе чат-боты)"}},"required":["content","createdAt","direction","messageId","userId","userRole"]},"AgentChatSchema":{"type":"object","properties":{"chatId":{"title":"chat_id","type":"integer","format":"int64","description":"ID чата"},"createdAt":{"title":"created_at","type":"string","format":"date-time","description":"Время создания чата"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/AgentChatMessageSchema"},"description":"Сообщения в чате"},"updatedAt":{"title":"updated_at","type":"string","format":"date-time","description":"Время последнего обновления в чате"}},"required":["chatId","createdAt","messages","updatedAt"]},"ImagesSchema":{"type":"object","properties":{"big":{"title":"big","type":"string","description":"260x260px"},"small":{"title":"small","type":"string","description":"44х44px"}}},"AvatarSchema":{"type":"object","properties":{"images":{"$ref":"#/components/schemas/AvatarImagesSchema"}},"required":["images"]},"UserSchema":{"type":"object","properties":{"avatar":{"$ref":"#/components/schemas/AvatarSchema"},"firstName":{"title":"first_name","type":"string","x-sensitiveData":"pdnPublic","description":"Имя"},"lastName":{"title":"last_name","type":"string","x-sensitiveData":"pdnPublic","description":"Фамилия"},"name":{"title":"name","type":"string","x-sensitiveData":"pdnPublic","description":"Полное имя"},"userId":{"title":"user_id","type":"integer","format":"int64","description":"ID пользователя"}},"required":["avatar","userId"]},"AgentMessagesWebhookSchema":{"type":"object","properties":{"chats":{"type":"array","items":{"$ref":"#/components/schemas/AgentChatSchema"},"description":"Чаты"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserSchema"},"x-sensitiveData":"pdnPublic","description":"Пользователи"},"webhookType":{"enum":["agentMessages","chatsReadability","inquiryOffersMessages","newbuildingMessages","offersMessages","systemMessages"],"type":"string","x-offersMessages":"Веб-хук о новых сообщениях по объявлениям","x-systemMessages":"Веб-хук о новых системных сообщениях","x-chatsReadability":"Веб-хук о прочитанности чатов","x-newbuildingMessages":"Веб-хук о новых сообщениях по новостройкам","x-agentMessages":"Веб-хук о новых сообщениях в чатах между пользователями","x-inquiryOffersMessages":"Веб-хук о новых сообщениях по объявлениям, не принадлежащим пользователю","description":"\n\t\n `offersMessages`: Веб-хук о новых сообщениях по объявлениям\t\n `systemMessages`: Веб-хук о новых системных сообщениях\t\n `chatsReadability`: Веб-хук о прочитанности чатов\t\n `newbuildingMessages`: Веб-хук о новых сообщениях по новостройкам\t\n `agentMessages`: Веб-хук о новых сообщениях в чатах между пользователями\t\n `inquiryOffersMessages`: Веб-хук о новых сообщениях по объявлениям, не принадлежащим пользователю"}},"required":["chats","users","webhookType"]},"ReadabilityChatSchema":{"type":"object","properties":{"agentUserId":{"title":"agent_user_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"ID агента"},"chatId":{"title":"chat_id","type":"integer","format":"int64","description":"ID чата"},"readAt":{"title":"read_at","type":"string","format":"date-time","description":"Время прочтения чата"},"userId":{"title":"user_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"ID участника чата"}},"required":["agentUserId","chatId","readAt","userId"]},"V3ChatsReadabilityWebhookSchema":{"type":"object","properties":{"chats":{"type":"array","items":{"$ref":"#/components/schemas/ReadabilityChatSchema"},"description":"Чаты"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserSchema"},"x-sensitiveData":"pdnPublic","description":"Пользователи"},"webhookType":{"enum":["agentMessages","chatsReadability","inquiryOffersMessages","newbuildingMessages","offersMessages","systemMessages"],"type":"string","x-offersMessages":"Веб-хук о новых сообщениях по объявлениям","x-systemMessages":"Веб-хук о новых системных сообщениях","x-chatsReadability":"Веб-хук о прочитанности чатов","x-newbuildingMessages":"Веб-хук о новых сообщениях по новостройкам","x-agentMessages":"Веб-хук о новых сообщениях в чатах между пользователями","x-inquiryOffersMessages":"Веб-хук о новых сообщениях по объявлениям, не принадлежащим пользователю","description":"\n\t\n `offersMessages`: Веб-хук о новых сообщениях по объявлениям\t\n `systemMessages`: Веб-хук о новых системных сообщениях\t\n `chatsReadability`: Веб-хук о прочитанности чатов\t\n `newbuildingMessages`: Веб-хук о новых сообщениях по новостройкам\t\n `agentMessages`: Веб-хук о новых сообщениях в чатах между пользователями\t\n `inquiryOffersMessages`: Веб-хук о новых сообщениях по объявлениям, не принадлежащим пользователю"}},"required":["chats","users","webhookType"]},"InquiryOffersChatMessageContentSchema":{"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/MessageFileSchema"},"description":"Файлы"},"offers":{"type":"array","items":{"$ref":"#/components/schemas/OfferInMessageSchema"},"description":"Объявления в сообщении"},"text":{"title":"text","type":"string","x-sensitiveData":"pdn","description":"Текстовые данные сообщения"}}},"InquiryOffersChatMessageSchema":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/InquiryOffersChatMessageContentSchema"},"createdAt":{"title":"created_at","type":"string","format":"date-time","description":"Время создания сообщения"},"direction":{"enum":["in","out"],"type":"string","x-in":"Входящее","x-out":"Исходящее","description":"\n\t\n `in`: Входящее\t\n `out`: Исходящее"},"messageId":{"title":"message_id","type":"string","description":"ID сообщения"},"userId":{"title":"user_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"ID автора сообщения"},"userRole":{"enum":["companion","initiator","master","opponent"],"type":"string","x-initiator":"Клиент, который проявил интерес к бизнес-предложению (откликнулся по объявлению, оставил заявку)","x-opponent":"То, кто реагирует на интерес initiator (публикует объявление, получает заявку)","x-master":"\n В случае агентств недвижимости — руководитель opponent (может добавиться в чат, где уже есть initiator и opponent)\n ","x-companion":"Все остальные возможные участники чата (в том числе чат-боты)","description":"\n\t\n `initiator`: Клиент, который проявил интерес к бизнес-предложению (откликнулся по объявлению, оставил заявку)\t\n `opponent`: То, кто реагирует на интерес initiator (публикует объявление, получает заявку)\t\n `master`: \n В случае агентств недвижимости — руководитель opponent (может добавиться в чат, где уже есть initiator и opponent)\n \t\n `companion`: Все остальные возможные участники чата (в том числе чат-боты)"}},"required":["content","createdAt","direction","messageId","userId","userRole"]},"InquiryOffersChatSchema":{"type":"object","properties":{"chatId":{"title":"chat_id","type":"integer","format":"int64","description":"ID чата"},"createdAt":{"title":"created_at","type":"string","format":"date-time","description":"Время создания чата"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/InquiryOffersChatMessageSchema"},"description":"Сообщения в чате"},"offerId":{"title":"offer_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"ID объявления"},"updatedAt":{"title":"updated_at","type":"string","format":"date-time","description":"Время последнего обновления в чате"}},"required":["chatId","createdAt","messages","offerId","updatedAt"]},"OffersMessageOfferSchema":{"type":"object","properties":{"address":{"title":"address","type":"string","x-sensitiveData":"pdnClient","description":"Полный адрес"},"externalId":{"title":"external_id","type":"string","description":"Внешний ID объявления"},"id":{"title":"id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"ID объявления"},"mainPhoto":{"$ref":"#/components/schemas/PhotoSchema","description":"Главное фото объекта"},"price":{"title":"price","type":"string","description":"Цена"},"publishedUserId":{"title":"published_user_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"ID агента"},"title":{"title":"title","type":"string","description":"Заголовок объявления"},"url":{"title":"url","type":"string","description":"Ссылка на карточку объявления"},"userId":{"title":"user_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"ID получателя сообщений по объявлению"}},"required":["id","userId"]},"InquiryOffersMessagesWebhookSchema":{"type":"object","properties":{"chats":{"type":"array","items":{"$ref":"#/components/schemas/InquiryOffersChatSchema"},"description":"Чаты"},"offers":{"type":"array","items":{"$ref":"#/components/schemas/OffersMessageOfferSchema"},"description":"Объявления"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserSchema"},"x-sensitiveData":"pdnPublic","description":"Пользователи"},"webhookType":{"enum":["agentMessages","chatsReadability","inquiryOffersMessages","newbuildingMessages","offersMessages","systemMessages"],"type":"string","x-offersMessages":"Веб-хук о новых сообщениях по объявлениям","x-systemMessages":"Веб-хук о новых системных сообщениях","x-chatsReadability":"Веб-хук о прочитанности чатов","x-newbuildingMessages":"Веб-хук о новых сообщениях по новостройкам","x-agentMessages":"Веб-хук о новых сообщениях в чатах между пользователями","x-inquiryOffersMessages":"Веб-хук о новых сообщениях по объявлениям, не принадлежащим пользователю","description":"\n\t\n `offersMessages`: Веб-хук о новых сообщениях по объявлениям\t\n `systemMessages`: Веб-хук о новых системных сообщениях\t\n `chatsReadability`: Веб-хук о прочитанности чатов\t\n `newbuildingMessages`: Веб-хук о новых сообщениях по новостройкам\t\n `agentMessages`: Веб-хук о новых сообщениях в чатах между пользователями\t\n `inquiryOffersMessages`: Веб-хук о новых сообщениях по объявлениям, не принадлежащим пользователю"}},"required":["chats","offers","users","webhookType"]},"NewbuildingChatMessageContentSchema":{"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/MessageFileSchema"},"description":"Файлы"},"text":{"title":"text","type":"string","x-sensitiveData":"pdn","description":"Текстовые данные сообщения"}}},"NewbuildingChatMessageSchema":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/NewbuildingChatMessageContentSchema"},"createdAt":{"title":"created_at","type":"string","format":"date-time","description":"Время создания сообщения"},"direction":{"enum":["in","out"],"type":"string","x-in":"Входящее","x-out":"Исходящее","description":"\n\t\n `in`: Входящее\t\n `out`: Исходящее"},"messageId":{"title":"message_id","type":"string","description":"ID сообщения"},"userId":{"title":"user_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"ID автора сообщения"},"userRole":{"enum":["companion","initiator","master","opponent"],"type":"string","x-initiator":"Клиент, который проявил интерес к бизнес-предложению (откликнулся по объявлению, оставил заявку)","x-opponent":"То, кто реагирует на интерес initiator (публикует объявление, получает заявку)","x-master":"\n В случае агентств недвижимости — руководитель opponent (может добавиться в чат, где уже есть initiator и opponent)\n ","x-companion":"Все остальные возможные участники чата (в том числе чат-боты)","description":"\n\t\n `initiator`: Клиент, который проявил интерес к бизнес-предложению (откликнулся по объявлению, оставил заявку)\t\n `opponent`: То, кто реагирует на интерес initiator (публикует объявление, получает заявку)\t\n `master`: \n В случае агентств недвижимости — руководитель opponent (может добавиться в чат, где уже есть initiator и opponent)\n \t\n `companion`: Все остальные возможные участники чата (в том числе чат-боты)"}},"required":["content","createdAt","direction","messageId","userId","userRole"]},"NewbuildingChatSchema":{"type":"object","properties":{"chatId":{"title":"chat_id","type":"integer","format":"int64","description":"ID чата"},"createdAt":{"title":"created_at","type":"string","format":"date-time","description":"Время создания чата"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/NewbuildingChatMessageSchema"},"description":"Сообщения в чате"},"newbuildingId":{"title":"newbuilding_id","type":"integer","format":"int64","description":"ID новостройки"},"updatedAt":{"title":"updated_at","type":"string","format":"date-time","description":"Время последнего обновления в чате"}},"required":["chatId","createdAt","messages","newbuildingId","updatedAt"]},"NewbuildingSchema":{"type":"object","properties":{"address":{"title":"address","type":"string","x-sensitiveData":"pdnClient","description":"Адрес новостройки"},"id":{"title":"id","type":"integer","format":"int64","description":"ID новостройки"},"name":{"title":"name","type":"string","description":"Название новостройки"},"url":{"title":"url","type":"string","description":"URL новостройки"}},"required":["address","id","name","url"]},"V3NewbuildingMessagesWebhookSchema":{"type":"object","properties":{"chats":{"type":"array","items":{"$ref":"#/components/schemas/NewbuildingChatSchema"},"description":"Чаты"},"newbuildings":{"type":"array","items":{"$ref":"#/components/schemas/NewbuildingSchema"},"description":"Новостройки"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserSchema"},"x-sensitiveData":"pdnPublic","description":"Пользователи"},"webhookType":{"enum":["agentMessages","chatsReadability","inquiryOffersMessages","newbuildingMessages","offersMessages","systemMessages"],"type":"string","x-offersMessages":"Веб-хук о новых сообщениях по объявлениям","x-systemMessages":"Веб-хук о новых системных сообщениях","x-chatsReadability":"Веб-хук о прочитанности чатов","x-newbuildingMessages":"Веб-хук о новых сообщениях по новостройкам","x-agentMessages":"Веб-хук о новых сообщениях в чатах между пользователями","x-inquiryOffersMessages":"Веб-хук о новых сообщениях по объявлениям, не принадлежащим пользователю","description":"\n\t\n `offersMessages`: Веб-хук о новых сообщениях по объявлениям\t\n `systemMessages`: Веб-хук о новых системных сообщениях\t\n `chatsReadability`: Веб-хук о прочитанности чатов\t\n `newbuildingMessages`: Веб-хук о новых сообщениях по новостройкам\t\n `agentMessages`: Веб-хук о новых сообщениях в чатах между пользователями\t\n `inquiryOffersMessages`: Веб-хук о новых сообщениях по объявлениям, не принадлежащим пользователю"}},"required":["chats","newbuildings","users","webhookType"]},"OffersChatMessageContentSchema":{"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/MessageFileSchema"},"description":"Файлы"},"offers":{"type":"array","items":{"$ref":"#/components/schemas/OfferInMessageSchema"},"description":"Объявления в сообщении"},"text":{"title":"text","type":"string","x-sensitiveData":"pdn","description":"Текстовые данные сообщения"}}},"OffersChatMessageSchema":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/OffersChatMessageContentSchema"},"createdAt":{"title":"created_at","type":"string","format":"date-time","description":"Время создания сообщения"},"direction":{"enum":["in","out"],"type":"string","x-in":"Входящее","x-out":"Исходящее","description":"\n\t\n `in`: Входящее\t\n `out`: Исходящее"},"messageId":{"title":"message_id","type":"string","description":"ID сообщения"},"userId":{"title":"user_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"ID автора сообщения"},"userRole":{"enum":["companion","initiator","master","opponent"],"type":"string","x-initiator":"Клиент, который проявил интерес к бизнес-предложению (откликнулся по объявлению, оставил заявку)","x-opponent":"То, кто реагирует на интерес initiator (публикует объявление, получает заявку)","x-master":"\n В случае агентств недвижимости — руководитель opponent (может добавиться в чат, где уже есть initiator и opponent)\n ","x-companion":"Все остальные возможные участники чата (в том числе чат-боты)","description":"\n\t\n `initiator`: Клиент, который проявил интерес к бизнес-предложению (откликнулся по объявлению, оставил заявку)\t\n `opponent`: То, кто реагирует на интерес initiator (публикует объявление, получает заявку)\t\n `master`: \n В случае агентств недвижимости — руководитель opponent (может добавиться в чат, где уже есть initiator и opponent)\n \t\n `companion`: Все остальные возможные участники чата (в том числе чат-боты)"}},"required":["content","createdAt","direction","messageId","userId","userRole"]},"OffersChatSchema":{"type":"object","properties":{"chatId":{"title":"chat_id","type":"integer","format":"int64","description":"ID чата"},"createdAt":{"title":"created_at","type":"string","format":"date-time","description":"Время создания чата"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/OffersChatMessageSchema"},"description":"Сообщения в чате"},"offerId":{"title":"offer_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"ID объявления"},"updatedAt":{"title":"updated_at","type":"string","format":"date-time","description":"Время последнего обновления в чате"}},"required":["chatId","createdAt","messages","offerId","updatedAt"]},"V3OffersMessagesWebhookSchema":{"type":"object","properties":{"chats":{"type":"array","items":{"$ref":"#/components/schemas/OffersChatSchema"},"description":"Чаты"},"offers":{"type":"array","items":{"$ref":"#/components/schemas/OffersMessageOfferSchema"},"description":"Объявления"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserSchema"},"x-sensitiveData":"pdnPublic","description":"Пользователи"},"webhookType":{"enum":["agentMessages","chatsReadability","inquiryOffersMessages","newbuildingMessages","offersMessages","systemMessages"],"type":"string","x-offersMessages":"Веб-хук о новых сообщениях по объявлениям","x-systemMessages":"Веб-хук о новых системных сообщениях","x-chatsReadability":"Веб-хук о прочитанности чатов","x-newbuildingMessages":"Веб-хук о новых сообщениях по новостройкам","x-agentMessages":"Веб-хук о новых сообщениях в чатах между пользователями","x-inquiryOffersMessages":"Веб-хук о новых сообщениях по объявлениям, не принадлежащим пользователю","description":"\n\t\n `offersMessages`: Веб-хук о новых сообщениях по объявлениям\t\n `systemMessages`: Веб-хук о новых системных сообщениях\t\n `chatsReadability`: Веб-хук о прочитанности чатов\t\n `newbuildingMessages`: Веб-хук о новых сообщениях по новостройкам\t\n `agentMessages`: Веб-хук о новых сообщениях в чатах между пользователями\t\n `inquiryOffersMessages`: Веб-хук о новых сообщениях по объявлениям, не принадлежащим пользователю"}},"required":["chats","offers","users","webhookType"]},"MessageActionButtonSchema":{"type":"object","properties":{"link":{"title":"link","type":"string","description":"Ссылка кнопки сообщении"},"text":{"title":"text","type":"string","description":"Текст кнопки сообщении"}}},"SystemChatMessageContentSchema":{"type":"object","properties":{"actionButtons":{"type":"array","items":{"$ref":"#/components/schemas/MessageActionButtonSchema"},"description":"Кнопки в сообщении"},"files":{"type":"array","items":{"$ref":"#/components/schemas/MessageFileSchema"},"description":"Файлы"},"htmlText":{"title":"html_text","type":"string","x-sensitiveData":"pdn","description":"HTML данные сообщения"},"text":{"title":"text","type":"string","x-sensitiveData":"pdn","description":"Текстовые данные сообщения"}}},"SystemChatMessageSchema":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/SystemChatMessageContentSchema"},"createdAt":{"title":"created_at","type":"string","format":"date-time","description":"Время создания сообщения"},"direction":{"enum":["in","out"],"type":"string","x-in":"Входящее","x-out":"Исходящее","description":"\n\t\n `in`: Входящее\t\n `out`: Исходящее"},"messageId":{"title":"message_id","type":"string","description":"ID сообщения"},"userId":{"title":"user_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"ID автора сообщения"},"userRole":{"enum":["companion","initiator","master","opponent"],"type":"string","x-initiator":"Клиент, который проявил интерес к бизнес-предложению (откликнулся по объявлению, оставил заявку)","x-opponent":"То, кто реагирует на интерес initiator (публикует объявление, получает заявку)","x-master":"\n В случае агентств недвижимости — руководитель opponent (может добавиться в чат, где уже есть initiator и opponent)\n ","x-companion":"Все остальные возможные участники чата (в том числе чат-боты)","description":"\n\t\n `initiator`: Клиент, который проявил интерес к бизнес-предложению (откликнулся по объявлению, оставил заявку)\t\n `opponent`: То, кто реагирует на интерес initiator (публикует объявление, получает заявку)\t\n `master`: \n В случае агентств недвижимости — руководитель opponent (может добавиться в чат, где уже есть initiator и opponent)\n \t\n `companion`: Все остальные возможные участники чата (в том числе чат-боты)"}},"required":["content","createdAt","direction","messageId","userId","userRole"]},"SystemChatSchema":{"type":"object","properties":{"agentUserId":{"title":"agent_user_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"ID агента"},"chatId":{"title":"chat_id","type":"integer","format":"int64","description":"ID чата"},"createdAt":{"title":"created_at","type":"string","format":"date-time","description":"Время создания чата"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/SystemChatMessageSchema"},"description":"Сообщения в чате"},"updatedAt":{"title":"updated_at","type":"string","format":"date-time","description":"Время последнего обновления в чате"}},"required":["agentUserId","chatId","createdAt","messages","updatedAt"]},"V3SystemMessagesWebhookSchema":{"type":"object","properties":{"chats":{"type":"array","items":{"$ref":"#/components/schemas/SystemChatSchema"},"description":"Чаты"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserSchema"},"x-sensitiveData":"pdnPublic","description":"Пользователи"},"webhookType":{"enum":["agentMessages","chatsReadability","inquiryOffersMessages","newbuildingMessages","offersMessages","systemMessages"],"type":"string","x-offersMessages":"Веб-хук о новых сообщениях по объявлениям","x-systemMessages":"Веб-хук о новых системных сообщениях","x-chatsReadability":"Веб-хук о прочитанности чатов","x-newbuildingMessages":"Веб-хук о новых сообщениях по новостройкам","x-agentMessages":"Веб-хук о новых сообщениях в чатах между пользователями","x-inquiryOffersMessages":"Веб-хук о новых сообщениях по объявлениям, не принадлежащим пользователю","description":"\n\t\n `offersMessages`: Веб-хук о новых сообщениях по объявлениям\t\n `systemMessages`: Веб-хук о новых системных сообщениях\t\n `chatsReadability`: Веб-хук о прочитанности чатов\t\n `newbuildingMessages`: Веб-хук о новых сообщениях по новостройкам\t\n `agentMessages`: Веб-хук о новых сообщениях в чатах между пользователями\t\n `inquiryOffersMessages`: Веб-хук о новых сообщениях по объявлениям, не принадлежащим пользователю"}},"required":["chats","users","webhookType"]},"V3SubscribeWebhooksResponseSchema":{"type":"object","properties":{"agentMessagesWebhook":{"$ref":"#/components/schemas/AgentMessagesWebhookSchema"},"chatsReadabilityWebhook":{"$ref":"#/components/schemas/V3ChatsReadabilityWebhookSchema"},"inquiryOffersMessagesWebhook":{"$ref":"#/components/schemas/InquiryOffersMessagesWebhookSchema"},"newbuildingMessagesWebhook":{"$ref":"#/components/schemas/V3NewbuildingMessagesWebhookSchema"},"offersMessagesWebhook":{"$ref":"#/components/schemas/V3OffersMessagesWebhookSchema"},"systemMessagesWebhook":{"$ref":"#/components/schemas/V3SystemMessagesWebhookSchema"}},"required":["agentMessagesWebhook","chatsReadabilityWebhook","inquiryOffersMessagesWebhook","newbuildingMessagesWebhook","offersMessagesWebhook","systemMessagesWebhook"]},"V3SubscribeWebhooksResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/V3SubscribeWebhooksResponseSchema","description":"Результат"}},"required":["operationId","result"]},"V3SubscribeWebhooksRequestSchema":{"type":"object","properties":{"url":{"title":"url","type":"string","x-sensitiveData":"pdnClient","description":"Ссылка для отправки веб-хука"},"webhookTypes":{"title":"webhook_types","type":"array","items":{"enum":["agentMessagesApiOutgoing","agentMessagesIncoming","agentMessagesLkOutgoing","chatsReadability","inquiryOffersMessagesApiOutgoing","inquiryOffersMessagesIncoming","inquiryOffersMessagesLkOutgoing","newbuildingMessagesApiOutgoing","newbuildingMessagesIncoming","newbuildingMessagesLkOutgoing","offersMessagesApiOutgoing","offersMessagesIncoming","offersMessagesLkOutgoing","systemMessages"],"type":"string","x-offersMessagesIncoming":"Веб-хук о новых входящих сообщениях по объявлениям","x-offersMessagesApiOutgoing":"Веб-хук о новых исходящих сообщениях по объявлениям отправленных по API","x-offersMessagesLkOutgoing":"Веб-хук о новых исходящих сообщениях по объявлениям отправленных из ЛК (web/mobile)","x-newbuildingMessagesIncoming":"Веб-хук о новых входящих сообщениях по объявлениям новостроек","x-newbuildingMessagesApiOutgoing":"Веб-хук о новых исходящих сообщениях по объявлениям новостроек отправленных по API","x-newbuildingMessagesLkOutgoing":"Веб-хук о новых исходящих сообщениях по объявлениям новостроек отправленных из ЛК (web/mobile)","x-systemMessages":"Веб-хук о новых системных сообщениях (ЦИАН, Модерация)","x-chatsReadability":"Веб-хук о прочитанности чатов","x-agentMessagesIncoming":"Веб-хук о новых входящих сообщениях в чатах между пользователями","x-agentMessagesLkOutgoing":"Веб-хук о новых исходящих сообщениях в чатах между пользователями отправленных из ЛК (web/mobile)","x-agentMessagesApiOutgoing":"Веб-хук о новых исходящих сообщениях в чатах между пользователями отправленных по API","x-inquiryOffersMessagesIncoming":"Веб-хук о новых входящих сообщениях по объявлениям, не принадлежащим пользователю","x-inquiryOffersMessagesLkOutgoing":"Веб-хук о новых исходящих сообщениях по объявлениям, не принадлежащим пользователю, отправленных из ЛК","x-inquiryOffersMessagesApiOutgoing":"Веб-хук о новых исходящих сообщениях по объявлениям, не принадлежащим пользователю, отправленных по API","description":"\n\t\n `offersMessagesIncoming`: Веб-хук о новых входящих сообщениях по объявлениям\t\n `offersMessagesApiOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям отправленных по API\t\n `offersMessagesLkOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям отправленных из ЛК (web/mobile)\t\n `newbuildingMessagesIncoming`: Веб-хук о новых входящих сообщениях по объявлениям новостроек\t\n `newbuildingMessagesApiOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям новостроек отправленных по API\t\n `newbuildingMessagesLkOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям новостроек отправленных из ЛК (web/mobile)\t\n `systemMessages`: Веб-хук о новых системных сообщениях (ЦИАН, Модерация)\t\n `chatsReadability`: Веб-хук о прочитанности чатов\t\n `agentMessagesIncoming`: Веб-хук о новых входящих сообщениях в чатах между пользователями\t\n `agentMessagesLkOutgoing`: Веб-хук о новых исходящих сообщениях в чатах между пользователями отправленных из ЛК (web/mobile)\t\n `agentMessagesApiOutgoing`: Веб-хук о новых исходящих сообщениях в чатах между пользователями отправленных по API\t\n `inquiryOffersMessagesIncoming`: Веб-хук о новых входящих сообщениях по объявлениям, не принадлежащим пользователю\t\n `inquiryOffersMessagesLkOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям, не принадлежащим пользователю, отправленных из ЛК\t\n `inquiryOffersMessagesApiOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям, не принадлежащим пользователю, отправленных по API"},"description":"\n\t\n `offersMessagesIncoming`: Веб-хук о новых входящих сообщениях по объявлениям\t\n `offersMessagesApiOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям отправленных по API\t\n `offersMessagesLkOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям отправленных из ЛК (web/mobile)\t\n `newbuildingMessagesIncoming`: Веб-хук о новых входящих сообщениях по объявлениям новостроек\t\n `newbuildingMessagesApiOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям новостроек отправленных по API\t\n `newbuildingMessagesLkOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям новостроек отправленных из ЛК (web/mobile)\t\n `systemMessages`: Веб-хук о новых системных сообщениях (ЦИАН, Модерация)\t\n `chatsReadability`: Веб-хук о прочитанности чатов\t\n `agentMessagesIncoming`: Веб-хук о новых входящих сообщениях в чатах между пользователями\t\n `agentMessagesLkOutgoing`: Веб-хук о новых исходящих сообщениях в чатах между пользователями отправленных из ЛК (web/mobile)\t\n `agentMessagesApiOutgoing`: Веб-хук о новых исходящих сообщениях в чатах между пользователями отправленных по API\t\n `inquiryOffersMessagesIncoming`: Веб-хук о новых входящих сообщениях по объявлениям, не принадлежащим пользователю\t\n `inquiryOffersMessagesLkOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям, не принадлежащим пользователю, отправленных из ЛК\t\n `inquiryOffersMessagesApiOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям, не принадлежащим пользователю, отправленных по API"}},"required":["url","webhookTypes"]},"V3UnsubscribeWebhooksRequestSchema":{"type":"object","properties":{"url":{"title":"url","type":"string","x-sensitiveData":"pdnClient","description":"Ссылка для отправки веб-хука"},"webhookType":{"enum":["agentMessages","chatsReadability","inquiryOffersMessages","newbuildingMessages","offersMessages","systemMessages"],"type":"string","x-offersMessages":"Веб-хук о новых сообщениях по объявлениям","x-systemMessages":"Веб-хук о новых системных сообщениях (ЦИАН, Модерация)","x-chatsReadability":"Веб-хук о прочитанности чатов","x-newbuildingMessages":"Веб-хук о сообщениях по новостройкам","x-agentMessages":"Веб-хук о сообщениях в чатах между пользователями","x-inquiryOffersMessages":"Веб-хук о сообщениях по объявлениям, не принадлежащим пользователю","description":"\n\t\n `offersMessages`: Веб-хук о новых сообщениях по объявлениям\t\n `systemMessages`: Веб-хук о новых системных сообщениях (ЦИАН, Модерация)\t\n `chatsReadability`: Веб-хук о прочитанности чатов\t\n `newbuildingMessages`: Веб-хук о сообщениях по новостройкам\t\n `agentMessages`: Веб-хук о сообщениях в чатах между пользователями\t\n `inquiryOffersMessages`: Веб-хук о сообщениях по объявлениям, не принадлежащим пользователю"}}},"V3WebhookSubscriptionSchema":{"type":"object","properties":{"deliveryStrategy":{"enum":["incoming","incomingAndExternalOutgoing","incomingAndOutgoing"],"type":"string","x-incoming":"Все входящие сообщения","x-incomingAndOutgoing":"Все входящие и исходящие сообщения","x-incomingAndExternalOutgoing":"Все входящие и исходящие сообщения отправленные с web/mobile","description":"\n\t\n `incoming`: Все входящие сообщения\t\n `incomingAndOutgoing`: Все входящие и исходящие сообщения\t\n `incomingAndExternalOutgoing`: Все входящие и исходящие сообщения отправленные с web/mobile"},"url":{"title":"url","type":"string","x-sensitiveData":"pdnClient","description":"Ссылка для отправки веб-хука"},"webhookType":{"enum":["agentMessages","chatsReadability","inquiryOffersMessages","newbuildingMessages","offersMessages","systemMessages"],"type":"string","x-offersMessages":"Веб-хук о новых сообщениях по объявлениям","x-systemMessages":"Веб-хук о новых системных сообщениях","x-chatsReadability":"Веб-хук о прочитанности чатов","x-newbuildingMessages":"Веб-хук о новых сообщениях по новостройкам","x-agentMessages":"Веб-хук о новых сообщениях в чатах между пользователями","x-inquiryOffersMessages":"Веб-хук о новых сообщениях по объявлениям, не принадлежащим пользователю","description":"\n\t\n `offersMessages`: Веб-хук о новых сообщениях по объявлениям\t\n `systemMessages`: Веб-хук о новых системных сообщениях\t\n `chatsReadability`: Веб-хук о прочитанности чатов\t\n `newbuildingMessages`: Веб-хук о новых сообщениях по новостройкам\t\n `agentMessages`: Веб-хук о новых сообщениях в чатах между пользователями\t\n `inquiryOffersMessages`: Веб-хук о новых сообщениях по объявлениям, не принадлежащим пользователю"}},"required":["url","webhookType"]},"V3GetWebhooksSubscriptionsResponseSchema":{"type":"object","properties":{"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/V3WebhookSubscriptionSchema"},"description":"Подписки на веб-хуки"}},"required":["subscriptions"]},"V3GetWebhooksSubscriptionsResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/V3GetWebhooksSubscriptionsResponseSchema","description":"Результат"}},"required":["operationId","result"]},"V1SendTestWebhooksResponseSchema":{"type":"object","properties":{"clientServerUrl":{"title":"client_server_url","type":"string","x-sensitiveData":"pdnClient","description":"URL на который отправлен webhook"},"message":{"title":"message","type":"string","description":"Сообщение"},"responseHttpStatus":{"title":"response_http_status","type":"integer","format":"int64","description":"Код ответа клиентского сервера"}},"required":["clientServerUrl","message"]},"V1SendTestWebhooksResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/V1SendTestWebhooksResponseSchema","description":"Результат"}},"required":["operationId","result"]},"V1SendTestWebhooksRequestSchema":{"type":"object","properties":{"serverUrl":{"title":"server_url","type":"string","x-sensitiveData":"pdnClient","description":"Ссылка для отправки веб-хука"},"webhookType":{"enum":["chatsReadability","newbuildingMessages","offersMessages","systemMessages"],"type":"string","x-offersMessages":"Веб-хук о новых сообщениях по объявлениям","x-systemMessages":"Веб-хук о новых системных сообщениях","x-chatsReadability":"Веб-хук о прочитанности чатов","x-newbuildingMessages":"Веб-хук о новых сообщениях по новостройкам","description":"\n\t\n `offersMessages`: Веб-хук о новых сообщениях по объявлениям\t\n `systemMessages`: Веб-хук о новых системных сообщениях\t\n `chatsReadability`: Веб-хук о прочитанности чатов\t\n `newbuildingMessages`: Веб-хук о новых сообщениях по новостройкам"}},"required":["webhookType"]},"OfferForClientSchema":{"type":"object","properties":{"formattedAddress":{"title":"formatted_address","type":"string","description":"\n Метро, улица с домом, населенный пункт, дом (если нет улицы), потом район, область.\n Виды субъектов сокращаются в написании:\n Республика — респ., Край — край, Автономная область — а. обл., Автономный округ — а. окр., Область — обл.\n "},"formattedInfo":{"title":"formatted_info","type":"string","description":"Строка с прочей информацией об объявлении"},"formattedOldPrice":{"title":"formatted_old_price","type":"string","description":"\n Строка с предыдущей ценой объявления, указывается в том случае если\n в formatted_price указано новая цена, как правило со скидкой.\n "},"formattedPrice":{"title":"formatted_price","type":"string","description":"Строка с ценой объявления"},"photoUrls":{"title":"photo_urls","type":"array","items":{"title":"photo_urls","type":"string"},"description":"Фотографии объявления"},"realtyOfferId":{"title":"realty_offer_id","type":"integer","format":"int64","description":"Идентификатор объявления в Базе Данных Microsoft SQL Server Realty"},"url":{"title":"url","type":"string","description":"Ссылка вида https://www.cian.ru/deal_type/offer_type/offer_id/"}},"required":["formattedAddress","formattedInfo","formattedPrice","photoUrls","realtyOfferId","url"]},"MessageContentSchema":{"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/MessageFileSchema"},"description":"Файлы"},"offers":{"type":"array","items":{"$ref":"#/components/schemas/OfferForClientSchema"},"description":"Объявления прикреплённые к сообщению"},"text":{"title":"text","type":"string","x-sensitiveData":"pdnClient","description":"Текст сообщения"}},"required":["offers"]},"AvatarImagesSchema":{"type":"object","properties":{"big":{"title":"big","type":"string","description":"Ссылка на аватар большого размера"},"small":{"title":"small","type":"string","description":"Ссылка на аватар маленького размера"}},"required":["big","small"]},"MessageSchema":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/MessageContentSchema"},"createdAt":{"title":"created_at","type":"string","format":"date-time","description":"Дата создания сообщения"},"direction":{"enum":["in","out"],"type":"string","x-in":"Входящее","x-out":"Исходящее","description":"\n\t\n `in`: Входящее\t\n `out`: Исходящее"},"messageId":{"title":"message_id","type":"string","description":"ID сообщения"},"user":{"$ref":"#/components/schemas/UserSchema"}},"required":["content","createdAt","direction","messageId","user"]},"ChatUserSchema":{"type":"object","properties":{"role":{"enum":["companion","initiator","master","opponent"],"type":"string","x-initiator":"\n Клиент, который проявил интерес к бизнес-предложению (откликнулся по объявлению, оставил заявку)\n ","x-opponent":"\n Тот, кто реагирует на интерес initiator (публикует объявление, получает заявку)\n ","x-master":"\n В случае агентств недвижимости — руководитель opponent (может добавиться в чат, где уже есть initiator и opponent)\n ","x-companion":"\n Все остальные возможные участники чата (в том числе чат-боты)\n ","description":"\n\t\n `initiator`: \n Клиент, который проявил интерес к бизнес-предложению (откликнулся по объявлению, оставил заявку)\n \t\n `opponent`: \n Тот, кто реагирует на интерес initiator (публикует объявление, получает заявку)\n \t\n `master`: \n В случае агентств недвижимости — руководитель opponent (может добавиться в чат, где уже есть initiator и opponent)\n \t\n `companion`: \n Все остальные возможные участники чата (в том числе чат-боты)\n "},"userId":{"title":"user_id","type":"integer","format":"int64","description":"ID пользователя"}},"required":["role","userId"]},"ChatSchema":{"type":"object","properties":{"agentUserId":{"title":"agent_user_id","type":"integer","format":"int64","description":"ID получателя сообщений"},"chatId":{"title":"chat_id","type":"integer","format":"int64","description":"ID чата"},"createdAt":{"title":"created_at","type":"string","format":"date-time","description":"Дата создания чата"},"entityId":{"title":"entity_id","type":"integer","format":"int64","description":"ID объекта в Циане (новостройка, объект недвижимости)"},"lastMessage":{"$ref":"#/components/schemas/MessageSchema","description":"Последнее сообщение"},"newbuilding":{"$ref":"#/components/schemas/NewbuildingSchema","description":"Новостройка"},"offer":{"$ref":"#/components/schemas/OfferSchema","description":"Объявление"},"updatedAt":{"title":"updated_at","type":"string","format":"date-time","description":"Дата последнего сообщения."},"users":{"type":"array","items":{"$ref":"#/components/schemas/ChatUserSchema"},"description":"Участники чата"}},"required":["agentUserId","chatId","createdAt","updatedAt"]},"PublicApiGetChatResponseSchema":{"type":"object","properties":{"chat":{"$ref":"#/components/schemas/ChatSchema"}},"required":["chat"]},"PublicApiGetChatResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/PublicApiGetChatResponseSchema","description":"Результат"}},"required":["operationId","result"]},"PublicApiGetChatsResponseSchema":{"type":"object","properties":{"chats":{"type":"array","items":{"$ref":"#/components/schemas/ChatSchema"},"description":"Список чатов"},"totalCount":{"title":"total_count","type":"integer","format":"int64","description":"Общее количество чатов, удовлетворяющих запросу"}},"required":["chats","totalCount"]},"PublicApiGetChatsResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/PublicApiGetChatsResponseSchema","description":"Результат"}},"required":["operationId","result"]},"PublicApiReadChatRequestSchema":{"type":"object","properties":{"chatId":{"title":"chat_id","type":"integer","format":"int64","description":"ID чата"}},"required":["chatId"]},"MessagesMessageSchema":{"type":"object","properties":{"content":{"$ref":"#/components/schemas/MessageContentSchema"},"createdAt":{"title":"created_at","type":"string","format":"date-time","description":"Дата создания сообщения"},"direction":{"enum":["in","out"],"type":"string","x-in":"Входящее","x-out":"Исходящее","description":"\n\t\n `in`: Входящее\t\n `out`: Исходящее"},"messageId":{"title":"message_id","type":"string","description":"ID сообщения"},"userId":{"title":"user_id","type":"integer","format":"int64","description":"ID автора сообщения"}},"required":["content","createdAt","direction","messageId","userId"]},"PublicApiGetMessagesResponseSchema":{"type":"object","properties":{"chatId":{"title":"chat_id","type":"integer","format":"int64","description":"ID чата"},"messages":{"type":"array","items":{"$ref":"#/components/schemas/MessagesMessageSchema"},"description":"Список сообщений"},"totalCount":{"title":"total_count","type":"integer","format":"int64","description":"Общее количество сообщений в чате"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserSchema"},"description":"Список пользователей, отправлявших сообщения"}},"required":["chatId","messages","totalCount","users"]},"PublicApiGetMessagesResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/PublicApiGetMessagesResponseSchema","description":"Результат"}},"required":["operationId","result"]},"ResponseFileSchema":{"type":"object","properties":{"content":{"type":"string","format":"binary"},"contentType":{"title":"content_type","type":"string"},"filename":{"title":"filename","type":"string"}},"required":["content"]},"ResponseFileSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/ResponseFileSchema","description":"Результат"}},"required":["operationId","result"]},"PublicApiSendMessageResponseSchema":{"type":"object","properties":{"chatId":{"title":"chat_id","type":"integer","format":"int64","description":"ID чата"},"messageId":{"title":"message_id","type":"string","description":"ID сообщения"}},"required":["chatId","messageId"]},"PublicApiSendMessageResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/PublicApiSendMessageResponseSchema","description":"Результат"}},"required":["operationId","result"]},"ContentSchema":{"type":"object","properties":{"text":{"title":"text","type":"string","x-sensitiveData":"pdnClient","description":"Текстовые данные сообщения"}},"required":["text"]},"PublicApiSendMessageRequestSchema":{"type":"object","properties":{"chatId":{"title":"chat_id","type":"integer","format":"int64","description":"ID чата"},"content":{"$ref":"#/components/schemas/ContentSchema"}},"required":["chatId","content"]},"AddFileResponseV2Schema":{"type":"object","properties":{"id":{"title":"id","type":"string","description":"Идентификатор, указывается только если Result == success"},"result":{"enum":["fail","invalidContent","invalidExtension","noContent","success"],"type":"string","x-success":"","x-fail":"","x-invalidContent":"","x-noContent":"","x-invalidExtension":"","description":"\n\t\n `success`: \t\n `fail`: \t\n `invalidContent`: \t\n `noContent`: \t\n `invalidExtension`: "}},"required":["result"]},"AddFilesResponseV2Schema":{"type":"object","properties":{"addFilesResult":{"type":"array","items":{"$ref":"#/components/schemas/AddFileResponseV2Schema"},"description":"Результат добавления файлов"}},"required":["addFilesResult"]},"AddFilesResponseV2SchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/AddFilesResponseV2Schema","description":"Результат"}},"required":["operationId","result"]},"FileFromClientSchema":{"type":"object","properties":{"asDocument":{"title":"as_document","type":"boolean","description":"\n Означает, что исходный файл надо воспринимать как документ.\n Некоторые типы файлов так воспринимаются всегда, например .doc,\n но если надо чтоб например картинка была загружена как документ,\n то надо указать это отдельно => as_document=true\n "},"name":{"title":"name","type":"string","description":"Имя файла"},"uid":{"title":"uid","type":"string","description":"Идентификатор файла"}},"required":["name","uid"]},"ContentWithFilesSchema":{"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/FileFromClientSchema"},"description":"Список файлов, которые нужно прикрепить к сообщению"},"text":{"title":"text","type":"string","x-sensitiveData":"pdnClient","description":"Текстовые данные сообщения"}}},"PublicApiSendMessageWithFilesRequestSchema":{"type":"object","properties":{"chatId":{"title":"chat_id","type":"integer","format":"int64","description":"ID чата"},"content":{"$ref":"#/components/schemas/ContentWithFilesSchema"}},"required":["chatId","content"]},"ChatsReadabilityWebhookSchema":{"type":"object","properties":{"chats":{"type":"array","items":{"$ref":"#/components/schemas/ReadabilityChatSchema"},"description":"Чаты"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserSchema"},"x-sensitiveData":"pdnPublic","description":"Пользователи"},"webhookType":{"enum":["chatsReadability","newbuildingMessages","offersMessages","systemMessages"],"type":"string","x-offersMessages":"Веб-хук о новых сообщениях по объявлениям","x-systemMessages":"Веб-хук о новых системных сообщениях","x-chatsReadability":"Веб-хук о прочитанности чатов","x-newbuildingMessages":"Веб-хук о новых сообщениях по новостройкам","description":"\n\t\n `offersMessages`: Веб-хук о новых сообщениях по объявлениям\t\n `systemMessages`: Веб-хук о новых системных сообщениях\t\n `chatsReadability`: Веб-хук о прочитанности чатов\t\n `newbuildingMessages`: Веб-хук о новых сообщениях по новостройкам"}},"required":["chats","users","webhookType"]},"NewbuildingMessagesWebhookSchema":{"type":"object","properties":{"chats":{"type":"array","items":{"$ref":"#/components/schemas/NewbuildingChatSchema"},"description":"Чаты"},"newbuildings":{"type":"array","items":{"$ref":"#/components/schemas/NewbuildingSchema"},"description":"Новостройки"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserSchema"},"x-sensitiveData":"pdnPublic","description":"Пользователи"},"webhookType":{"enum":["chatsReadability","newbuildingMessages","offersMessages","systemMessages"],"type":"string","x-offersMessages":"Веб-хук о новых сообщениях по объявлениям","x-systemMessages":"Веб-хук о новых системных сообщениях","x-chatsReadability":"Веб-хук о прочитанности чатов","x-newbuildingMessages":"Веб-хук о новых сообщениях по новостройкам","description":"\n\t\n `offersMessages`: Веб-хук о новых сообщениях по объявлениям\t\n `systemMessages`: Веб-хук о новых системных сообщениях\t\n `chatsReadability`: Веб-хук о прочитанности чатов\t\n `newbuildingMessages`: Веб-хук о новых сообщениях по новостройкам"}},"required":["chats","newbuildings","users","webhookType"]},"OffersMessagesWebhookSchema":{"type":"object","properties":{"chats":{"type":"array","items":{"$ref":"#/components/schemas/OffersChatSchema"},"description":"Чаты"},"offers":{"type":"array","items":{"$ref":"#/components/schemas/OffersMessageOfferSchema"},"description":"Объявления"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserSchema"},"x-sensitiveData":"pdnPublic","description":"Пользователи"},"webhookType":{"enum":["chatsReadability","newbuildingMessages","offersMessages","systemMessages"],"type":"string","x-offersMessages":"Веб-хук о новых сообщениях по объявлениям","x-systemMessages":"Веб-хук о новых системных сообщениях","x-chatsReadability":"Веб-хук о прочитанности чатов","x-newbuildingMessages":"Веб-хук о новых сообщениях по новостройкам","description":"\n\t\n `offersMessages`: Веб-хук о новых сообщениях по объявлениям\t\n `systemMessages`: Веб-хук о новых системных сообщениях\t\n `chatsReadability`: Веб-хук о прочитанности чатов\t\n `newbuildingMessages`: Веб-хук о новых сообщениях по новостройкам"}},"required":["chats","offers","users","webhookType"]},"SystemMessagesWebhookSchema":{"type":"object","properties":{"chats":{"type":"array","items":{"$ref":"#/components/schemas/SystemChatSchema"},"description":"Чаты"},"users":{"type":"array","items":{"$ref":"#/components/schemas/UserSchema"},"x-sensitiveData":"pdnPublic","description":"Пользователи"},"webhookType":{"enum":["chatsReadability","newbuildingMessages","offersMessages","systemMessages"],"type":"string","x-offersMessages":"Веб-хук о новых сообщениях по объявлениям","x-systemMessages":"Веб-хук о новых системных сообщениях","x-chatsReadability":"Веб-хук о прочитанности чатов","x-newbuildingMessages":"Веб-хук о новых сообщениях по новостройкам","description":"\n\t\n `offersMessages`: Веб-хук о новых сообщениях по объявлениям\t\n `systemMessages`: Веб-хук о новых системных сообщениях\t\n `chatsReadability`: Веб-хук о прочитанности чатов\t\n `newbuildingMessages`: Веб-хук о новых сообщениях по новостройкам"}},"required":["chats","users","webhookType"]},"V2SubscribeWebhooksResponseSchema":{"type":"object","properties":{"chatsReadabilityWebhook":{"$ref":"#/components/schemas/ChatsReadabilityWebhookSchema"},"newbuildingMessagesWebhook":{"$ref":"#/components/schemas/NewbuildingMessagesWebhookSchema"},"offersMessagesWebhook":{"$ref":"#/components/schemas/OffersMessagesWebhookSchema"},"systemMessagesWebhook":{"$ref":"#/components/schemas/SystemMessagesWebhookSchema"}},"required":["chatsReadabilityWebhook","newbuildingMessagesWebhook","offersMessagesWebhook","systemMessagesWebhook"]},"V2SubscribeWebhooksResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/V2SubscribeWebhooksResponseSchema","description":"Результат"}},"required":["operationId","result"]},"V2SubscribeWebhooksRequestSchema":{"type":"object","properties":{"url":{"title":"url","type":"string","x-sensitiveData":"pdnClient","description":"Ссылка для отправки веб-хука"},"webhookTypes":{"title":"webhook_types","type":"array","items":{"enum":["chatsReadability","newbuildingMessagesApiOutgoing","newbuildingMessagesIncoming","newbuildingMessagesLkOutgoing","offersMessagesApiOutgoing","offersMessagesIncoming","offersMessagesLkOutgoing","systemMessages"],"type":"string","x-offersMessagesIncoming":"Веб-хук о новых входящих сообщениях по объявлениям","x-offersMessagesApiOutgoing":"Веб-хук о новых исходящих сообщениях по объявлениям отправленных по API","x-offersMessagesLkOutgoing":"Веб-хук о новых исходящих сообщениях по объявлениям отправленных из ЛК (web/mobile)","x-newbuildingMessagesIncoming":"Веб-хук о новых входящих сообщениях по объявлениям новостроек","x-newbuildingMessagesApiOutgoing":"Веб-хук о новых исходящих сообщениях по объявлениям новостроек отправленных по API","x-newbuildingMessagesLkOutgoing":"Веб-хук о новых исходящих сообщениях по объявлениям новостроек отправленных из ЛК (web/mobile)","x-systemMessages":"Веб-хук о новых системных сообщениях (ЦИАН, Модерация)","x-chatsReadability":"Веб-хук о прочитанности чатов","description":"\n\t\n `offersMessagesIncoming`: Веб-хук о новых входящих сообщениях по объявлениям\t\n `offersMessagesApiOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям отправленных по API\t\n `offersMessagesLkOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям отправленных из ЛК (web/mobile)\t\n `newbuildingMessagesIncoming`: Веб-хук о новых входящих сообщениях по объявлениям новостроек\t\n `newbuildingMessagesApiOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям новостроек отправленных по API\t\n `newbuildingMessagesLkOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям новостроек отправленных из ЛК (web/mobile)\t\n `systemMessages`: Веб-хук о новых системных сообщениях (ЦИАН, Модерация)\t\n `chatsReadability`: Веб-хук о прочитанности чатов"},"description":"\n\t\n `offersMessagesIncoming`: Веб-хук о новых входящих сообщениях по объявлениям\t\n `offersMessagesApiOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям отправленных по API\t\n `offersMessagesLkOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям отправленных из ЛК (web/mobile)\t\n `newbuildingMessagesIncoming`: Веб-хук о новых входящих сообщениях по объявлениям новостроек\t\n `newbuildingMessagesApiOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям новостроек отправленных по API\t\n `newbuildingMessagesLkOutgoing`: Веб-хук о новых исходящих сообщениях по объявлениям новостроек отправленных из ЛК (web/mobile)\t\n `systemMessages`: Веб-хук о новых системных сообщениях (ЦИАН, Модерация)\t\n `chatsReadability`: Веб-хук о прочитанности чатов"}},"required":["url","webhookTypes"]},"V2UnsubscribeWebhooksRequestSchema":{"type":"object","properties":{"url":{"title":"url","type":"string","x-sensitiveData":"pdnClient","description":"Ссылка для отправки веб-хука"},"webhookType":{"enum":["chatsReadability","newbuildingMessages","offersMessages","systemMessages"],"type":"string","x-offersMessages":"Веб-хук о новых сообщениях по объявлениям","x-systemMessages":"Веб-хук о новых системных сообщениях (ЦИАН, Модерация)","x-chatsReadability":"Веб-хук о прочитанности чатов","x-newbuildingMessages":"Веб-хук о сообщениях по новостройкам","description":"\n\t\n `offersMessages`: Веб-хук о новых сообщениях по объявлениям\t\n `systemMessages`: Веб-хук о новых системных сообщениях (ЦИАН, Модерация)\t\n `chatsReadability`: Веб-хук о прочитанности чатов\t\n `newbuildingMessages`: Веб-хук о сообщениях по новостройкам"}}},"WebhookSubscriptionSchema":{"type":"object","properties":{"deliveryStrategy":{"enum":["incoming","incomingAndExternalOutgoing","incomingAndOutgoing"],"type":"string","x-incoming":"Все входящие сообщения","x-incomingAndOutgoing":"Все входящие и исходящие сообщения","x-incomingAndExternalOutgoing":"Все входящие и исходящие сообщения отправленные с web/mobile","description":"\n\t\n `incoming`: Все входящие сообщения\t\n `incomingAndOutgoing`: Все входящие и исходящие сообщения\t\n `incomingAndExternalOutgoing`: Все входящие и исходящие сообщения отправленные с web/mobile"},"url":{"title":"url","type":"string","x-sensitiveData":"pdnClient","description":"Ссылка для отправки веб-хука"},"webhookType":{"enum":["chatsReadability","newbuildingMessages","offersMessages","systemMessages"],"type":"string","x-offersMessages":"Веб-хук о новых сообщениях по объявлениям","x-systemMessages":"Веб-хук о новых системных сообщениях","x-chatsReadability":"Веб-хук о прочитанности чатов","x-newbuildingMessages":"Веб-хук о новых сообщениях по новостройкам","description":"\n\t\n `offersMessages`: Веб-хук о новых сообщениях по объявлениям\t\n `systemMessages`: Веб-хук о новых системных сообщениях\t\n `chatsReadability`: Веб-хук о прочитанности чатов\t\n `newbuildingMessages`: Веб-хук о новых сообщениях по новостройкам"}},"required":["url","webhookType"]},"V1GetWebhooksSubscriptionsResponseSchema":{"type":"object","properties":{"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/WebhookSubscriptionSchema"},"description":"Подписки на веб-хуки"}},"required":["subscriptions"]},"V1GetWebhooksSubscriptionsResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/V1GetWebhooksSubscriptionsResponseSchema","description":"Результат"}},"required":["operationId","result"]},"SubscribeOffersMessagesWebhooksRequestSchema":{"type":"object","properties":{"deliveryStrategy":{"enum":["incoming","incomingAndExternalOutgoing","incomingAndOutgoing"],"type":"string","x-incoming":"Все входящие сообщения","x-incomingAndOutgoing":"Все входящие и исходящие сообщения","x-incomingAndExternalOutgoing":"Все входящие и исходящие сообщения отправленные с web/mobile","description":"\n\t\n `incoming`: Все входящие сообщения\t\n `incomingAndOutgoing`: Все входящие и исходящие сообщения\t\n `incomingAndExternalOutgoing`: Все входящие и исходящие сообщения отправленные с web/mobile"},"url":{"title":"url","type":"string","x-sensitiveData":"pdnClient","description":"Ссылка для отправки веб-хука"}},"required":["deliveryStrategy","url"]},"UnsubscribeOffersMessagesWebhooksRequestSchema":{"type":"object","properties":{"url":{"title":"url","type":"string","x-sensitiveData":"pdnClient","description":"Ссылка для отправки веб-хука"}}},"GetOfferCoverageResponseSchema":{"type":"object","properties":{"coverage":{"title":"coverage","type":"integer","format":"int64","description":"Охват в процентах"},"offerId":{"title":"offer_id","type":"integer","format":"int64","description":"ID объявления в ЦИАН"},"searchesCount":{"title":"searches_count","type":"integer","format":"int64","description":"Количество поисков"},"showsCount":{"title":"shows_count","type":"integer","format":"int64","description":"Количество показов"}},"required":["coverage","offerId","searchesCount","showsCount"]},"GetOfferCoverageResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/GetOfferCoverageResponseSchema","description":"Результат"}},"required":["operationId","result"]},"AvailableOfferSchema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorSchema"},"description":"Причины недоступности объявления"},"isAvailable":{"title":"is_available","type":"boolean","description":"Доступность объявления"},"offerId":{"title":"offer_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"Идентификатор объявления"}},"required":["errors","isAvailable","offerId"]},"V1GetAvailableOffersResponseSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/AvailableOfferSchema"},"description":"Список объявлений"}},"required":["items"]},"V1GetAvailableOffersResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/V1GetAvailableOffersResponseSchema","description":"Результат"}},"required":["operationId","result"]},"V1GetAvailableOffersRequestSchema":{"type":"object","properties":{"offerIds":{"title":"offer_ids","type":"array","items":{"title":"offer_ids","type":"integer","format":"int64"},"x-sensitiveData":"pdnPublic","description":"Идентификаторы объявлений"}},"required":["offerIds"]},"ExpireAtSchema":{"type":"object","properties":{"max":{"title":"max","type":"integer","format":"int64","description":"Максимальное значение"},"min":{"title":"min","type":"integer","format":"int64","description":"Минимальное значение"}},"required":["max","min"]},"PolicyInfoSchema":{"type":"object","properties":{"text":{"title":"text","type":"string","description":"Текст условий использования"},"url":{"title":"url","type":"string","description":"Ссылка на условия использования"}},"required":["text","url"]},"CommonParametersSchema":{"type":"object","properties":{"expireAt":{"$ref":"#/components/schemas/ExpireAtSchema"},"policyInfo":{"$ref":"#/components/schemas/PolicyInfoSchema","description":"Информация о условиях использования"},"proposals":{"title":"proposals","type":"array","items":{"enum":["discount","discountsFromPartners","helpWithMortgageDocument","legalSupportForDeal","readyToCompleteDeal","realEstateValuation","realtorSupportAtAnyStageOfDeal","specialMortgageTerms","submitYourPrice","viewingRealEstateProperty"],"type":"string","x-discount":"Предложение скидки по объявлению","x-readyToCompleteDeal":"Готов к быстрому проведению сделки","x-viewingRealEstateProperty":"Предложение о просмотре объекта недвижимости","x-legalSupportForDeal":"Предложение о юридическом сопровождении сделки","x-realtorSupportAtAnyStageOfDeal":"Предложение о помощи риелтора на любом этапе сделки","x-realEstateValuation":"Предложение об оценки стоимости недвижимости","x-specialMortgageTerms":"Предложение о специальных условиях по ипотеке от банков","x-helpWithMortgageDocument":"Предложение о Помощи в подготовке документов для ипотеки","x-discountsFromPartners":"Предложение о скидках от партнеров","x-submitYourPrice":"Предложить свою цену","description":"\n\t\n `discount`: Предложение скидки по объявлению\t\n `readyToCompleteDeal`: Готов к быстрому проведению сделки\t\n `viewingRealEstateProperty`: Предложение о просмотре объекта недвижимости\t\n `legalSupportForDeal`: Предложение о юридическом сопровождении сделки\t\n `realtorSupportAtAnyStageOfDeal`: Предложение о помощи риелтора на любом этапе сделки\t\n `realEstateValuation`: Предложение об оценки стоимости недвижимости\t\n `specialMortgageTerms`: Предложение о специальных условиях по ипотеке от банков\t\n `helpWithMortgageDocument`: Предложение о Помощи в подготовке документов для ипотеки\t\n `discountsFromPartners`: Предложение о скидках от партнеров\t\n `submitYourPrice`: Предложить свою цену"},"description":"\n\t\n `discount`: Предложение скидки по объявлению\t\n `readyToCompleteDeal`: Готов к быстрому проведению сделки\t\n `viewingRealEstateProperty`: Предложение о просмотре объекта недвижимости\t\n `legalSupportForDeal`: Предложение о юридическом сопровождении сделки\t\n `realtorSupportAtAnyStageOfDeal`: Предложение о помощи риелтора на любом этапе сделки\t\n `realEstateValuation`: Предложение об оценки стоимости недвижимости\t\n `specialMortgageTerms`: Предложение о специальных условиях по ипотеке от банков\t\n `helpWithMortgageDocument`: Предложение о Помощи в подготовке документов для ипотеки\t\n `discountsFromPartners`: Предложение о скидках от партнеров\t\n `submitYourPrice`: Предложить свою цену"}},"required":["expireAt","proposals"]},"DiscountSchema":{"type":"object","properties":{"max":{"title":"max","type":"integer","format":"int64","description":"Максимальное значение скидки"},"min":{"title":"min","type":"integer","format":"int64","description":"Минимальное значение скидки"}}},"RecipientPriceSchema":{"type":"object","properties":{"amount":{"title":"amount","type":"number","format":"decimal","description":"Стоимость сообщения за одного получателя"},"amountMinor":{"title":"amount_minor","type":"integer","format":"int64","description":"Стоимость сообщения за одного получателя в копейках"},"currency":{"title":"currency","type":"string","description":"Валюта"},"discountPercentage":{"title":"discount_percentage","type":"number","format":"decimal","description":"Процент скидки в десятичных долях"},"proposalType":{"enum":["discount","discountsFromPartners","helpWithMortgageDocument","legalSupportForDeal","readyToCompleteDeal","realEstateValuation","realtorSupportAtAnyStageOfDeal","specialMortgageTerms","submitYourPrice","viewingRealEstateProperty"],"type":"string","x-discount":"Предложение скидки по объявлению","x-readyToCompleteDeal":"Готов к быстрому проведению сделки","x-viewingRealEstateProperty":"Предложение о просмотре объекта недвижимости","x-legalSupportForDeal":"Предложение о юридическом сопровождении сделки","x-realtorSupportAtAnyStageOfDeal":"Предложение о помощи риелтора на любом этапе сделки","x-realEstateValuation":"Предложение об оценки стоимости недвижимости","x-specialMortgageTerms":"Предложение о специальных условиях по ипотеке от банков","x-helpWithMortgageDocument":"Предложение о Помощи в подготовке документов для ипотеки","x-discountsFromPartners":"Предложение о скидках от партнеров","x-submitYourPrice":"Предложить свою цену","description":"\n\t\n `discount`: Предложение скидки по объявлению\t\n `readyToCompleteDeal`: Готов к быстрому проведению сделки\t\n `viewingRealEstateProperty`: Предложение о просмотре объекта недвижимости\t\n `legalSupportForDeal`: Предложение о юридическом сопровождении сделки\t\n `realtorSupportAtAnyStageOfDeal`: Предложение о помощи риелтора на любом этапе сделки\t\n `realEstateValuation`: Предложение об оценки стоимости недвижимости\t\n `specialMortgageTerms`: Предложение о специальных условиях по ипотеке от банков\t\n `helpWithMortgageDocument`: Предложение о Помощи в подготовке документов для ипотеки\t\n `discountsFromPartners`: Предложение о скидках от партнеров\t\n `submitYourPrice`: Предложить свою цену"}},"required":["amount","amountMinor","currency","proposalType"]},"OfferParametersSchema":{"type":"object","properties":{"availableProposals":{"title":"available_proposals","type":"array","items":{"enum":["discount","discountsFromPartners","helpWithMortgageDocument","legalSupportForDeal","readyToCompleteDeal","realEstateValuation","realtorSupportAtAnyStageOfDeal","specialMortgageTerms","submitYourPrice","viewingRealEstateProperty"],"type":"string","x-discount":"Предложение скидки по объявлению","x-readyToCompleteDeal":"Готов к быстрому проведению сделки","x-viewingRealEstateProperty":"Предложение о просмотре объекта недвижимости","x-legalSupportForDeal":"Предложение о юридическом сопровождении сделки","x-realtorSupportAtAnyStageOfDeal":"Предложение о помощи риелтора на любом этапе сделки","x-realEstateValuation":"Предложение об оценки стоимости недвижимости","x-specialMortgageTerms":"Предложение о специальных условиях по ипотеке от банков","x-helpWithMortgageDocument":"Предложение о Помощи в подготовке документов для ипотеки","x-discountsFromPartners":"Предложение о скидках от партнеров","x-submitYourPrice":"Предложить свою цену","description":"\n\t\n `discount`: Предложение скидки по объявлению\t\n `readyToCompleteDeal`: Готов к быстрому проведению сделки\t\n `viewingRealEstateProperty`: Предложение о просмотре объекта недвижимости\t\n `legalSupportForDeal`: Предложение о юридическом сопровождении сделки\t\n `realtorSupportAtAnyStageOfDeal`: Предложение о помощи риелтора на любом этапе сделки\t\n `realEstateValuation`: Предложение об оценки стоимости недвижимости\t\n `specialMortgageTerms`: Предложение о специальных условиях по ипотеке от банков\t\n `helpWithMortgageDocument`: Предложение о Помощи в подготовке документов для ипотеки\t\n `discountsFromPartners`: Предложение о скидках от партнеров\t\n `submitYourPrice`: Предложить свою цену"},"description":"\n\t\n `discount`: Предложение скидки по объявлению\t\n `readyToCompleteDeal`: Готов к быстрому проведению сделки\t\n `viewingRealEstateProperty`: Предложение о просмотре объекта недвижимости\t\n `legalSupportForDeal`: Предложение о юридическом сопровождении сделки\t\n `realtorSupportAtAnyStageOfDeal`: Предложение о помощи риелтора на любом этапе сделки\t\n `realEstateValuation`: Предложение об оценки стоимости недвижимости\t\n `specialMortgageTerms`: Предложение о специальных условиях по ипотеке от банков\t\n `helpWithMortgageDocument`: Предложение о Помощи в подготовке документов для ипотеки\t\n `discountsFromPartners`: Предложение о скидках от партнеров\t\n `submitYourPrice`: Предложить свою цену"},"availableReceiversCount":{"title":"available_receivers_count","type":"integer","format":"int64","description":"Количество доступных получателей"},"discount":{"$ref":"#/components/schemas/DiscountSchema","description":"Скидка"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorSchema"},"description":"Список ошибок"},"offerId":{"title":"offer_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"Идентификатор объявления"},"recipientPrices":{"type":"array","items":{"$ref":"#/components/schemas/RecipientPriceSchema"},"description":"Список стоимостей сообщений за одного получателя для каждого типа предложения"}},"required":["availableProposals","availableReceiversCount","errors","offerId"]},"V1GetMailingParametersResponseSchema":{"type":"object","properties":{"common":{"$ref":"#/components/schemas/CommonParametersSchema"},"items":{"type":"array","items":{"$ref":"#/components/schemas/OfferParametersSchema"},"description":"Список параметров объявлений"}},"required":["common","items"]},"V1GetMailingParametersResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/V1GetMailingParametersResponseSchema","description":"Результат"}},"required":["operationId","result"]},"V1GetMailingParametersRequestSchema":{"type":"object","properties":{"offerIds":{"title":"offer_ids","type":"array","items":{"title":"offer_ids","type":"integer","format":"int64"},"x-sensitiveData":"pdnPublic","description":"Идентификаторы объявлений"}},"required":["offerIds"]},"ItemStatusSchema":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorSchema"},"description":"Ошибки"},"offerId":{"title":"offer_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"Идентификатор объявления"},"status":{"title":"status","type":"string","description":"Статус"}},"required":["errors","offerId","status"]},"V1CreateMailingsResponseSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemStatusSchema"},"description":"Предложения"}},"required":["items"]},"V1CreateMailingsResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/V1CreateMailingsResponseSchema","description":"Результат"}},"required":["operationId","result"]},"ItemSchema":{"type":"object","properties":{"discountValue":{"title":"discount_value","type":"integer","format":"int64","description":"Скидка"},"expireAt":{"title":"expire_at","type":"integer","format":"int64","description":"Срок действия предложения"},"offerId":{"title":"offer_id","type":"integer","format":"int64","x-sensitiveData":"pdnPublic","description":"Идентификатор объявления"},"proposalType":{"enum":["discount","discountsFromPartners","helpWithMortgageDocument","legalSupportForDeal","readyToCompleteDeal","realEstateValuation","realtorSupportAtAnyStageOfDeal","specialMortgageTerms","submitYourPrice","viewingRealEstateProperty"],"type":"string","x-discount":"Предложение скидки по объявлению","x-readyToCompleteDeal":"Готов к быстрому проведению сделки","x-viewingRealEstateProperty":"Предложение о просмотре объекта недвижимости","x-legalSupportForDeal":"Предложение о юридическом сопровождении сделки","x-realtorSupportAtAnyStageOfDeal":"Предложение о помощи риелтора на любом этапе сделки","x-realEstateValuation":"Предложение об оценки стоимости недвижимости","x-specialMortgageTerms":"Предложение о специальных условиях по ипотеке от банков","x-helpWithMortgageDocument":"Предложение о Помощи в подготовке документов для ипотеки","x-discountsFromPartners":"Предложение о скидках от партнеров","x-submitYourPrice":"Предложить свою цену","description":"\n\t\n `discount`: Предложение скидки по объявлению\t\n `readyToCompleteDeal`: Готов к быстрому проведению сделки\t\n `viewingRealEstateProperty`: Предложение о просмотре объекта недвижимости\t\n `legalSupportForDeal`: Предложение о юридическом сопровождении сделки\t\n `realtorSupportAtAnyStageOfDeal`: Предложение о помощи риелтора на любом этапе сделки\t\n `realEstateValuation`: Предложение об оценки стоимости недвижимости\t\n `specialMortgageTerms`: Предложение о специальных условиях по ипотеке от банков\t\n `helpWithMortgageDocument`: Предложение о Помощи в подготовке документов для ипотеки\t\n `discountsFromPartners`: Предложение о скидках от партнеров\t\n `submitYourPrice`: Предложить свою цену"},"receiversCount":{"title":"receivers_count","type":"integer","format":"int64","description":"Количество получателей"}},"required":["expireAt","offerId","proposalType","receiversCount"]},"V1CreateMailingsRequestSchema":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemSchema"},"description":"Предложения"}},"required":["items"]},"CalculateTariffsPromotionSchema":{"type":"object","properties":{"durationDays":{"title":"duration_days","type":"integer","format":"int64"},"price":{"title":"price","type":"number","format":"decimal","description":"Стоимость продвижения за период. Стоимость публикации не включает."},"type":{"enum":["premium","standard","top"],"type":"string","x-standard":"Стандарт","x-premium":"Премиум","x-top":"Топ","description":"\n\t\n `standard`: Стандарт\t\n `premium`: Премиум\t\n `top`: Топ"}},"required":["durationDays","price","type"]},"CalculateTariffsPublicationSchema":{"type":"object","properties":{"durationDays":{"title":"duration_days","type":"integer","format":"int64"},"price":{"title":"price","type":"number","format":"decimal"}},"required":["durationDays","price"]},"CalculateTariffsResponseSchema":{"type":"object","properties":{"currency":{"enum":["eur","rur","usd"],"type":"string","x-eur":"Евро","x-rur":"Рубль","x-usd":"Доллар","description":"\n\t\n `eur`: Евро\t\n `rur`: Рубль\t\n `usd`: Доллар"},"promotions":{"type":"array","items":{"$ref":"#/components/schemas/CalculateTariffsPromotionSchema"},"description":"Тарифы продвижения."},"publication":{"type":"array","items":{"$ref":"#/components/schemas/CalculateTariffsPublicationSchema"},"description":"Тарифы размещения. Список периодов: в текущей реализации ровно один элемент."}},"required":["currency","promotions","publication"]},"CalculateTariffsResponseSchemaWrapper":{"type":"object","properties":{"operationId":{"title":"operation_id","type":"string","format":"uuid","description":"ID запроса"},"result":{"$ref":"#/components/schemas/CalculateTariffsResponseSchema","description":"Результат"}},"required":["operationId","result"]},"CalculateTariffsUtilitiesTermsSchema":{"type":"object","properties":{"includedInPrice":{"title":"included_in_price","type":"boolean","description":"Включены ли коммунальные платежи в цену. Необязательное: отсутствие эквивалентно false."},"price":{"title":"price","type":"number","format":"double"}}},"CalculateTariffsBargainTermsSchema":{"type":"object","properties":{"currency":{"enum":["eur","rur","usd"],"type":"string","x-eur":"Евро","x-rur":"Рубль","x-usd":"Доллар","description":"\n\t\n `eur`: Евро\t\n `rur`: Рубль\t\n `usd`: Доллар"},"paymentPeriod":{"enum":["annual","monthly"],"type":"string","x-annual":"За год","x-monthly":"За месяц","description":"\n\t\n `annual`: За год\t\n `monthly`: За месяц"},"price":{"title":"price","type":"number","format":"double","description":"Цена продажи или ставка аренды из фида."},"priceType":{"enum":["all","hectare","sotka","squareMeter"],"type":"string","x-all":"Цена за все","x-squareMeter":"Цена за квадратный метр","x-sotka":"Сотка","x-hectare":"Гектар","description":"\n\t\n `all`: Цена за все\t\n `squareMeter`: Цена за квадратный метр\t\n `sotka`: Сотка\t\n `hectare`: Гектар"},"utilitiesTerms":{"$ref":"#/components/schemas/CalculateTariffsUtilitiesTermsSchema"}},"required":["currency","price"]},"CalculateTariffsCoordinatesSchema":{"type":"object","properties":{"lat":{"title":"lat","type":"number","format":"double","x-sensitiveData":"pdnClient"},"lng":{"title":"lng","type":"number","format":"double","x-sensitiveData":"pdnClient"}},"required":["lat","lng"]},"CalculateTariffsLandSchema":{"type":"object","properties":{"area":{"title":"area","type":"number","format":"double"},"areaUnitType":{"enum":["hectare","sotka"],"type":"string","x-hectare":"Гектар","x-sotka":"Сотка","description":"\n\t\n `hectare`: Гектар\t\n `sotka`: Сотка"}}},"CalculateTariffsRequestSchema":{"type":"object","properties":{"bargainTerms":{"$ref":"#/components/schemas/CalculateTariffsBargainTermsSchema"},"category":{"enum":["bedRent","buildingRent","buildingSale","businessSale","commercialLandRent","commercialLandSale","cottageRent","cottageSale","flatRent","flatSale","flatShareSale","freeAppointmentObjectRent","freeAppointmentObjectSale","garageRent","garageSale","houseRent","houseSale","houseShareRent","houseShareSale","industryRent","industrySale","landSale","newBuildingFlatSale","officeRent","officeSale","roomRent","roomSale","shoppingAreaRent","shoppingAreaSale","townhouseRent","townhouseSale","warehouseRent","warehouseSale"],"type":"string","x-bedRent":"Койко-место, аренда","x-buildingRent":"Здание, аренда","x-buildingSale":"Здание, продажа","x-businessSale":"Готовый бизнес, продажа","x-commercialLandRent":"Коммерческая земля, аренда","x-commercialLandSale":"Коммерческая земля, продажа","x-cottageRent":"Коттедж, аренда","x-cottageSale":"Коттедж, продажа","x-flatRent":"Квартира, аренда","x-flatSale":"Квартира, продажа","x-flatShareSale":"Доля в квартире, продажа","x-freeAppointmentObjectRent":"Помещение свободного назначения, аренда","x-freeAppointmentObjectSale":"Помещение свободного назначения, продажа","x-garageRent":"Гараж, аренда","x-garageSale":"Гараж, продажа","x-houseRent":"Дом/дача, аренда","x-houseSale":"Дом/дача, продажа","x-houseShareRent":"Часть дома, аренда","x-houseShareSale":"Часть дома, продажа","x-industryRent":"Производство, аренда","x-industrySale":"Производство, продажа","x-landSale":"Участок, продажа","x-newBuildingFlatSale":"Квартира в новостройке, продажа","x-officeRent":"Офис, аренда","x-officeSale":"Офис, продажа","x-roomRent":"Комната, аренда","x-roomSale":"Комната, продажа","x-shoppingAreaRent":"Торговая площадь, аренда","x-shoppingAreaSale":"Торговая площадь, продажа","x-townhouseRent":"Таунхаус, аренда","x-townhouseSale":"Таунхаус, продажа","x-warehouseRent":"Склад, аренда","x-warehouseSale":"Склад, продажа","description":"\n\t\n `bedRent`: Койко-место, аренда\t\n `buildingRent`: Здание, аренда\t\n `buildingSale`: Здание, продажа\t\n `businessSale`: Готовый бизнес, продажа\t\n `commercialLandRent`: Коммерческая земля, аренда\t\n `commercialLandSale`: Коммерческая земля, продажа\t\n `cottageRent`: Коттедж, аренда\t\n `cottageSale`: Коттедж, продажа\t\n `flatRent`: Квартира, аренда\t\n `flatSale`: Квартира, продажа\t\n `flatShareSale`: Доля в квартире, продажа\t\n `freeAppointmentObjectRent`: Помещение свободного назначения, аренда\t\n `freeAppointmentObjectSale`: Помещение свободного назначения, продажа\t\n `garageRent`: Гараж, аренда\t\n `garageSale`: Гараж, продажа\t\n `houseRent`: Дом/дача, аренда\t\n `houseSale`: Дом/дача, продажа\t\n `houseShareRent`: Часть дома, аренда\t\n `houseShareSale`: Часть дома, продажа\t\n `industryRent`: Производство, аренда\t\n `industrySale`: Производство, продажа\t\n `landSale`: Участок, продажа\t\n `newBuildingFlatSale`: Квартира в новостройке, продажа\t\n `officeRent`: Офис, аренда\t\n `officeSale`: Офис, продажа\t\n `roomRent`: Комната, аренда\t\n `roomSale`: Комната, продажа\t\n `shoppingAreaRent`: Торговая площадь, аренда\t\n `shoppingAreaSale`: Торговая площадь, продажа\t\n `townhouseRent`: Таунхаус, аренда\t\n `townhouseSale`: Таунхаус, продажа\t\n `warehouseRent`: Склад, аренда\t\n `warehouseSale`: Склад, продажа"},"coordinates":{"$ref":"#/components/schemas/CalculateTariffsCoordinatesSchema"},"land":{"$ref":"#/components/schemas/CalculateTariffsLandSchema"},"totalArea":{"title":"total_area","type":"number","format":"double","description":"Общая площадь объекта."}},"required":["bargainTerms","category","coordinates"]}}}}