Fungsi (API) dalam kalkulator

Fungsi API hanya tersedia pada pelan "Business" dan "MaviBot AI".

API MaviBot

LEGENDA:\ ! -Parameter wajib

Cara menghantar callback

callback()

Anda hanya boleh menghantar callback kepada pelanggan LAIN.

ANDA TIDAK BOLEH menghantar callback kepada DIRI SENDIRI!

callback(client_id, callback_message)

Parameter:

! client_id - pengecam pelanggan

! callback_message - teks mesej callback

Callback ialah mesej sistem khas yang diiktiraf oleh bot sebagai arahan untuk mencetuskan tindakan tertentu. Mesej ini tidak kelihatan kepada pengguna dan hanya direkodkan dalam profil pelanggan untuk pemprosesan dalaman.

Mari hantar callback kepada pelanggan dengan client_id=73704021

Seterusnya, kami tetapkan respons kepada callback ini dalam blok dengan syarat.

callback('73704021', 'callback TEST123')

callback(client_id, 'callback TEST123')

Cara menghantar callback dalam Telegram

tg_callback()

tg_callback(platform_id , callback_message,group_id, business_connection_id)

Parameter:

! platform_id - pengecam pelanggan Telegram

! callback_message - teks mesej callback

group_id - pengecam bot Telegram

tg_business - untuk bekerja dengan pelanggan perniagaan, nilai "1" dihantar.

Ini adalah contoh dengan parameter wajib:

Ini adalah contoh dengan parameter pilihan

tg_callback('73704021', 'callback TEST123')

tg_callback(platform_id, 'callback TEST123', None, 1)

Bagaimana untuk menambah ubah hala bot dengan tag sebagai respons kepada butang callback?

tg_callback_url_open(callback_query_id, url)

Parameter: \ ! callback_query_id - id ini membolehkan anda mengenal pasti orang yang menekan butang dan menunjukkan kepada mereka pemberitahuan Alert,\ ! url - URL- menentukan bot dan parameter (kelihatan seperti: t.me/your_bot?start=XXXX, gantikan your_bot - nama bot)

Cara menghantar mesej kepada pelanggan

message() | platform_message() | whatsapp_message()

Untuk menyimpan teks dengan pemisah baris dalam pemboleh ubah, tetapkan nilai seperti berikut:

text = "Teks baris pertama" + "\n" + "Teks baris kedua" + "\n" +"Teks baris ketiga"

message(client_id, text, message_id, timeout)

Parameter:\ ! client_id - pengecam pelanggan\ ! text - teks mesej
message_id - ID blok. Jika anda biarkan medan teks kosong (") dan isi parameter ini, teks daripada blok yang ditentukan akan dihantar kepada pelanggan.

Nota: Jika anda menghantar parameter message_id kepada fungsi message, blok tersebut masih akan dilaksanakan sepenuhnya, dan pelanggan yang dinyatakan dalam parameter client_id akan dipindahkan ke blok yang anda hantar dalam message_id.

timeout - kelewatan mesej atau masa penghantaran berjadual. Anda boleh menggunakan parameter timeout untuk melambatkan penghantaran mesej:
a) Kelewatan dalam saat (sehingga 3600 saat). Jika nilai melebihi 3600, mesej akan dihantar dalam satu jam. Jika nilai negatif, mesej akan dihantar serta-merta. Contoh: timeout = 50

b) Tarikh dan masa tertentu dalam format dd.mm.yyyy hh:mm, contoh: timeout = '03.04.2022 15:00' . Jika tarikh lewat ditentukan, mesej akan dihantar serta-merta.

platform_message(platform_id, text, client_type, message_id, timeout,group_id)

Parameter:\ ! platform_id - pengecam pelanggan dalam messenger\ ! text - teks mesej
client_type - jenis messenger, parameter pilihan. Jika tidak dinyatakan, pelanggan akan dicari dalam messenger yang sama dari mana bot menghantar mesej. Jika dinyatakan, pelanggan akan ditemui dalam pangkalan data messenger yang ditentukan. Anda boleh mencari jenis messenger di sini.
message_id - ID blok. Jika dinyatakan, pelanggan akan menerima mesej daripada blok yang ditentukan, bukan nilai daripada parameter text.
timeout - masa penghantaran atau kelewatan. Ia serupa dengan parameter fungsi message() dengan nama yang sama.
group_id - pengecam bot

whatsapp_message(phone, text, message_id)

Parameter:\ ! phone- nombor telefon pelanggan di mana Whatsapp didaftarkan\ ! text - teks mesej
message_id -ialah ID blok. Jika medan teks dibiarkan kosong ('') dan parameter ini ditetapkan, pelanggan akan menerima kandungan mesej daripada blok yang ditentukan.

Bot Whatsapp perlu disambungkan ke projek.

Contoh mudah menghantar mesej melalui client_id:

Pilihan berbeza untuk menghantar mesej melalui client_id:

Contoh menghantar mesej melalui platform_message():

/*Menghantar mesej melalui client_id*/
message(73704021, 'Teks mesej untuk pelanggan')
/*Menghantar mesej melalui client_id dengan kelewatan 30 saat*/
message(73704021, 'Hai! Terima kasih kerana menulis..','',30)
/*Menghantar mesej dari blok 3190 melalui client_id pada 03.04.2022 jam 3 petang*/
message(73704021, '',3190, '03.04.2022 3pm')

/*Menghantar mesej dalam Whatsapp*/
whatsapp_message('79999999999', 'Teks mesej untuk pelanggan')

Mendapatkan client_id melalui nilai platform_id

