Функції (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 блоку. Якщо поле text залишити порожнім (''), і цей параметр задано, клієнт отримає вміст повідомлення з указаного блоку.
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-адресу.
Функції для POST-запитів
Опис
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
Last updated