Содержание
- Общие сведения
- Отправка сообщений
- Изменение переменных пользователя
- Запуск последовательности взаимодействия бота (по Hook)
- Примеры сочетания
- Примеры интеграции с Getcourse
- Получение ответов/переменных пользователя
- Стандартные ответы и ошибки
Если вы хотите, чтобы ваши боты осуществляли определенные действия от внешних сервисах, вы можете использовать встроенный API для отправки сообщений, изменений переменных пользователей и запуска последовательности взаимодействия бота определенного хука.
Hook — это специальное сообщение, отправляемое в чате пользователем или функция, к которой прикреплена последовательность элементов бота.
Одним из самых ярких примеров такого хука является "/start", который запускает взаимодействие с новым ботов в Телеграмм.
Это может пригодиться, например:
- если у вас есть внешний сервис для обработки клиентской базы, и вы хотите получать оттуда данные о пользователях, совершивших то или иное действие;
- если вы используете бота для совершения действий, зависящих от внешнего сервиса. Например, старт экзамена в getcourse служит началом для проведения тестирования с помощью бота;
Обратите внимание. Пользователь должен быть подписан на вашего бота, чтобы вы могли взаимодействовать.
Общие сведения
Запрос отправляется на индивидуальный URL, который доступен в разделе API в настройках каждого бота. Вы можете передавать ваши данные в качестве пераметров url с помощью GET запроса или в теле POST запроса, а также любой запрос с Plaintext JSON форматом данных. Возможные параметры для выбора пользователей:
- уникальный ID пользователя uid = "123321"
- или ID пользователя в нашей системе userid = "8082413414312343"
- (опционально) выбрать определенный тип мессенджера messenger = "T"
В случае, если пользователь по вашей ссылке подключил несколько мессенджеров или несколько людей перешли по одной ссылке, им будут присвоены идентичные уникальные ID пользователя, а сообщения будут отправляться на каждый из них.
Вам необходимо также отправлять параметры для осуществления действий, которые можно сочетать для выполнения нескольких задач в одном запросе:
- изменить переменные пользователя setdata массив
- отправить сообщение message = "Hello, kitty!"
- запустить последовательность взаимодействия бота определенного хука hook = "/start"
Отправка сообщений
Система поддерживает стандартные подстановочные значения, для их использования впишите переменную в таком виде {{название_переменной}} в нужном месте текста.
Пример GET запроса
Отправка сообщения "Всем привет!" пользователю 123321 через вашего бота осуществляется вызовом URL, указанного в настройках вашего бота.
Тело запроса для отправки сообщения в JSON
{ "uid":123321, "messenger":"T", "message":"Hello, kitty!" }
Изменение переменных пользователя
Напомним, что в глобальных переменных хранятся не только ответы пользователя, но и нужные вам параметры, которые вы можете использовать для подстановки в текстах, для выбора ветвлений и так далее. С помощью API вы можете изменять эти переменные.
За один запрос вы можете менять до 100 переменных, передавая их через массив ключ->значение в параметре setdata
Пример GET запроса
Изменение имени пользователя (user_name) на "Дмитрий" пользователю 123321 через вашего бота осуществляется вызовом URL, указанного в настройках вашего бота.
Тело запроса для отправки сообщения в JSON
{ "uid":123321, "messenger":"T", "setdata":{ "user_name":"Dmitry" } }
Запуск последовательности взаимодействия бота (по Hook)
Hook — это специальное сообщение, отправляемое в чате пользователем или функция, к которой прикреплена последовательность элементов бота. Одним из самых ярких примеров такого хука является "/start", который запускает взаимодействие с новым ботов в Телеграмм.
Допустим, вам необходимо запустить серию сообщений (вветку взаимодействия), посвященных празднику, которые вы повесили на hook "/holiday". Для создания такого hook используйте соответствующий элемент в визуальном редакторе.
Обратите внимание Бот не возвращается к начальной схеме работы после выполнения действий в запущенном хуке. Вам необходимо стрелкой соединить последний элемента с элементом в основной ветке взаимодействия.
Как создать чат-бота самому?
Пример GET запроса
Запуск действий по хуку /newexam пользователю 123321 через вашего бота осуществляется вызовом URL, указанного в настройках вашего бота.
Тело запроса для отправки сообщения в JSON:
{ "uid":123321, "messenger":"T", "hook":"/newexam" }
Примеры сочетания
Допустим, вам необходимо запустить серию сообщений после создания личного кабинета во внешней системе. Одновременно с этим вы записываете созданный вами пароль для доступа этому пользователю с именем и контактами преподавателя.
Соответствующий запрос будет содержать 2 параметра: "setdata[password]" и "hook".
Пример GET запроса
Запуск действий по хуку /newexam пользователю 123321 через вашего бота осуществляется вызовом URL, указанного в настройках вашего бота.
Тело запроса для отправки сообщения в JSON:
{ "uid":123321, "messenger":"T", "setdata":{ "password":"34ouhwesb43efwcd" }, "hook":"/newuser" }
Примеры интеграции с Getcourse
Допустим, вам необходимо отправить сообщение после старта программы в сервисе Getcourse с именем и контактами преподавателя. Вы выбираете задачу "вызвать URL", метод "GET" и указываете ссылку на наш сервис. В ссылке нужно указать адрес (URL) внешнего сервиса и перечислить данные, которые необходимо передать из GetCourse. Помните, что вам необходимо использовать верные переменные, чтобы вместо {object.training_teacher_full_name} в запросе передавалось имя преподавателя.
Мы используем одновременно изменение переменной и отправку сообщения ("Приветствуем на курсе. Вы можете обращаться к вашему преподавателю {{prepod}}") с использованием этой переменной. В поле URL в итоге вам надо передать:
Пример GET запроса URL_BOTA?uid=123321&setdata[prepod]={object.training_teacher_full_name}&message=%D0%9F%D1%80%D0%B8%D0%B2%D0%B5%D1%82%D1%81%D1%82%D0%B2%D1%83%D0%B5%D0%BC%20%D0%BD%D0%B0%20%D0%BA%D1%83%D1%80%D1%81%D0%B5.%20%D0%92%D1%8B%20%D0%BC%D0%BE%D0%B6%D0%B5%D1%82%D0%B5%20%D0%BE%D0%B1%D1%80%D0%B0%D1%89%D0%B0%D1%82%D1%8C%D1%81%D1%8F%20%D0%BA%20%D0%B2%D0%B0%D1%88%D0%B5%D0%BC%D1%83%20%D0%BF%D1%80%D0%B5%D0%BF%D0%BE%D0%B4%D0%B0%D0%B2%D0%B0%D1%82%D0%B5%D0%BB%D1%8E%20%7B%7Bprepod%7D%7D
Получение ответов/переменных пользователя
Напомним, что в глобальных переменных хранятся не только ответы пользователя, но и нужные вам параметры, которые вы можете использовать в работе бота. С помощью API вы можете получать эти переменные в JSON формате для своих нужд. Вы можете использовать all для получения всех данных или перечислить через запятую все нужные вам переменные.
Пример GET запроса
Получение всех данных пользователя 123321 через вашего бота осуществляется вызовом URL, указанного в настройках вашего бота.
Тело запроса для отправки сообщения в JSON:
{ "uid":123321, "getinfo":"all" }
Стандартные ответы и ошибки
В случае успешного выполнения вы получите ответ со статусом success.
{ "status":"success", "explain":null, "count":11 }
В случае ошибок вы получите ответ со статусом error и расшифровкой ошибок.
{ "status":"error", "explain":"Данных пользователя не найдено.", }
Вот и все. Пользуйтесь подсказками, смотрите образовательные видео и общайтесь с нашими ботами. А если возникнут вопросы - пишите в чат или на почту me@4study.pro
Вам также понравится
- Поделиться
Сэкономьте время на самостоятельном создании ботов
Хотите получить персональную демонстрацию сервиса, кейсы использования или персональную разработку бота? Оставьте заявку через нашего чат-бота или ознакомьтесь подробнее.
