Азиз

API Gateway: Что это и как пользоваться?

2024-10-05T19:06:28.431Z

Автор: @RDGlessons

Сегодня Telegram выпустил обновление Telegram API — Gateway API. Оно представлено как инструмент, способный заменить СМС-верификации. В этой статье мы расскажем о преимуществах, разберём, как пользоваться, и реализуем интеграцию.

Основные особенности:

Мгновенная доставка кодов верификации.
Цена в ~$0.01 за сообщение, что в ~50 раз ниже средней цены за СМС*
100% процентная доставка сообщения.
Отчёты о прочтении и доставке

Но есть и большой минус: минимальная сумма пополнения составляет $100, причём оплата возможна только в TON.

*В целях тестирования вы сможете отправлять бесплатные проверочные сообщения на аккаунт Telegram, привязанный к номеру, который вы использовали для входа.

Инструкция по настройке:

Авторизация:

Для начала необходимо получить уникальный API токен, для отправки кодов верификации. Перейдите в Gateway account, авторизуйтесь по номеру Telegram и скопируйте API токен:

Отправка кодов через PuzzleBot:

Создайте Интегрированную переменную во вкладке Переменные в PuzzleBot

Заполните поле "Ссылка" данной ссылкой:
https://gatewayapi.telegram.org/sendVerificationMessage

Выберите тип запроса GET или POST

Добавьте заголовки:

Authorization: Bearer ТОКЕН

Замените ТОКЕН на действующий токен, полученный ранее.

Добавьте параметры:

phone_number - обязательно - номер телефона получателя кода в международном формате E. 164
code - необязательно - код, который будет отправлен получателю. Код может состоять только от 4 до 8 цифр.
code_length - необязательно (используется только если отсутствует поле code) - длина кода, который будет сгенерирован Telegram, от 4 до 8 символов.
sender_username - необязательно - юзернейм публичного канала, от чьего имени придёт код получателю. Канал который вы укажите должен принадлежать вашему аккаунту.
ttl - необязательно - количество секунд, после которых код будет удалён/деактивирован. Код удаляется только если сообщение с кодом не прочитано на момент удаления.
callback_url - необязательно - адрес вебхука, который получит обновления сообщения: статус доставки и прочтение.
request_id - необязательно - айди предыдущего сообщения, отправленного на этот же номер. Если всё указано верно - деньги с баланса за отправленное сообщение считываться не будут.

Возвращаемый ответ:

JSON:

[
  {
    "ok": true,
    "result": {
      "request_id": "1234567890",
      "phone_number": "1234567890",
      "request_cost": 0,
      "remaining_balance": 0,
      "delivery_status": {
        "status": "sent",
        "updated_at": 123456789
      }
    }
  }
]

Подробнее с документацией можно ознакомиться здесь.

Работа с HTTP в PuzzleBot

2024-06-26T17:44:27.009Z

Работа с HTTP запросами в сервисе PuzzleBot

Введение

HTTP запросы в PuzzleBot позволяют взаимодействовать с внешними сервисами и API. Это дает возможность интегрировать бота с различными системами, получать и отправлять данные, а также расширять функционал бота за счет использования внешних ресурсов.

Документация по работе с API

Возможности HTTP запросов в PuzzleBot

PuzzleBot поддерживает отправку HTTP запросов следующих типов:
- GET: Запрашивает данные с сервера. Наиболее часто используется для получения информации.
- POST: Отправляет данные на сервер для создания или обновления ресурса.
- DELETE: Удаляет указанный ресурс на сервере.
- PUT: Обновляет существующий ресурс или создает новый, если он не существует.
- PATCH: Вносит частичные изменения в существующий ресурс.

Типы запросов

Помимо типов запросов, PuzzleBot позволяет добавлять заголовки к запросам, что важно для авторизации и передачи дополнительных данных. По умолчанию PuzzleBot передаёт Content-type: multipart/form-data.

В адресе для отправки запросов можно указать переменные, обозначаемые двойными фигурными скобками {{variable}}.

Пример использования переменных и заголовков в PuzzleBo

Вызов HTTP запросов в PuzzleBot

Метод 1: Через действие в конструкторе

В конструкторе PuzzleBot можно настроить отправку HTTP запроса через окно Действия.

Метод 2: Через интегрированные переменные

Интегрированная переменная

Интегрированные переменные позволяют записать один параметр ответа в переменную. Вызов запроса осуществляется при любом действии с этой переменной.

Пример GET запроса

Пример использования GET запроса для получения данных с внешнего API.

Пример GET запроса

