chats

Зарегистрировать получателя вебхуков (v2)

С помощью метода можно подключить отправку вебхуков на переданный URL. В параметрах можно указать, какие сообщения передавать в хуке:

  • [offersMessagesIncoming] — все входящие сообщения по объявлениям;
  • [offersMessagesIncoming, offersMessagesLkOutgoing] — все входящие и исходящие по объявлениям, отправленные не через API;
  • [offersMessagesIncoming, offersMessagesLkOutgoing, offersMessagesApiOutgoing] — все входящие и все исходящие сообщения по объявлениям.
  • [newbuildingMessagesIncoming] - все входящие сообщения по новостройкам;
  • [newbuildingMessagesIncoming, newbuildingMessagesLkOutgoing] — все входящие и исходящие по новостройкам, отправленные не через API;
  • [newbuildingMessagesIncoming, newbuildingMessagesLkOutgoing, newbuildingMessagesApiOutgoing] — все входящие и все исходящие сообщения по новостройкам.
  • [systemMessages] — системные сообщения от Циан и модерации;
  • [chatsReadability] — вебхук о прочитанности чата;

Например:

  • [offersMessagesIncoming] — только входящие сообщения по объявлениям;
  • [offersMessagesIncoming, systemMessages] — только входящие по объявлениям и системные сообщения;
  • [offersMessagesIncoming, offersMessagesLkOutgoing, systemMessages] — все входящие и исходящие по объявлениям, отправленные не через API, а также системные сообщения от Циан и модерации.

<b>Важно!</b>

  • В вебхуке будут приходить все новые сообщения по всем чатам — это может быть одно или несколько сообщений.
  • Если в течение больше 72 часов не удается доставить сообщения на URL, он будет автоматически отключен.
  • В ответе метода указаны модели вебхуков, которые будут отправляться на указанные URL.

Пример:

curl -X POST -H 'Authorization: Bearer <ACCESS TOKEN>' https://public-api.cian.ru/v2/subscribe-webhooks --header 'Content-Type: application/json' --data-raw '{"url": "https://example.com", "webhookTypes": ["offersMessagesIncoming"]}'
post/v2/subscribe-webhooks

Request

  • Base URL: https://public-api.cian.ru
  • URL: https://public-api.cian.ru/v2/subscribe-webhooks
  • Auth: none declared

Request body

urlstring required

Ссылка для отправки веб-хука

webhookTypesstring[] required

offersMessagesIncoming: Веб-хук о новых входящих сообщениях по объявлениям offersMessagesApiOutgoing: Веб-хук о новых исходящих сообщениях по объявлениям отправленных по API offersMessagesLkOutgoing: Веб-хук о новых исходящих сообщениях по объявлениям отправленных из ЛК (web/mobile) newbuildingMessagesIncoming: Веб-хук о новых входящих сообщениях по объявлениям новостроек newbuildingMessagesApiOutgoing: Веб-хук о новых исходящих сообщениях по объявлениям новостроек отправленных по API newbuildingMessagesLkOutgoing: Веб-хук о новых исходящих сообщениях по объявлениям новостроек отправленных из ЛК (web/mobile) systemMessages: Веб-хук о новых системных сообщениях (ЦИАН, Модерация) chatsReadability: Веб-хук о прочитанности чатов

Response

OK

operationIdstring uuid required

ID запроса

Changes

No recorded changes to this operation across all 1 revision of this API.