{ "componentChunkName": "component---src-templates-doc-page-js", "path": "/docs/ru/JS_API/built_in_services/pushgate/createPushback/", "result": {"data":{"site":{"siteMetadata":{"title":"Gatsby-doc-engine"}},"markdownRemark":{"id":"3f852904-c4d4-547d-8459-0b3f10ce2057","excerpt":"$pushgate.createPushback Метод создает специальную сущность для обработки событий — пушбэк.?> Пушбэк используется для отправки событий в сценарий при каких-либо…","html":"

$pushgate.createPushback

\n
\n

Метод создает специальную сущность для обработки событий — пушбэк.

\n

Пушбэк используется для отправки событий в сценарий при каких-либо действиях в стороннем сервисе. Таким образом при помощи бота становится возможным создавать исходящие рассылки.

\n

Рассмотрим принцип работы пушбэков:

\n
    \n
  1. В сценарии вызывается метод $pushgate.createPushback. При вызове в метод передаются идентификаторы нужного диалога и строка, определяющая тип события, например myEvent.
    2. \n
  2. Пушбэк регистрируется в платформе. Ему присваивается уникальный идентификатор pushbackId, который можно использовать в запросах к методам GET и POST /push_{pushbackId} Pushgate API.
    3. \n
  3. Когда в стороннем сервисе происходит событие, о котором необходимо уведомить клиента при помощи бота, сервис делает HTTP-запрос к методу /push_{pushbackId}, чтобы активировать пушбэк.
    4. \n
  4. Пушбэк генерирует в диалоге с клиентом заданное ранее событие myEvent, которое можно обработать при помощи тега event и отправить нужную информацию в диалог.
    5. \n
\n

Пушбэк привязан к диалогу с клиентом в определенном канале. Чтобы клиент получал уведомления в нескольких каналах, он должен дойти до соответствующего места сценария в каждом из них.

\n
\n

Синтаксис

\n

Принимаемые аргументы

\n

Метод $pushgate.createPushback принимает 5 аргументов. Все аргументы являются обязательными.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
АргументОписаниеПример
channelTypeТип каналаchatwidget
botIdИдентификатор бота3609248-mybot-3609248-drF-2325272
chatIdИдентификатор пользователя747078ed-d270-5664-62bf-0a933b43a15f
eventНазвание событияnewNotification
eventDataДанные, переданные вместе с событием{\"text\": \"Скидка только для вас!\"}
\n
\n

Возвращаемое значение

\n

Метод возвращает объект, в котором как поля содержатся все аргументы, переданные при вызове, а также 3 дополнительных поля, описывающие созданный пушбэк.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ПолеОписаниеПример
idИдентификатор96190b45-84ee-4007-9aab-d257ad22729f
linkСсылка для активацииhttps://{hostName}/push_a6c7ed8b-278c-4b85-9c07-14d5d8b6308a
createdВремя создания2021-03-24 15:31:43.059
\n
\n

Идентификация диалога

\n

Аргументы channelType, botId и chatId определяют диалог, в который в дальнейшем будут отправляться события.

\n

Предполагаемое поведение по умолчанию — отправка событий в тот же самый диалог, из которого был создан пушбэк. Чтобы реализовать стандартное поведение, передавайте в качестве данных аргументов поля объекта $request: $request.channelType, $request.botId и $request.channelUserId.

\n
\n

Название события

\n

Аргумент event задает название события, которое будет генерировать пушбэк при обращении к методу /push_{pushbackId}.

\n

Не рекомендуется создавать события, чьи названия совпадают с уже существующими системными событиями: они будут обрабатываться некорректно.

\n
\n

Передача данных с событием

\n

Когда в сценарий приходит событие, которое сгенерировал пушбэк, вместе с ним можно передать произвольный объект JSON с любыми вспомогательными данными.

\n

Для этого используйте для активации пушбэка метод POST /push_{pushbackId} и передайте нужные данные в теле HTTP-запроса.

\n

Из сценария данные доступны обработчику события в поле $request.rawRequest.eventData.

\n

Также вспомогательные данные можно задать при создании пушбэка, передав объект с данными как последний аргумент eventData. Эти данные будут по умолчанию передаваться в следующих случаях:

\n\n
\n

Пример

\n

Приведем пример использования метода для рассылки рекламных сообщений.

\n
state: SubscribeOffer\n    # ...\n    a: Хотите подписаться на нашу рассылку?\n\n    state: Subscribe\n        intent: /Согласие\n        intent!: /Подписаться\n        script:\n            # Создание пушбэка.\n            var pushback = $pushgate.createPushback(\n                $request.channelType,\n                $request.botId,\n                $request.channelUserId,\n                \"newNotification\",\n                {}\n            );\n\n            # Отправка ссылки на Pushgate API в сторонний сервис.\n            $http.post(\"https://example.com/subscribe\", {\n                headers: {\n                    \"Content-Type\": \"application/json\"\n                },\n                body: {\n                    \"link\": pushback.link\n                }\n            });\n        a: Ура, вы подписаны! Теперь вы будете первым узнавать о наших акциях и предложениях.\n\n# Включен флаг noContext, чтобы при получении нового уведомления контекст диалога не менялся.\nstate: NewNotification || noContext = true\n    event!: newNotification\n    if: $request.rawRequest.eventData && $request.rawRequest.eventData.text\n        a: Новое предложение только для вас! {{$request.rawRequest.eventData.text}}
\n
\n
    \n
  1. Когда клиент соглашается подписаться на рассылку, он попадает в стейт Subscribe. В обработчике стейта создается пушбэк, генерирующий событие newNotification.
    2. \n
  2. Этот же обработчик отправляет ссылку на пушбэк в сторонний сервис, который добавит ее в рассылку регулярных уведомлений.
    3. \n
\n

Сервис должен сам реализовать логику добавления пушбэка в рассылку.

\n
    \n
  1. Теперь, когда нужно будет отправить подписанным пользователям новое уведомление, сторонний сервис должен отправить, например, такой запрос к Pushgate API:
    2. \n
\n
curl --request POST 'https://{hostName}/push_{pushbackId}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n    \"text\": \"Только 25 марта на все тарифы JAICP скидка 20%!\"\n}'
\n
    \n
  1. При получении запроса пушбэк сгенерирует событие newNotification, которое будет обработано в сценарии. При корректном запросе пользователь получит уведомление о новой акции:
    2. \n
\n
\n \n Поскольку идентификатор пушбэка не меняется, ссылка на метод /push_{pushbackId} остается доступной и для последующих рассылок.

","frontmatter":{"title":"","description":null},"headings":[{"value":"$pushgate.createPushback"}]}},"pageContext":{"slug":"/docs/ru/JS_API/built_in_services/pushgate/createPushback/","previous":{"fields":{"slug":"/docs/ru/JS_API/built_in_services/pushgate/pushgate/"},"frontmatter":{"title":"","description":null}},"next":{"fields":{"slug":"/docs/ru/JS_API/built_in_services/pushgate/cancelEvent/"},"frontmatter":{"title":"","description":null}}}}, "staticQueryHashes": ["1209419333"]}