В данном примере мы отправляем запрос на api.puzzlebot.top, который вызовет в выбранном боте команду указанную в переменной {{text}} пользователю, указанному в переменной {{parameter_audience}}

В ответе мы получаем два параметра: code и description, мы можем выбрать один, для вывода ответа.

Работа с JSON для POST запросов

Для отправки данных с помощью POST запроса необходимо использовать формат JSON. JSON (JavaScript Object Notation) – это текстовый формат для передачи данных, состоящий из ключей и значений.

Пример JSON данных для POST запроса:

Пример POST запроса

JSON:

{
  "command_name": {{text}},
  "tg_chat_id": {{parameter_audience}}
}

Таким образом мы получаем те же ответы, что и в GET запросе.

Основы работы с JSON

JSON (JavaScript Object Notation) - это формат для передачи данных, который используется в веб-приложениях для обмена данными между клиентом и сервером. Он прост в чтении и записи как для человека, так и для машины.

Основные элементы JSON:

Объекты - заключены в фигурные скобки {} и состоят из пар "ключ: значение".
Массивы - заключены в квадратные скобки [] и содержат наборы значений.
Ключи - всегда строки, заключенные в двойные кавычки.
Значения - могут быть строками, числами, объектами, массивами, булевыми значениями (true/false) или null.

Пример JSON-объекта:

json

{
    "name": "Иван",
    "age": 25,
    "isStudent": true,
    "courses": ["математика", "информатика"],
    "address": {
        "city": "Москва",
        "zip": "123456"
    }
}

Заголовок Content-Type

Content-Type - это заголовок HTTP, который указывает на тип содержимого, передаваемого в HTTP-запросе или ответе. Он играет важную роль в определении формата данных, чтобы сервер и клиент могли правильно интерпретировать и обрабатывать передаваемую информацию.

Примеры значений заголовка Content-Type:

text/html - для передачи HTML-документов.
application/json - для передачи данных в формате JSON.
application/xml - для передачи данных в формате XML.
multipart/form-data - для передачи данных с несколькими частями, например, при загрузке файлов.
text/plain - для передачи данных в виде обычного текста.

Работа с HTTP запросами в PuzzleBot позволяет значительно расширить возможности бота и интегрировать его с внешними системами. Используя различные типы запросов и интегрированные переменные, можно создать мощные и гибкие решения.

Спасибо за внимание! Надеюсь, эта статья помогла вам разобраться в основах работы с HTTP запросами в PuzzleBot. Если у вас остались вопросы, не стесняйтесь задавать их в комментариях.

Больше уроков и статей ⚡️

Сегментация неактивных пользователей в чат-боте

2024-04-26T10:44:37.370Z

RDG team

Проводим сегментацию пользователей, которые не проявляли активности в боте более 7 дней и дольше.

Шаг 1: Создаём категорию

1. Откройте ЛК PuzzleBot → Выберите бот → Откройте вкладку "Категории" → Нажмите на кнопку "Создать категорию" → Введите название новой категории, в неё будут попадать неактивные пользователи.

Шаг 2: Создаём и настраиваем "Сценарий"

1. Откройте ЛК PuzzleBot → Выберите бот → Откройте вкладку "Сценарии" →

Нажмите на "Создать сценарий"

Создание сценария

2. Откройте сценарий и создайте пост:

Настраиваем пост

Не забудьте запланировать пост

3. Измените настройки сценария

Настройки сценария

Сохраните.

Шаг 3: Настраиваем конструктор

1. Откройте ЛК PuzzleBot → Выберите бот → Откройте вкладку "Конструктор"

2. Расставьте данное действие во все часто вызываемые команды

Действие в командах

Шаг 4: Тестируем

Бот будет добавлять пользователей, неактивных в течение 7 дней, в категорию "Неактивные"

Разбор сервиса PuzzleBot / Часть 2

2024-04-26T10:52:20.976Z

RDG team

Разбор сервиса «PuzzleBot»

Часть 2

Разбираем вкладку «Конструктор»

1. В конструкторе бота есть вкладка «Конструкор»

2. Заходим в неё, и видим, что там есть начальная структура, чтобы её удалить надо выделить область левой кнопкой мыши и зажать Shift, далее нажать на кнопку 🗑 и опубликовать изменения нажав на жёлтую кнопку в левом верхнем углу

3. У вас останется только команда "/start"

4. Чтобы настроить приветственный текст зайдите в эту команду, выберите тип блока, и вставьте те данные которые будет получать пользователь

Разбираем функцию «Действие»

1. В каждом типе команд есть такая менюшка с названием «Действия»

2. В команде под названием самой команды, возле текста "Действия" есть значок "›", далее нажимаем на кнопку "Добавить действие", и вам открывается список возможных действий

