Действия с подписчиком BotHelp'a напрямую из GetCourse

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

Действие выполнится для пользователей, которые уже являются подписчиками нужного канала в Bothelp.

Список доступных действий:

• Добавить подписчику метку
• Удалить метку у подписчика
• Изменить значение пользовательского поля подписчика
• Добавить подписчика в авторассылку
• Удалить подписчика из авторассылки
• Добавить подписчика в бота на определенный шаг
• Удалить подписчика из бота (остановить бота для подписчика)

Вызов каждого действия происходит с помощью специальной ссылки, которую необходимо вставить в блок "Операция" в настроенный процесс в GetCourse.

Список ссылок для действий

Для настройки всех действий Вам понадобится SecretKey BotHelp, а для отдельных действий - Ref шага, Ref бота и Ref авторассылки. Инструкции о том, где и как получить эти данные будут ниже.

• Добавить подписчику метку [add_tag]
  • При выполнении этого действия указанному подписчику BotHelp добавляется указанная метка
  • ВАЖНО! Метка с таким названием уже должна быть создана в Вашем кабинете BotHelp. В противном случае указанному подписчику метка добавлена не будет.
  • ВАЖНО! В названии метки не рекомендуется использовать кириллицу и специальные символы (!, ?, # и т.д.).
    
    Для корректной работы ссылки такие названия меток необходимо кодировать, например, тут. В ссылку вставляйте уже закодированное значение. Если название метки на англ. языке - кодирование не требуется

https://gc.bothelp.io?domain_name={%Ваш домен в Bothelp%}&token={%Ваш SecretKey из кабинета BotHelp%}&email={object.user.email}&phone={object.user.phone}&actions[add_tag]={%Название метки из кабинета BotHelp%}

• Удалить метку у подписчика [del_tag]
  • При выполнении этого действия у указанного подписчика BotHelp удаляется указанная метка.
    В названии метки не рекомендуется использовать кириллицу и специальные символы (!, ?, # и т.д.)↑ ↑ ↑

https://gc.bothelp.io?domain_name={%Ваш домен в Bothelp%}&token={%Ваш SecretKey из кабинета BotHelp%}&email={object.user.email}&phone={object.user.phone}&actions[del_tag]={%Название метки из кабинета BotHelp%}

• Изменить значение пользовательского поля подписчика [set_field]
  • При выполнении этого действия у указанного подписчика BotHelp в указанном поле задается новое значение.
    В названии и значении поля аналогично меткам не рекомендуется использовать кириллицу и специальные символы (!, ?, # и т.д.). О способах кодировки можно почитать выше ↑ ↑ ↑

https://gc.bothelp.io?domain_name={%Ваш домен в Bothelp%}&token={%Ваш SecretKey из кабинета BotHelp%}&email={object.user.email}&phone={object.user.phone}&actions[set_field]={%Название поля%}&actions[set_field_value]={%Значение поля%}

• Добавить подписчика в авторассылку  [add_to_funnel] 
  • При выполнении этого действия указанный подписчик BotHelp добавляется в указанную авторассылку
  • Для определения авторассылки, в которую нужно добавить подписчика, в ссылке необходимо указать ее Ref вместо текста  {%Ref вашей авторассылки%}  Как получить Ref авторассылки - смотрите инструкцию ниже. ↓ ↓ ↓ 

https://gc.bothelp.io?domain_name={%Ваш домен в Bothelp%}&token={%Ваш SecretKey из кабинета BotHelp%}&email={object.user.email}&phone={object.user.phone}&actions[add_to_funnel]={%Ref вашей авторассылки%}

• Удалить подписчика из авторассылки [remove_from_funnel] 
  • При выполнении этого действия указанный подписчик BotHelp удаляется из указанной авторассылки. Подписчик больше не будет получать сообщения из этой авторассылки
  • Для определения авторассылки, из которой нужно удалить подписчика, в ссылке необходимо указать ее Ref вместо текста  {%Ref вашей авторассылки%} . Как получить Ref авторассылки - смотрите инструкцию ниже↓ ↓ ↓ 

https://gc.bothelp.io?domain_name={%Ваш домен в Bothelp%}&token={%Ваш SecretKey из кабинета BotHelp%}&email={object.user.email}&phone={object.user.phone}&actions[remove_from_funnel]={%Ref вашей авторассылки%}

• Добавить подписчика в бота на определенный шаг [run_bot]
  • При выполнении этого действия указанный подписчик BotHelp добавляется в указанного многошагового бота на конкретный шаг бота
  • Для определения бота и шага, куда нужно добавить подписчика, в ссылке необходимо указать их Ref`ы вместо текста  {%Ref вашего бота%}  и  {%Ref шага вашего бота%} . Как получить Ref бота и его шага - смотрите инструкцию ниже ↓ ↓ ↓ 
  • Если в ссылке не добавлять поле для Ref шага, то для подписчика по умолчанию бот будет запускаться с первого шага "Старт"
  • Если в ссылке указать некорректный Ref шага (например, шаг удалили), то для подписчика по умолчанию бот будет запускаться с первого шага "Старт"
    
    Рекомендуем в названии шага в боте делать пометку о том, что данный шаг участвует в интеграции.

https://gc.bothelp.io?domain_name={%Ваш домен в Bothelp%}&token={%Ваш SecretKey из кабинета BotHelp%}&email={object.user.email}&phone={object.user.phone}&actions[run_bot]={%Ref вашего бота%}&actions[step_ref]={%Ref шага вашего бота%}

• Удалить подписчика из бота (остановить бота для подписчика) [stop_bot]
  • При выполнении этого действия указанный подписчик BotHelp удаляется из многошагового бота. Работа бота останавливается только для этого подписчика
  • Для определения бота, из которого нужно удалить подписчика, в ссылке необходимо указать его Ref вместо текста  {%Ref вашего бота%}. Как получить Ref бота - смотрите инструкцию ниже ↓ ↓ ↓ 

https://gc.bothelp.io?domain_name={%Ваш домен в Bothelp%}&token={%Ваш SecretKey из кабинета BotHelp%}&email={object.user.email}&phone={object.user.phone}&actions[stop_bot]={%Ref вашего бота%}

Зачем эти ссылки?

С помощью этих ссылок Getcourse отправляет данные о подписчике и типе действия, чтобы BotHelp мог выполнить указанное действие с указанным подписчиком

В ссылке указываются необходимые данные о подписчике и действии:

• idBotHelp - это уникальный идентификатор подписчика в базе BotHelp, по которому Bothelp находит конкретного подписчика в своей базе. В кабинете BotHelp в карточке  подписчика это поле называется CUID. Это обязательное поле при идентификации подписчика по CUID
• domain_name- название вашего кабинета в Bothelp. По этому полю Bothelp понимает, в каком именно кабинете искать подписчика с такой почтой, а также сверяет его с указанным SecretKey (token). Это обязательное поле
  • В ссылке в параметре domain_name вместо текста  {%Ваш домен в Bothelp%} необходимо указать домен вашего кабинета в Bothelp. Фигурные скобки {} и знаки  процента % нужно удалить. Итоговая запись будет в таком формате: domain_name=mybhaccount 
• BotHelp SecretKey/token- это секретный ключ вашего кабинета BotHelp, который обеспечивает безопасность работы интеграции. Это обязательное поле
  • В ссылке в параметре token    вместо текста  {%Ваш SecretKey из кабинета BotHelp%} необходимо указать BotHelp SecretKey из настроек интеграции вашего кабинета. Фигурные скобки {} и знаки  процента % нужно удалить. Итоговая запись будет в таком формате: token=qwerty123456 
• email - это почта подписчика. По ней Bothelp находит конкретного подписчика в своей базе. Это обязательное поле при идентификации подписчика по email
• phone - телефон подписчика. По нему Bothelp также может найти конкретного подписчика в своей базе, если по почте находится несколько подписчиков. Это необязательное поле
• actions[]- параметр, который обозначает тип действия, которое нужно выполнить с подписчиком. Это обязательное поле
  • В ссылке в параметре actions[] вместо текста {%Текст зависит от конкретного действия%} необходимо без фигурных скобок {} и знаков процента % указать необходимое значение. Итоговая запись будет в таком формате: actions[add_tag]=metka  (пример для действия добавления метки подписчику)

ВАЖНО! Для идентификации подписчика BotHelp по его CUID  вместо полей email={object.user.email}&phone={object.user.phone} нужно записать  idBotHelp={object.user.bothelp_id} .
Для этого способа идентификации необходимо сначала передать CUID подписчика из BotHelp в GetCourse. Как это сделать читайте в этой инструкции.

CUID (customer user id) - это уникальный идентфикатор подписчика в платформе BotHelp. Его значение можно найти в профиле подписчика в графе "CUser ID"

ВАЖНО! Для полей email, phone и idBotHelp есть два варианта записи. Вариант зависит от типа настроенного процесса в GetCourse.

• Для процессов по Заказам: email={object.user.email}&phone={object.user.phone}  и   idBotHelp={object.user.bothelp_id} 
• Для процессов по Пользователям: email={object.email}&phone={object.phone}и   idBotHelp={object.bothelp_id} 
• Подробнее читайте в инструкции GetCourse

Как узнать SecretKey (token) BotHelp

• Перейдите в раздел "Настройки" в панели навигации вашего кабинета
• Откройте владку "Интеграции"
• Найдите блок GetCourse и нажмите кнопку "Добавить интеграцию"
• Скопируйте полученный BotHelp SecretKey - его нужно вставлять вместо текста  {%Ваш SecretKey из кабинета BotHelp%}  в ссылках 

Где узнать Ref бота и Ref шага

Ref бота:

• Перейдите в раздел "Боты" в панели навигации вашего кабинета
• Откройте нужного бота
• Нажмите на кнопку настроек "Шестеренка" в верхнем правом углу
• Нажмите на подпункт "Настройки"
• В открывшемся окне разверните "Дополнительные настройки"
• В самом низу открывшегося окна найдите поле с названием "Ref бота" - это идентификатор бота
• Скопируйте этот идентификатор - его нужно вставлять вместо текста  {%Ref вашего бота%}  в ссылках 

Ref шага:

• Перейдите в раздел "Боты" в панели навигации вашего кабинета
• Откройте нужного бота
• Перейдите в режим редактирования бота, кликнув на кнопку "Редактировать" в верхнем правом углу
  
• Откройте панель редактирования нужного Вам шага
• Ref шага отображается в верхней части панели под названием шага - это идентификатор этого шага
• Скопируйте этот идентификатор - его нужно вставлять вместо текста {%Ref шага вашего бота%}  в ссылках 

Где узнать Ref авторассылки

• Создайте или откройте уже существующую авторассылку
• Нажмите на кнопку "Настройки" в верхнем правом углу

• В самом низу открывшегося окна найдите поле с названием "Ref" - это идентификатор авторассылки
• Скопируйте этот идентификатор - его нужно вставлять вместо текста {%Ref вашей авторассылки%}  в ссылках 
  • Значение, которое нужно скопировать в нашем примере: f1667053874594   

Если вы не нашли ответ на свой вопрос, задайте его нам в чате внутри кабинета либо напишите на hello@bothelp.io 😃

Получите 14 дней полного функционала платформы для создания рассылок, автоворонок и чат-ботов BotHelp:

Получить 14 дней бесплатно