Функции (API) в калькуляторе
API-функции доступны только на тарифах "Business" и "MaviBot AI".
API MaviBot
ЛЕГЕНДА: ! -Обязательные параметры
Как отправить callback
callback()
Вы можете отправить callback только ДРУГОМУ клиенту.
НЕЛЬЗЯ отправить callback СЕБЕ!
Описание
callback(client_id, callback_message)
Параметры:
! client_id - идентификатор клиента
! callback_message - текст callback-сообщения
Пример
Callback — это специальное системное сообщение, которое бот распознаёт как команду для запуска определённого действия. Это сообщение невидимо для пользователя и сохраняется только в профиле клиента для внутренней обработки.
Давайте отправим callback клиенту с client_id=73704021
Далее мы задаём ответ на этот callback в блоке с условием.
Пример кода для копирования
callback('73704021', 'callback TEST123')
callback(client_id, 'callback TEST123')Как отправить callback в Telegram
tg_callback()
Описание
tg_callback(platform_id , callback_message,group_id, business_connection_id)
Параметры:
! platform_id - идентификатор клиента Telegram
! callback_message - текст callback-сообщения
group_id - идентификатор Telegram-бота
tg_business - для работы с бизнес-клиентами передаётся значение "1".
Как добавить редирект бота с тегом в ответ на кнопку 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() | platform_message() | whatsapp_message()
Чтобы сохранить текст с переносами строк в переменную, задайте значение следующим образом:
text = "Текст первой строки" + "\n" + "Текст второй строки" + "\n" +"Текст третьей строки"
Описание
message(client_id, text, message_id, timeout)
Параметры: ! client_id - идентификатор клиента ! text - текст сообщения message_id - ID блока. Если оставить поле текста пустым ("") и заполнить этот параметр, клиенту будет отправлен текст из указанного блока.
Примечание: если вы передадите параметр message_id в функцию message, блок всё равно будет полностью выполнен, а клиент, указанный в параметре client_id, будет перемещён в блок, переданный в message_id.
timeout - задержка сообщения или время отложенной отправки. Вы можете использовать параметр timeout, чтобы задержать отправку сообщения: a) Задержка в секундах (до 3600 секунд). Если значение больше 3600, сообщение будет отправлено через час. Если значение отрицательное, сообщение будет отправлено немедленно. Пример: timeout = 50
b) Конкретная дата и время в формате dd.mm.yyyy hh:mm, пример: timeout = '03.04.2022 15:00' . Если указана прошедшая дата, сообщение будет отправлено немедленно.
platform_message(platform_id, text, client_type, message_id, timeout,group_id)
Параметры: ! platform_id - идентификатор клиента в мессенджере ! text - текст сообщения client_type - тип мессенджера, необязательный параметр. Если он не указан, клиент будет найден в том же мессенджере, из которого бот отправляет сообщение. Если он указан, клиент будет найден среди базы данных указанного мессенджера. Вы можете найти типы мессенджеров здесь. message_id - ID блока. Если он указан, клиент получит сообщение из указанного блока, а не значение из параметра text. timeout - время отправки или задержка. Это аналогично одноимённому параметру функции message(). group_id - идентификатор бота
whatsapp_message(phone, text, message_id)
Параметры: ! phone- номер телефона клиента, на котором зарегистрирован Whatsapp ! text - текст сообщения message_id - это ID блока. Если поле текста оставить пустым (''), и этот параметр задан, клиент получит содержимое сообщения из указанного блока.
WhatsApp-бот нужно подключить к проекту.
Пример
Простой пример отправки сообщения по client_id:
Разные варианты отправки сообщения по client_id:
Пример отправки сообщения через platform_message():
Получение client_id по значению platform_id
get_client_id_by_platform_id()
Описание
get_client_id_by_platform_id(client_type, platform_id , group)
После выполнения функция вернёт client_id, если найден клиент, соответствующий указанным условиям; в противном случае она вернёт None.
! client_type - мессенджер. Для значения client_type читайте эту статью.
! platform_id - ID клиента в указанном мессенджере.
group - обязательный параметр, если подключено более одного бота-мессенджера.
Если в проекте подключено несколько мессенджеров одного типа, поиск будет выполняться по всем подключённым мессенджерам этого типа.
В этом случае мы рекомендуем передавать параметр group.
Функция для get-запросов: requests_get(url, answer_type, headers, params, auth, proxy)
Описание
! url - это ссылка, по которой выполняется запрос
answer_type — необязательный параметр, который определяет, что будет возвращено из ответа сервера: ('status' – возвращает код статуса ответа; 'json' – возвращает тело ответа в формате json; 'text' – возвращает необработанный текст ответа; любое другое значение (включая значение по умолчанию) возвращает ответ в формате: '{"status": status_code, "data": data}')
headers - это необязательный параметр для передачи заголовков запроса,
params - это get параметры запроса (могут также быть включены непосредственно в URL),
auth - это необязательный параметр, полезный для аутентификации API. Если вы не хотите использовать ни один необязательный параметр, но нужен следующий, передайте здесь 0.
proxy - это необязательный параметр; принимает одно значение: "de", которое направляет запрос через европейский IP-адрес.
Функции для pos-запросов
Описание
requests_post(url, answer_type, headers, data, json_data, auth, proxy)
! url - это ссылка, по которой выполняется запрос,
answer_type — необязательный параметр, который определяет, что будет возвращено из ответа сервера: ('status' – возвращает код статуса ответа; 'json' – возвращает тело ответа в формате json; 'text' – возвращает необработанный текст ответа; любое другое значение (включая значение по умолчанию) возвращает ответ в формате: '{"status": status_code, "data": data}')
headers - это необязательный параметр для передачи заголовков запроса
data - это необязательный параметр; представляет тело запроса, когда API не работает с json.
json_data - это необязательный параметр; также представляет тело запроса. Следует использовать только один из этих параметров за раз.
Обратите внимание: некоторые настройки заголовков могут блокировать отправку запроса с определённым типом тела.
auth - это необязательный параметр, полезный для аутентификации API. Если вы не хотите использовать ни один необязательный параметр, но нужен следующий, передайте здесь 0
proxy - это необязательный параметр; принимает одно значение: "de", которое направляет запрос через европейский IP-адрес.
Функции для put-запросов
Описание
requests_put(url, answer_type, headers, data, auth, proxy)
! url - это ссылка, по которой выполняется запрос
answer_type — необязательный параметр, который определяет, что будет возвращено из ответа сервера: ('status' – возвращает код статуса ответа; 'json' – возвращает тело ответа в формате json; 'text' – возвращает необработанный текст ответа; любое другое значение (включая значение по умолчанию) возвращает ответ в формате: '{"status": status_code, "data": data}')
headers - это необязательный параметр для передачи заголовков запроса
data - это необязательный параметр; представляет тело запроса, когда API не работает с json.
auth - это необязательный параметр, полезный для аутентификации API. Если вы не хотите использовать ни один необязательный параметр, но нужен следующий, передайте здесь 0
proxy - это необязательный параметр; принимает одно значение: "de", которое направляет запрос через европейский IP-адрес.
data_is_json это необязательный параметр.
Если он задан, данные, переданные в data будут отправлены в формате JSON.
Чтобы включить это, передайте '1'.
Функции для patch-запросов
requests_patch(url, answer_type, headers, data, auth, proxy)
Описание
! url - это ссылка, по которой выполняется запрос
answer_type — необязательный параметр, который определяет, что будет возвращено из ответа сервера: ('status' – возвращает код статуса ответа; 'json' – возвращает тело ответа в формате json; 'text' – возвращает необработанный текст ответа; любое другое значение (включая значение по умолчанию) возвращает ответ в формате: '{"status": status_code, "data": data}')
headers - это необязательный параметр для передачи заголовков запроса
data - это необязательный параметр; представляет тело запроса, когда API не работает с json.
auth - это необязательный параметр, полезный для аутентификации API. Если вы не хотите использовать ни один необязательный параметр, но нужен следующий, передайте здесь 0
proxy - это необязательный параметр; принимает одно значение: "de", которое направляет запрос через европейский IP-адрес.
Функции для delete-запросов
requests_delete(url, answer_type, headers, data, json_data, auth, proxy)
Описание
! url - это ссылка, по которой выполняется запрос
answer_type — необязательный параметр, который определяет, что будет возвращено из ответа сервера: ('status' – возвращает код статуса ответа; 'json' – возвращает тело ответа в формате json; 'text' – возвращает необработанный текст ответа; любое другое значение (включая значение по умолчанию) возвращает ответ в формате: '{"status": status_code, "data": data}')
headers - это необязательный параметр для передачи заголовков запроса
data - это необязательный параметр; представляет тело запроса, когда API не работает с json.
json_data - это необязательный параметр и также может использоваться как тело запроса. Однако за один раз следует использовать только один вариант
auth - это необязательный параметр, полезный для аутентификации API. Если вы не хотите использовать ни один необязательный параметр, но нужен следующий, передайте здесь 0
proxy - это необязательный параметр; принимает одно значение: "de", которое направляет запрос через европейский IP-адрес.
Функция для получения названия блока по его ID
Последнее обновление