Шорткоды
Шорткоды – это конструкции, которые позволяют гибко использовать различные типы сообщений. С их помощью можно выполнять какое-либо действие непосредственно в текстовом сообщении. Они могут быть использованы в роботах, бизнес-процессах, в карточке CRM (системы управления взаимоотношениями с клиентами), в чатах и группах для отправки приложением Олчат файлов, голосовых сообщений, ссылок, визиток и месторасположения (геометки).
Функционал превью для ссылки временно не работает. Наша команда уже работает над этой возможностью.
Ниже представлен список поддерживаемых шорткодов:
| Описание | Шорткод | Условные обозначения |
|---|---|---|
| Файл с диска | [=disk:file_id] | file_id – ID файла на Битрикс.Диск. Желательно использовать файлы из Общей папки |
| Файл по ссылке | [=file:url] | url – прямая ссылка на файл |
| Файл из поля crm | [=crm_file:crm_type|crm_id|field] | crm_type – тип сущности crm_id – ID сущности field – ID поля в сущности** |
| Файл из прикрепленного файла поля crm | [=crm_file:file_id] | file_id – ID прикрепленного файла поля CRM |
| Голосовое по ссылке | [=voice:url] | url – прямая ссылка на файл |
| Голосовое из поля crm | [=crm_voice:crm_type|crm_id|field] | crm_type – тип сущности crm_id – ID сущности field – ID поля в сущности** |
| Голосовое из прикреплённого файла поля crm | [=crm_voice:file_id] | file_id – ID прикрепленного файла поля CRM |
| Визитка | [=vcard:phone] | phone – номер телефона визитки |
| Ссылка с автосбором информации | [=link:url] | url – ссылка для отправки |
| Месторасположение | [=location:lat|lng|address|address_2] | lat – Широта lng – Долгота address – Адрес address_2 – вторая строка адреса |
| Ссылка на youtube-видео | [=youtube:v_code] | v_code – код видео |
** - ID поля в сущности field подставляется в следующем виде: UF_CRM_000000. О том, как узнать ID поля в сущности, написано здесь.
Значения, выделенные в таблице таким, таким и таким цветами, обязательны к заполнению для корректной работы шорткода.
Значения, выделенные в таблице данным цветом, не обязательны к заполнению. Их отсутствие не повлияет на корректную работу шорткода.
Подробнее про настройку отправки файла в зависимости от источника читайте здесь.
Варианты использования шорткодов:
- Быстрые ответы в чате.
- В шаблонах сообщений в приложении.
- В роботах и бизнес-процессах.
- В карточке сущности в виджете.
Шорткоды дают возможность в одном сообщении указывать последовательность отправки, но это не означает, что всё будет отправлено в одном шаблоне.
Пример использования шорткодов
Предположим, что нам необходимо отправить карту с местоположением, заданным координатами широты и долготы. Для этого воспользуемся шорткодом месторасположения: [=location:<lat>|<lng>|<address>|<<address_2>>].
Подготовим конструкцию для отправки:
- Вместо <lat> подставим значение: 50.260704. Это координата широты.
- Вместо <lng> подставим значение: 127.537495. Это координата долготы.
- Вместо <address> напишем адрес места. В нашем случае это: Зейская улица, 173.
- Параметр <<address_2>> является необязательным, его можно оставить незаполненным либо дописать дополнительный текст адреса: Благовещенск, Амурская область.
Соберём подготовленные данные в единое целое:
[=location:50.260704|127.537495|Зейская улица, 173|Благовещенск, Амурская область]
Полученный шорткод отправим клиенту, используя виджет в карточке сделки.
.png)
В результате в WhatsApp придёт сообщение такого вида:
.png)
Используя роботы и активити бизнес-процессов, данную конструкцию шорткода можно собирать и отправлять в автоматическом режиме, указывая в значениях переменные и поля, откуда робот или активити должны взять информацию.