Шорткоды

Шорткоды – это конструкции, которые позволяют гибко использовать различные типы сообщений. С их помощью можно выполнять какое-либо действие непосредственно в текстовом сообщении. Они могут быть использованы в роботах, бизнес-процессах, в карточке CRM, в чатах и группах для отправки приложением OLChat файлов, голосовых сообщений, ссылок, визиток и месторасположения.

Функционал превью для ссылки временно не работает! Мы работаем над этой возможностью.

Ниже представлен список поддерживаемых шорткодов:

Описание	Шорткод	Условные обозначения
Файл с диска	[=disk:file_id]	file_id – id файла на Битрикс.Диск. Желательно использовать файлы из Общей папки
Файл по ссылке	[=file:url]	url – прямая ссылка на файл
Файл из поля crm	[=crm_file:<crm_type>|<crm_id>|field]	crm_type – тип сущности crm_id – ИД сущности field – ИД поля в сущности
Файл из прикрепленного файла поля crm	[=crm_file:file_id]	file_id – id прикрепленного файла поля CRM
Голосовое по ссылке	[=voice:url]	url – прямая ссылка на файл
Голосовое из поля crm	[=crm_voice:<crm_type>|<crm_id>|field]	crm_type – тип сущности crm_id – ИД сущности field – ИД поля в сущности
Голосовое из прикреплённого файла поля 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 файла читайте здесь.

Варианты использования шорткодов:

• Быстрые ответы в чате

• В шаблонах сообщений в приложении

• В роботах и бизнес-процессах

• В карточке сущности в виджете

Шорткоды следует использовать без угловых скобок < > и << >>. Скобки указывают на обязательность и необязательность значений, содержащихся внутри скобок.

Шорткоды просто дают возможность в одном сообщении указывать последовательность отправки, но это не означает, что всё будет отправлено в одном шаблоне.

Значения, указанные в одинарных угловых скобках, вида: <___> – являются обязательными к заполнению. Без указания данных значений, шорткод корректно не отработает!

Значения, указанные в двойных угловых скобках, вида: <<preview_link>>, <<description>> и т. д. не обязательны к заполнению. Их отсутствие не повлияет на корректную работу шорткода.

Пример использования шорткодов

Предположим, что нам необходимо отправить карту с местоположением, заданным координатами широты и долготы. Для этого воспользуемся шорткодом Месторасположение: [=location:<lat>|<lng>|<address>|<<address_2>>]

Подготовим конструкцию для отправки:

1. Вместо <lat> подставим значение: 50.260704. Это координата широты.

2. Вместо <lng> подставим значение: 127.537495. Это координата долготы.

3. Вместо <address> напишем адрес места. В нашем случае это: Зейская улица, 173.

4. Параметр <<address_2>> является необязательным, его можно оставить незаполненным либо дописать дополнительный текст адреса: Благовещенск, Амурская область.

Соберём подготовленные данные в единое целое:

[=location:50.260704|127.537495|Зейская улица, 173|Благовещенск, Амурская область]

Полученный шорткод отправим клиенту, используя виджет в карточке сделки

В результате, в WhatsApp придёт сообщение такого вида:

Используя роботы и активити бизнес-процессов, данную конструкцию шорткода можно собирать и отправлять в автоматическом режиме, указывая в значениях переменные и поля, откуда робот или активити должны взять информацию.