get_client_id_by_platform_id()

get_client_id_by_platform_id(client_type, platform_id , group)

Selepas pelaksanaan, fungsi akan mengembalikan client_id jika pelanggan yang sepadan dengan syarat yang ditentukan ditemui; jika tidak, ia akan mengembalikan None.

! client_type - messenger. Untuk nilai client_type baca artikel ini.

! platform_id - ID pelanggan dalam messenger yang ditentukan.

group - adalah parameter wajib jika lebih daripada satu bot messenger disambungkan.

Jika beberapa messenger jenis yang sama disambungkan dalam projek, maka carian akan berdasarkan semua messenger jenis yang disambungkan ini.

Dalam kes ini, kami mengesyorkan menghantar parameter group.

Fungsi untuk permintaan get: requests_get(url, answer_type, headers, params, auth, proxy)

! url - adalah pautan di mana permintaan dibuat

answer_type – adalah parameter pilihan yang menentukan apa yang harus dikembalikan daripada respons pelayan: ('status' – mengembalikan kod status respons; 'json' – mengembalikan badan json respons; 'text' – mengembalikan teks mentah respons; sebarang nilai lain (termasuk lalai) mengembalikan respons dalam format: '{"status": status_code, "data": data}')

headers - adalah parameter pilihan untuk menghantar pengepala permintaan,

params - adalah parameter permintaan get (boleh juga disertakan terus dalam URL),

auth - adalah parameter pilihan berguna untuk pengesahan API. Jika anda tidak mahu menggunakan sebarang parameter pilihan tetapi memerlukan yang seterusnya, hantar 0 di sini.

proxy - adalah parameter pilihan; menerima satu nilai: "de", yang menghalakan permintaan melalui alamat IP Eropah.

Fungsi untuk permintaan pos

requests_post(url, answer_type, headers, data, json_data, auth, proxy)

! url - adalah pautan di mana permintaan dibuat,

answer_type - adalah parameter pilihan yang menentukan apa yang harus dikembalikan daripada respons pelayan: ('status' – mengembalikan kod status respons; 'json' – mengembalikan badan json respons; 'text' – mengembalikan teks mentah respons; sebarang nilai lain (termasuk lalai) mengembalikan respons dalam format: '{"status": status_code, "data": data}')

headers - adalah parameter pilihan untuk menghantar pengepala permintaan

data - adalah parameter pilihan; mewakili badan permintaan apabila API tidak berfungsi dengan json.

json_data - adalah parameter pilihan; juga mewakili badan permintaan. Anda harus menggunakan hanya satu daripada parameter ini pada satu masa.

Sila ambil perhatian: konfigurasi pengepala tertentu mungkin menyekat permintaan daripada dihantar dengan jenis badan tertentu.

auth - adalah parameter pilihan berguna untuk pengesahan API. Jika anda tidak mahu menggunakan sebarang parameter pilihan tetapi memerlukan yang seterusnya, hantar 0 di sini

proxy - adalah parameter pilihan; menerima satu nilai: "de", yang menghalakan permintaan melalui alamat IP Eropah.

Fungsi untuk permintaan put

requests_put(url, answer_type, headers, data, auth, proxy)

! url - adalah pautan di mana permintaan dibuat

headers - adalah parameter pilihan untuk menghantar pengepala permintaan

data - adalah parameter pilihan; mewakili badan permintaan apabila API tidak berfungsi dengan json.

auth - adalah parameter pilihan berguna untuk pengesahan API. Jika anda tidak mahu menggunakan sebarang parameter pilihan tetapi memerlukan yang seterusnya, hantar 0 di sini

proxy - adalah parameter pilihan; menerima satu nilai: "de", yang menghalakan permintaan melalui alamat IP Eropah.

data_is_json adalah parameter pilihan.
Jika ditetapkan, data yang dihantar dalam data akan dihantar dalam format JSON.
Untuk mendayakannya, hantar '1'.

Fungsi untuk permintaan patch

requests_patch(url, answer_type, headers, data, auth, proxy)

! url - adalah pautan di mana permintaan dibuat

headers - adalah parameter pilihan untuk menghantar pengepala permintaan

data - adalah parameter pilihan; mewakili badan permintaan apabila API tidak berfungsi dengan json.

auth - adalah parameter pilihan berguna untuk pengesahan API. Jika anda tidak mahu menggunakan sebarang parameter pilihan tetapi memerlukan yang seterusnya, hantar 0 di sini

proxy - adalah parameter pilihan; menerima satu nilai: "de", yang menghalakan permintaan melalui alamat IP Eropah.

Fungsi untuk permintaan delete

requests_delete(url, answer_type, headers, data, json_data, auth, proxy)

! url - adalah pautan di mana permintaan dibuat

headers - adalah parameter pilihan untuk menghantar pengepala permintaan

data - adalah parameter pilihan; mewakili badan permintaan apabila API tidak berfungsi dengan json.

json_data - adalah pilihan dan juga boleh digunakan sebagai badan permintaan. Walau bagaimanapun, hanya satu pilihan harus digunakan pada satu masa

auth - adalah parameter pilihan berguna untuk pengesahan API. Jika anda tidak mahu menggunakan sebarang parameter pilihan tetapi memerlukan yang seterusnya, hantar 0 di sini

proxy - adalah parameter pilihan; menerima satu nilai: "de", yang menghalakan permintaan melalui alamat IP Eropah.

Fungsi untuk mendapatkan nama blok melalui IDnya

get_block_name_by_id(block_id)

! block_id — pengecam blok (id)