API-функції доступні лише на тарифах «Business» та «MaviBot AI».
API MaviBot
ЛЕГЕНДА:\ ! -Обов'язкові параметри
Як надіслати зворотний виклик
callback()
Ви можете надіслати зворотний виклик лише ІНШОМУ клієнту.
ВИ НЕ МОЖЕТЕ надіслати зворотний виклик СОБІ!
callback(client_id, callback_message)
Параметри:
! client_id - ідентифікатор клієнта
! callback_message - текст повідомлення зворотного виклику
Зворотний виклик — це спеціальне системне повідомлення, яке бот розпізнає як команду для запуску певної дії. Це повідомлення невидиме для користувача і лише логується в профілі клієнта для внутрішньої обробки.
Надішлемо зворотний виклик клієнту з client_id=73704021
Далі налаштовуємо відповідь на цей зворотний виклик у блоці з умовою.
callback('73704021', 'callback TEST123')
callback(client_id, 'callback TEST123')
Як надіслати зворотний виклик у Telegram
tg_callback()
tg_callback(platform_id , callback_message,group_id, business_connection_id)
Параметри:
! platform_id - ідентифікатор клієнта Telegram
! callback_message - текст повідомлення зворотного виклику
group_id - ідентифікатор бота Telegram
tg_business - для роботи з бізнес-клієнтами передається значення "1".
Це приклад з обов'язковими параметрами:
Це приклад з необов'язковими параметрами:
tg_callback('73704021', 'callback TEST123')
tg_callback(platform_id, 'callback TEST123', None, 1)
Як додати перенаправлення на бота з тегом у відповідь на кнопку зворотного виклику?
tg_callback_url_open(callback_query_id, url)
Параметри: \ ! callback_query_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 - ідентифікатор блоку. Якщо залишити текстове поле порожнім (") і заповнити цей параметр, клієнту буде надіслано текст із зазначеного блоку.
Примітка: Якщо ви передаєте параметр message_id у функцію message, блок все одно буде повністю виконано, а клієнт, зазначений у параметрі client_id, буде переміщений до блоку, який ви передали в message_id.
timeout - затримка повідомлення або запланований час надсилання. Ви можете використовувати параметр timeout для затримки надсилання повідомлення:
a) Затримка в секундах (до 3600 секунд). Якщо значення перевищує 3600, повідомлення буде надіслано через годину. Якщо значення від'ємне, повідомлення буде надіслано негайно. Приклад: timeout = 50
b) Конкретна дата та час у форматі дд.мм.рррр гг:хв, приклад: 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 - ідентифікатор блоку. Якщо його вказано, клієнт отримає повідомлення із зазначеного блоку, а не значення з параметра text.
timeout - час надсилання або затримка. Аналогічний однойменному параметру функції message().
group_id - ідентифікатор бота
whatsapp_message(phone, text, message_id)
Параметри:\ ! phone- номер телефону клієнта, на якому зареєстровано Whatsapp\ ! text - текст повідомлення
message_id - ідентифікатор блоку. Якщо текстове поле залишено порожнім ('') і цей параметр встановлено, клієнт отримає вміст повідомлення із зазначеного блоку.
Бот Whatsapp має бути підключений до проекту.
Простий приклад надсилання повідомлення за 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', 'Текст повідомлення для клієнта')
Отримання 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 - ідентифікатор клієнта у вказаному месенджері.
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
get_block_name_by_id(block_id)
! block_id — ідентифікатор блоку (id)