Функции (API) в калькуляторе
Упрощенные вызовы API из калькулятора
Функции API в калькуляторе работают ТОЛЬКО на тарифе Премиум
ОБОЗНАЧЕНИЯ:
! - Обязательные параметры
Callback можно отправить только ДРУГОМУ клиенту.
СЕБЕ отправить callback НЕЛЬЗЯ!
Описание
Примеры
Пример кода для копирования
Видеоразбор
callback(client_id, callback_message)
Параметры:
! client_id - идентификатор клиента
! callback_message - текст сообщение в колбеке
Колбек - в программировании это функция, предназначенная для отложенного выполнения. То есть это отправ ка сообщения, которое бот распознает как команду для исполнения. Клиент при этом не видит данное сообщение, оно видно только в карточке клиента.
Отправим колбек клиенту с client_id=73704021

Блок с условием - отправка колбека клиенту
Скрин карточки клиента:

Полученный клиентом колбек
Далее просто настраиваем реакцию на данный колбек в блоке с условием.
callback('73704021', 'callback TEST123')
Разбор функции callback()
Описание
Примеры
Пример кода для копирования
Видеоразбор
tg_callback(platform_id , callback_message,group_id)
Параметры:
! platform_id - идентификатор клиент Telegram
! callback_message - текст сообщение в колбеке
group_id - идентификатор бота Telegram
tg_callback('73704021', 'callback TEST123')
Разбор функции callback()
tg_callback_url_open(callback_query_id, url)
Параметры:
! callback_query_id - данный id позволяет идентифицировать нажавшего кнопку и продемонстрировать ему Alert-уведомление,
! url - URL-адрес, указывающий бота и параметр (выглядит так: t.me/your_bot?start=XXXX, вместо your_bot - имя бота)
Описание
Примеры
Пример кода
Видеоразбор
message(client_id, text, message_id, timeout)
Параметры:
! client_id - идентификатор клиента
! text - текст сообщения
message_id - идентификатор блока. Если оставить поле text пустым (''), а этот параметр заполнить, то клиенту будет отправлен текст из указанного блока.
Обратите вн имание, если в функции message передать параметр message_id , то вычисления в Калькуляторе текущего блока остановятся, а клиент будет перемещен в блок, который вы передали в параметре message_id
timeout - время отправки или задержки. Если нужно отправить сообщение с задержкой, можно указать время:
а) задержка в секундах до 3600 секунд. Если указано большее количество секунд, то сообщение отправится через час, если указано отрицательное число, сообщение отправится мгновенно. Например, timeout = 50.
б) дату отправки в виде дд.мм.гггг чч:мм, например: timeout = ‘03.04.2022 15:00’. Если указать уже прошедшее время, то сообщение отправится мгновенно.
platform_message(platform_id, text, client_type, message_id, timeout)
Параметры:
! platform_id - идентификатор клиента в мессенджере
! text - текст сообщения
client_type - тип мессенджера, необязательный параметр. Если не указан, то клиента будут искать в том же мессенджере, из которого бот отправляет сообщение. Если указан, то клиент будет найден среди базы данных указанного мессенджера. Используемые типы мессенджеров можно найти тут.
message_id - идентификатор блока. Если указан, то клиент получит сообщение из указанного блока, а не значение из text.
timeout - время отправки или задержка. Аналогичен одноименному параметру функции message()
whatsapp_message(phone, text, message_id)
Параметры:
! phone- номер телефона клиента, на котором зарегистрирован Whatsapp
! text - текст сообщения
message_id - идентификатор блока. Если оставить поле text пустым (''), а этот параметр заполнить, то клиенту будет отправлен текст из указанного блока.
К проекту должен быть подключен Whatsapp-бот
Простой пример отправки сообщения по client_id:

Отправка сообщения по client_id
Разные варианты отправки сообщения по client_id:

Разные варианты отправки сообщения
Пример отправки сообщения через platform_message():