Там есть очень много действий, нг мы разберём самые первые и главные, по сути там все главные:

Вызов команды или условия - это действие вызывает команду или условие, после нажатия вы увидите ещё две функции, которых вы не найдёте в других сервисах, это функции:

• Выполнить другому дользователю - эта функция позволяет выполнить какое-либо действие для другого пользователя, можно вписать Telegram ID пользователя или Username пользователя (через "@")

• Отправить в ресурс - в начале разберём что такое ресурс: это группа или канал в котором состоит бот, и он был подтверждён администратором или владельцем бота (добавление ресурсов надо подтверждать вручную, или это можно автоматизировать в настройках бота, во вкладке "Добавление ресурсов", с этим разобрались, данная функция позволяет выполнить какое-либо действие в ресурсе, бещ использования каких-либо интеграций

Отправить случайную команду из группы команд - в сервисе есть такие вещи как: группы команд, они нужны не только для удобства, но и в них можно заложить определенные правила как:

• Проверка подписки на ресурс - название говорит само за себя, бот будет проверять подписан ли пользователь на определенные ресурсы, подключённые к боту, если нет то бот напишет пользователю сообщение указанное во вкладке «События» в боте, её мы тоже разберём

• Проверка категории - в сервисе есть такая вещь как «Категория», её можно создать и добавить туда определенных пользователей, и работать только с ними, это очень полузная вещь, она поможет автоматизировать многие процессы

Удать сообщение через время - это действие удаляет команду через укащанный срок

Удалить сообщение пользователя - данная вещь может удалить сообщение от пользователя при отправке которого была вызвана данная команда, в том числе и синонимы

Работа с Google Таблицами - данный сервис помогает работать с гугл таблицами, через бота, щаписывать туда данные, удалять, создавать листы и новые таблицы

Изменение категории - данная функция изменяет категорию пользователя

Отправить запрос - функция позволяет отправить запрос на сервис в качестве формата JSON

Есть ещё много действий но мы их разберём позже

Разбераем вкладку «Переменные»

1. Переменные это вещь которое имеет какое-либо значение, возьмём к примеру: переменная = ящик, ящик содержит вещь, вещью иожет быть:

Текст - любейший текст в том числе со смайликами

Число - переменная с таким типом может иметь в качестве значения только число и символы: "-", ".", в сервисе есть действия которые могут изменять значение переменных, переменные с типом "Число" могут: умножаться, прибавляться, делиться, вычитаться, или вовсе заменяться

Файл - переменные с таким типом могут иметь только видео, или фото, в качестве значения

Номер телефона - переменные с таким типом могут иметь значение из чисел, и символом: "+"

Формула - это переменная значение которой изменяемо, значение данной переменной зависит от правил заложенных в ней, к примеру:

Формула: random (100) - значения данной переменной будет иметь случайное значения от 1 до 100, всё зависит от самой формулы указанной в переменной

Есть два типа переменных, это:

Персональная - переменная которое имеет персональное значение у пользователя.

Глобальная - значение которой для всех едино.

Авторизация • Поддержать чашкой кофе

Разбор сервиса PuzzleBot / Часть 1

2024-04-26T10:52:22.954Z

ТехнологииБольше по теме

Разбор сервиса «PuzzleBot»

Это сервис для создания профессиональных чат-ботов без знаний программирования, в сервисе есть даже те возможности которые в частых случаях есть только на версии бота в качестве кода 🔥

Так как сервис большой я его разберу на несколько частей, и в каждой части будут несколько тем 😉

Часть 1

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

Вы уже авторизовались?

Тогда начнём изучать сервис 😉

Создаём бота:

1. Нажимаем на кнопку "Добавить бота" в личном кабинете

2. Вводим токен от бота из @BotFather

3. Ваш бот успешно подключён!

Разбор команд:

В данном сервисе есть 3 типа команд это:

Обычные команды - в них можно поместить что угодно дать им название, синонимы при вызове которых будет реагировать бот, можно создать форму ввода, блок списка, таймер, любые типы сообщений и т.д.

Инлайн команды - это те команды которые могут иметь только инлайн клавиатуру, но листаются они между собой плавно с анимацией, в инлайн кнопках можно разместить почти любые действия которые возможно в «Телеграмм»

Условие - условие это тип команды которые проверят наличие чего-то, или значение чего-то у кого-то, можно проверить значение переменной на определенные фразы, и если они есть выполнять определенные действия, а если нет то другие действия

Работать со структурой бота можно в разделе «Конструктор»

Авторизация • Поддержать чашкой кофе