> For the complete documentation index, see [llms.txt](https://metabot.gitbook.io/documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://metabot.gitbook.io/documentation/deep-linking-vneshnee-svyazyvanie.md). # Deep Linking / Внешнее связывание Принцип работы deep link (диплинка) прост, сформированная ссылка отправляет пользователя сразу на нужный маршрут в боте, минуя часть сценария ### Введение В контексте чат-ботов для мессенджеров и социальных сетей смысл диплинка заключается в создании унифицированного идентификатора ресурса (URI), который ссылается на определенный диалоговый сценарий в чат-боте, а не в простом запуске чат-бота сначала. Самым большим преимуществом диплинков является возможность для маркетологов и разработчиков направлять пользователей непосредственно в определенное место в своем чат-боте с помощью выделенной ссылки. В цифровом пространстве deep link можно использовать, например, для размещения на рекламных баннерах в социальных сетях, на веб-сайте для отслеживания переходов с уникальных мест, передача токена авторизации в бот прямо с сайта, можно отправить в личном сообщении и многое другое. Примеры внешнего связывания с вещами в физическом мире: deep link в виде QR на кассовом чеке, в котором содержится идентификатор транзакции, для приглашения пользователя в программу лояльности в чат-боте и начисления баллов за этот заказ; deep link на брошюре на столике в ресторане с вызовом официанта, содержащий номер столика; рекламные флаеры и буклеты; QR в секретном месте в квесте в парке развлечений; QR на объектах в музее или в спортзале и т.д. В каждом случае пользователь при открытии deep link попадет в чат-бот и активирует определенный сценарий, уникальный для этой конкретной ссылки. Через deep link в чат-бот можно передать параметры, например, токен заказа или идентификатор страницы, с которой совершен переход. Поддержка deep link реализована для каналов: * Прямая интеграция **VK** * Прямая интеграция **Telegram** * Интеграция через Umnico для **WhatsApp** * **Metabot Widget** ### Создание диплинка Первым шагом для настройки диплинков в новом боте является настройка **Каналов** бота. Настройка **Каналов** производится в разделе главного меню **Настройки бота** подраздел [**Каналы**](https://app.metabot24.com/bot-channel)**.** Например, в рассматриваемом боте настроены два канала: * Metabot Widget * Telegram Далее для настройки перейдем в раздел **Ссылки**, который служит для создания диплинка. Нужно создать **Ссылку** с типом ссылки *Ссылка на бот-скрипт (Deep Link)*, для этого перейти в раздел главного меню **Настройки бота** подраздел [**Ссылки**](https://app.metabot24.com/link). ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-Ma9-RfIx1WzFjLKd5KT%2F-Ma90wJo1Qt7D_plWRsL%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=8c99030c-efa4-411c-a506-2a1811943545) По имени, указанном в поле **Имя**, на диплинк можно ссылаться в макроподстановках. Формат ссылок, как имя диплинка - dpl1: * {{ ^#dpl1 }} - макроссылка, поддерживается в Маршрутах Текст из поля **Текст/приглашение** будет добавлен к сообщению пользователя в мессенджере при его переходе по диплинку. Используется только для мессенджера - WhatsApp.\ Поле **URL** остаётся не заполненным. Нажать кнопку ***Создать***. ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaT_rorWI25L5ah00ru%2F-MaTeoFXCBZcXULuK6pQ%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=9917e170-94bc-4bed-be69-335057a07b8a) ### Настройка маршрутов Для привязки диплинка к определённому скрипту бота следует создать маршрут со следующими настройками. Настроить маршруты можно в разделе главного меню **Настройки бота** подраздел [**Маршруты**](https://app.metabot24.com/route): * Опция ***Обработка Deep Link*** - установить активность; * Опция ***Действует в диалоге*** - установить активность, не обязательно для заполнения; * ***Название*** - текстовое наименование маршрута; * ***Скрипт*** - выбрать скрипт, который должен запускаться в данном маршруте; * ***Регулярное выражение*** - значение макроссылки {{ ^#имя\_диплинка }}, например, * {{ ^#dpl1 }} - было определено при создании ссылки диплинка. Нажать кнопку ***Создать***. ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaT_rorWI25L5ah00ru%2F-MaTftBDm7nWomRBCq8Z%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=89107cf0-0343-4da2-b018-c9ea58b5128f) Рекомендуется маршрут с диплинком разместить первым в списке всех маршрутов. Для этого можно воспользоваться кнопкой ***Перетащите для изменения порядка***, расположенной в блоке **Операции**. ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaTiNFBwtGtmuDICpB0%2F-MaTjn8jhcDt8HF85tyf%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=ecd774df-8158-4360-a089-a1cc4cf1aefa) ### Использование диплинков #### Внешние мессенджеры После создания ссылки автоматически создаётся уникальный хеш диплинка и происходит генерация URL для каждого мессенджера. ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaTkW0zNXzIfSlG-Vou%2F-MaTl9dn0p7om5Mrgu6b%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=051ebe1b-4a3e-4e2f-938d-5f8e761ee60b) Перечень мессенджеров определяется из того, к каким Каналам подключен данный бот. Вместо **{текста в фигурных скобках}** в URL диплинка следует указать соответствующий ID бота в мессенджере. **Пример для Telegram:** ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaTlo73GfOkbrkVBPNl%2F-MaTmG5zcqk8__lTuZ3o%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=50f24397-5c6f-451a-9119-454e13e2168e) В ссылке для Telegram бота - {имя-бота-telegram} - заменить на **deeplink\_test\_bot** ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaTlo73GfOkbrkVBPNl%2F-MaTn0J0vTgHaDd63cUz%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=d7c46bd6-eb93-4f74-9c73-fd13460f1804) После подстановки ссылку с данным URL можно размещать в интернете. При необходимости к ней можно добавить параметры, как это стандартно делается для http-ссылок. ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaTnoAGWHtL5BOTlo-Z%2F-MaTpFYL441Q5NWYBBx-%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=c542c739-bc39-4c37-be7f-e919b6613391) При переходе по такой ссылке происходит редирект на API соответствующего мессенджера, в нашем примере на Telegram. ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaTpH4Mo5_sJlxlUGP2%2F-MaTppVXccNuDrwLwzzs%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=f99311e4-8713-4334-b8c7-87a93823745c) Далее при нажатии *Send Message* тоже автоматически в мессенджер. После того, как пользователь отреагирует в мессенджере. В примере с Telegram, нажмёт кнопку ЗАПУСТИТЬ, все параметры, которые были указаны в диплинке будут сохранены в переменных соответствующего лида в разделе Лиды на платформе. Бот стартует со скрипта указанного в маршруте для диплинка. ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaTpH4Mo5_sJlxlUGP2%2F-MaTr9mdnUJb5O7fhVhG%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=fcaffbb9-9d04-4657-b32f-5163dac21f07) **Пример для WhatsApp:** Аналогичным образом настраивается ссылка для WhatsApp бота подключенного через интеграцию Umnico: {телефон-whatsapp} - заменить на номер телефона в формате 79ххххххххх ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaWyR73xWkJRbAKk8qM%2F-MaX3B5ubGwMYjvnece5%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=cef7916d-2fc1-4340-b9c1-181a664f45b3) После подстановки ссылку с данным URL можно размещать в интернете. При необходимости к ней можно добавить параметры, как это стандартно делается для http-ссылок. ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaWyR73xWkJRbAKk8qM%2F-MaX3sovx9KcRMxFCY-b%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=e52dbad5-91ce-4b88-8f9c-cd0c64e6fa86) При переходе по такой ссылке происходит редирект на API соответствующего мессенджера, в нашем примере на WhatsApp. ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaWyR73xWkJRbAKk8qM%2F-MaX5Xoyik304_Pikgfe%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=6bab015c-2be2-43e2-9256-e6d60b802265) Далее при нажатии *Перейти в чат* тоже автоматически в мессенджер. После того, как пользователь отреагирует в мессенджере. В примере с WhatsApp, нажмёт кнопку Отправки сообщения, произвойдет старт бота со скрипта указанного в маршруте для диплинка. ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaWyR73xWkJRbAKk8qM%2F-MaX4XherwAVGKXCeW5c%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=c1475441-f153-44ad-a734-1a1a7bc5b6a1) #### Metabot Widget Ключевым моментом здесь является задание атрибута *data-deeplink*. Шаблон ссылки-диплинка выводится в разделе **Ссылки**. При условии, что у бота подключен канал **Metabot Widget**. ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaTrRP0RSxwkMjkDcZE%2F-MaTtVVokPKbDhw2aSS4%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=30b95d71-cb89-4a68-a3ac-5b865f89da44) В настройках канала **Metabot Widget** в поле ***Всплывающий HTML*** можно задать HTML-код. В значении атрибута следует указать хеш, который был автоматически сгенерирован при создании диплинка. ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaTrRP0RSxwkMjkDcZE%2F-MaTuOcU7kBXgNUMByDb%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=afeb057f-8c75-4312-b952-d351940cd945) Описанный блок будет всплывать при наведении мышки на кнопку виджета. ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaTrRP0RSxwkMjkDcZE%2F-MaTui-J0Hm-P9uyqdQD%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=17756eea-54ba-4688-85f3-56ca0333d147) Для передачи дополнительных параметров с последующим сохранением их в параметрах Лида используются атрибуты ***href*** и ***data-deeplink*** тега гиперссылки. Например, после перехода по следующей гиперссылкеуказанной в настройках виджета: ``` ``` ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaTwkFDz4s1LcUIE5y4%2F-MaTz7zRz99QeB8oKEKy%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=8d600780-9b83-48db-9461-c5a12911c676) В разделе **Лиды** на платформе, по соответствующему лиду, будут переданы и сохранены в параметрах лида следующие параметры: * boom = bazz * utm-foo = bar ![](https://1621485802-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-Lof4a3yX4z_pjUWqMhw%2F-MaTwkFDz4s1LcUIE5y4%2F-MaTxzPS5Anbx8E5186l%2F%D0%B8%D0%B7%D0%BE%D0%B1%D1%80%D0%B0%D0%B6%D0%B5%D0%BD%D0%B8%D0%B5.png?alt=media\&token=e71e8d2a-1703-4be6-9ee3-53590c25879c)