/*Отправка сообщения по client_id*/
message(73704021, 'Текст сообщения для клиента')
/*Отправка сообщения по client_id с задержкой в 30 секунд*/
message(73704021, 'Привет! Спасибо, что написал.','',30)
/*Отправка сообщения из блока 3190 по client_id 03.04.2022 в 15:00*/
message(73704021, '',3190, ‘03.04.2022 15:00’)
/*Отправка сообщения в Whatsapp*/
whatsapp_message('79999999999', 'Текст сообщения для клиента')
Разбор функции message()
Разбор функций platform_message() и whatsapp_message()
Описание
Пример кода
get_client_id_by_platform_id(client_type, platform_id , group)
При выполнении функция вернет client_id, если найдет клиента по заданным условиям, иначе вернет None.
! platform_id - ID клиента в указанном мессенджере.
group - обязательный, если подключено более одного бота для мессенджера.
Если в проекте подключено несколько мессенджеров одного типа, то искать будет по всем подключенным данного типа.
Рекомендуем в этом случае передавать параметр group
tg_approve_chat_join_request(chat_id, user_id) - принять заявку и добавить пользователя в канал/чат
tg_callback_url_open(callback_query_id, url) – установка реакции на callback-кнопку с переходом в бота с тэгом
tg_chat_permission(platform_id, permission, media_permissions) – установка общих ограничений для обычных пользователей чата или отдельных пользователей
tg_copy_message(platform_id, from_chat_id, message_id, reply_to_message_id, reply_markup, parse_mode, protect_content, disable_notification, message_thread_id ) – копирование сообщения
tg_create_chat_invite_link(platform_id, member_limit, hours, request,name) – создание ссылки на вступление в чат
tg_edit_forum_topic(platform_id, message_thread_id, name, icon) – переименование и/или смена эмодзи доп.темы
tg_edit_message_caption(platform_id, message_id, caption, reply_markup, parse_mode) – редактирование описания
tg_edit_message_reply_markup(platform_id, message_id, reply_markup) – редактирование инлайн-клавиатуры в сообщении
tg_edit_message_text(platform_id, message_id, text, reply_markup, parse_mode, disable_web_page_preview) – редактирование текста в сообщении
tg_export_chat_link(platform_id) - сделать неактивными все существующие ссылки и заменить их на одну
tg_forward_message(platform_id, from_chat_id, message_id, protect_content, disable_notification, message_thread_id) - пересылка сообщения
tg_pin_chat_message(platform_id, message_id, disable_notification) – как закрепить сообщение в чате/канале
tg_promote_user(platform_id, user_id, promote_options_list) - настройка прав пользователя / повышение до администратора в супер-группе или канале в Telegram
tg_restrict_chat_member(platform_id, user_id, minutes, permission, media_permissions) – установка персональных ограничений для обычных пользова телей чата или для отдельных пользователей
tg_send_animation(platform_id, animation, caption, reply_markup, parse_mode, reply_to_message_id, protect_content, has_spoiler, disable_notification, message_thread_id) – отправка анимации
tg_send_chat_action(platform_id, bot_action, message_thread_id ) – показ пользователю действий бота (печатает / выбирает стикер и т.д.)
tg_send_contact(platform_id, phone, first_name, last_name, protect_content, disable_notification, reply_to_message_id, reply_markup, message_thread_id) – отправка контакта
tg_send_dice(platform_id, emoji, reply_markup, disable_notification, reply_to_message_id, protect_content, message_thread_id) – отправка эмодзи со случайным выбором (Dice)
tg_send_document(platform_id, document, caption, reply_markup, parse_mode,reply_to_message_id, protect_content, disable_notification, message_thread_id) – отправка документа
tg_send_message(platform_id, text,client_message_id, reply_markup, parse_mode, disable_web_page_preview, protect_content, disable_notification, message_thread_id) – отправка сообщения
tg_send_message_1(token, platform_id, text, client_message_id, reply_markup, parse_mode, disable_web_page_preview, protect_content, disable_notification, message_thread_id) – отправка сообщения с указанием конкретного бота
tg_send_photo(platform_id, photo, caption, reply_markup, parse_mode, reply_to_message_id, protect_content, has_spoiler, disable_notification, message_thread_id) – отправка картинки
tg_send_poll(platform_id, question, options, is_anonymous, allows_multiple_answers, reply_markup, disable_notification, protect_content, token, reply_to_message_id, message_thread_id ) – создание опроса
tg_send_quiz_poll(platform_id, question, options, explanation, correct_option_id, is_anonymous, reply_markup, parse_mode, protect_content, disable_notification, token, reply_to_message_id, message_thread_id ) – создание викторины
tg_send_some_audio(platform_id, audio_list, disable_notification, reply_to_message_id, message_thread_id) – отправка нескольких аудио
tg_send_some_document(platform_id, document_list, disable_notification, reply_to_message_id, message_thread_id) – отправка нескольких документов
tg_send_some_photo(platform_id, image_list, disable_notification=0, protect_content=False, reply_to_message_id=0, has_spoiler=False,message_thread_id) – отправка нескольких картинок
tg_send_some_video(platform_id, video_list, disable_notification, protect_content, reply_to_message_id, has_spoiler, message_thread_id) – отправка нескольких видео
tg_send_sticker(platform_id, sticker_id, protect_content, disable_notification, reply_to_message_id, reply_markup, message_thread_id) – отправка стикера
tg_send_venue(platform_id, latitude, longitude, title, address, protect_content, disable_notification, reply_to_message_id, reply_markup, message_thread_id) – отправка геоточки
tg_send_video(platform_id, video, caption, reply_markup, parse_mode, reply_to_message_id, protect_content, has_spoiler, disable_notification, message_thread_id) – отправка видео
tg_send_video_note(platform_id, video_note, reply_markup, protect_content, reply_to_message_id, disable_notification, message_thread_id) – отправка круглого видео
tg_send_voice(platform_id, voice, caption, reply_markup, parse_mode, reply_to_message_id, protect_content, disable_notification, message_thread_id) – отправка голосового сообщения
tg_set_administrator_title(platform_id, user_id, title) – изменение титула администратора с помощью бота