API функциялары тек "Business" және "MaviBot AI" жоспарларында қолжетімді.
MaviBot API
АНЫҚТАМА:\ ! -Міндетті параметрлер
Қалай callback жіберуге болады
callback()
Сіз callback-ты тек БАСҚА клиентке жібере аласыз.
ӨЗІҢІЗГЕ callback жібере АЛМАЙСЫЗ!
callback(client_id, callback_message)
Параметрлер:
! client_id - клиент идентификаторы
! callback_message - callback хабарлама мәтіні
Callback - бұл боттың белгілі бір әрекетті іске қосу үшін команда ретінде танитын арнайы жүйелік хабарлама. Бұл хабарлама пайдаланушыға көрінбейді және ішкі өңдеу үшін тек клиенттің профилінде журналға жазылады.
client_id=73704021 клиентіне callback жіберейік
Әрі қарай, шарты бар блокта осы callback-қа жауапты орнатамыз.
callback('73704021', 'callback TEST123')
callback(client_id, 'callback TEST123')
Telegram-да callback қалай жіберуге болады
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" мәні беріледі.
Бұл міндетті параметрлері бар мысал:
Бұл қосымша параметрлері бар мысал
tg_callback('73704021', 'callback TEST123')
tg_callback(platform_id, 'callback TEST123', None, 1)
Callback түймесіне жауап ретінде тегі бар ботты қайта бағыттауды қалай қосуға болады?
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 функциясына message_id параметрін берсеңіз, блок толығымен орындалады және 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 - блок идентификаторы. Егер ол көрсетілсе, клиент 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', 'Клиентке арналған хабарлама мәтіні')
platform_id мәні бойынша client_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 мекенжайы арқылы бағыттайды.
Блок атауын оның идентификаторы бойынша алу функциясы
get_block_name_by_id(block_id)
! block_id — блок идентификаторы (id)