Funkcijas (API) kalkulatorā

callback(client_id, callback_message)

Parametri:

! client_id - klienta identifikators

! callback_message - atsauces zvana ziņojuma teksts

Atsauces zvans ir īpašs sistēmas ziņojums, ko bots atpazīst kā komandu, lai aktivizētu noteiktu darbību. Šis ziņojums lietotājam nav redzams un tiek reģistrēts tikai klienta profilā iekšējai apstrādei.

Nosūtīsim atsauces zvanu klientam ar client_id=73704021

Pēc tam mēs iestatām atbildi uz šo atsauces zvanu blokā ar nosacījumu.

callback('73704021', 'callback TEST123')

callback(client_id, 'callback TEST123')

tg_callback(platform_id , callback_message,group_id, business_connection_id)

Parametri:

! platform_id - Telegram klienta identifikators

! callback_message - atsauces zvana ziņojuma teksts

group_id - Telegram bota identifikators

tg_business - darbam ar biznesa klientiem tiek nodota vērtība "1".

Šis ir piemērs ar obligātajiem parametriem:

Šis ir piemērs ar neobligātajiem parametriem

tg_callback('73704021', 'callback TEST123')

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

tg_callback_url_open(callback_query_id, url)

Parametri: \ ! callback_query_id - šis id ļauj identificēt personu, kura nospieda pogu, un parādīt tai Alert paziņojumu,\ ! url - URL, kas norāda botu un parametru (izskatās šādi: t.me/your_bot?start=XXXX, your_bot vietā - bota nosaukums)

message(client_id, text, message_id, timeout)

Parametri:\ ! client_id - klienta identifikators\ ! text - ziņojuma teksts
message_id - bloka ID. Ja atstājat teksta lauku tukšu (") un aizpildāt šo parametru, klientam tiks nosūtīts teksts no norādītā bloka.

Piezīme: Ja nododat message_id parametru funkcijai message, bloks joprojām tiks pilnībā izpildīts, un klients, kas norādīts client_id parametrā, tiks pārvietots uz bloku, kuru nodevāt message_id.

timeout - ziņojuma aizkave vai plānotais sūtīšanas laiks. Varat izmantot timeout parametru, lai aizkavētu ziņojuma sūtīšanu:
a) Aizkave sekundēs (līdz 3600 sekundēm). Ja vērtība pārsniedz 3600, ziņojums tiks nosūtīts pēc vienas stundas. Ja vērtība ir negatīva, ziņojums tiks nosūtīts nekavējoties. Piemērs: timeout = 50

b) Konkrēts datums un laiks formātā dd.mm.yyyy hh:mm, piemērs: timeout = '03.04.2022 15:00' . Ja ir norādīts pagātnes datums, ziņojums tiks nosūtīts nekavējoties.

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

Parametri:\ ! platform_id - klienta identifikators kurjerā\ ! text - ziņojuma teksts
client_type - kurjera veids, neobligāts parametrs. Ja tas nav norādīts, klients tiks meklēts tajā pašā kurjerā, no kura bots sūta ziņojumu. Ja tas ir norādīts, klients tiks atrasts starp norādītā kurjera datubāzi. Kurjeru veidus varat atrast šeit.
message_id - bloka ID. Ja tas ir norādīts, klients saņems ziņojumu no norādītā bloka, nevis vērtību no teksta parametra.
timeout - sūtīšanas laiks vai aizkave. Tas ir līdzīgs tāda paša nosaukuma message() funkcijas parametram.
group_id - bota identifikators

whatsapp_message(phone, text, message_id)

Parametri:\ ! phone- klienta tālruņa numurs, kurā reģistrēts Whatsapp\ ! text - ziņojuma teksts
message_id - ir bloka ID. Ja teksta lauks ir atstāts tukšs ('') un šis parametrs ir iestatīts, klients saņems ziņojuma saturu no norādītā bloka.

Whatsapp botam ir jābūt savienotam ar projektu.

Vienkāršs piemērs ziņojuma sūtīšanai pēc client_id:

Dažādas iespējas ziņojuma sūtīšanai pēc client_id:

Piemērs ziņojuma sūtīšanai, izmantojot platform_message():

/*Ziņojuma sūtīšana pēc client_id*/
message(73704021, 'Ziņojuma teksts klientam')
/*Ziņojuma sūtīšana pēc client_id ar 30 sekunžu aizkavi*/
message(73704021, 'Sveiki! Paldies, ka rakstāt..','',30)
/*Ziņojuma sūtīšana no bloka 3190 pēc client_id 03.04.2022 plkst. 15:00*/
message(73704021, '',3190, '03.04.2022 15:00')

/*Ziņojuma sūtīšana Whatsapp*/
whatsapp_message('79999999999', 'Ziņojuma teksts klientam')

get_client_id_by_platform_id(client_type, platform_id , group)

Pēc izpildes funkcija atgriezīs client_id, ja tiek atrasts klients, kas atbilst norādītajiem nosacījumiem; pretējā gadījumā tā atgriezīs None.

! client_type - kurjers. Par client_type vērtību lasiet šo rakstu.

! platform_id - klienta ID norādītajā kurjerā.

group - ir obligāts parametrs, ja ir pievienots vairāk nekā viens kurjera bots.

Ja projektā ir savienoti vairāki viena veida kurjeri, tad meklēšana tiks veikta visos šī veida savienotajos kurjeros.

Šajā gadījumā mēs iesakām nodot grupas parametru.

! url - ir saite, uz kuru tiek veikts pieprasījums

answer_type – ir neobligāts parametrs, kas nosaka, kas jāatgriež no servera atbildes: ('status' – atgriež atbildes statusa kodu; 'json' – atgriež atbildes json pamattekstu; 'text' – atgriež atbildes neapstrādātu tekstu; jebkura cita vērtība (ieskaitot noklusējuma) atgriež atbildi formātā: '{"status": status_code, "data": data}')

headers - ir neobligāts parametrs pieprasījuma galveņu nodošanai,

params - ir get pieprasījuma parametri (var tikt iekļauti arī tieši URL),

auth - ir neobligāts parametrs, kas noder API autentifikācijai. Ja nevēlaties izmantot nevienu neobligāto parametru, bet nepieciešams nākamais, šeit nododiet 0.

proxy - ir neobligāts parametrs; pieņem vienu vērtību: "de", kas novirza pieprasījumu caur Eiropas IP adresi.

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

! url - ir saite, uz kuru tiek veikts pieprasījums,

answer_type - ir neobligāts parametrs, kas nosaka, kas jāatgriež no servera atbildes: ('status' – atgriež atbildes statusa kodu; 'json' – atgriež atbildes json pamattekstu; 'text' – atgriež atbildes neapstrādātu tekstu; jebkura cita vērtība (ieskaitot noklusējuma) atgriež atbildi formātā: '{"status": status_code, "data": data}')

headers - ir neobligāts parametrs pieprasījuma galveņu nodošanai

data - ir neobligāts parametrs; attēlo pieprasījuma pamattekstu, ja API nestrādā ar json.

json_data - ir neobligāts parametrs; arī attēlo pieprasījuma pamattekstu. Vienlaikus jāizmanto tikai viens no šiem parametriem.

Lūdzu, ņemiet vērā: noteiktas galveņu konfigurācijas var bloķēt pieprasījuma nosūtīšanu ar noteikta veida pamattekstu.

auth - ir neobligāts parametrs, kas noder API autentifikācijai. Ja nevēlaties izmantot nevienu neobligāto parametru, bet nepieciešams nākamais, šeit nododiet 0

proxy - ir neobligāts parametrs; pieņem vienu vērtību: "de", kas novirza pieprasījumu caur Eiropas IP adresi.

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

! url - ir saite, uz kuru tiek veikts pieprasījums

answer_type - ir neobligāts parametrs, kas nosaka, kas jāatgriež no servera atbildes: ('status' – atgriež atbildes statusa kodu; 'json' – atgriež atbildes json pamattekstu; 'text' – atgriež atbildes neapstrādātu tekstu; jebkura cita vērtība (ieskaitot noklusējuma) atgriež atbildi formātā: '{"status": status_code, "data": data}')

headers - ir neobligāts parametrs pieprasījuma galveņu nodošanai

data - ir neobligāts parametrs; attēlo pieprasījuma pamattekstu, ja API nestrādā ar json.

auth - ir neobligāts parametrs, kas noder API autentifikācijai. Ja nevēlaties izmantot nevienu neobligāto parametru, bet nepieciešams nākamais, šeit nododiet 0

proxy - ir neobligāts parametrs; pieņem vienu vērtību: "de", kas novirza pieprasījumu caur Eiropas IP adresi.

data_is_json ir neobligāts parametrs.
Ja iestatīts, data nodotie dati tiks nosūtīti JSON formātā.
Lai to iespējotu, nododiet '1'.

! url - ir saite, uz kuru tiek veikts pieprasījums

answer_type - ir neobligāts parametrs, kas nosaka, kas jāatgriež no servera atbildes: ('status' – atgriež atbildes statusa kodu; 'json' – atgriež atbildes json pamattekstu; 'text' – atgriež atbildes neapstrādātu tekstu; jebkura cita vērtība (ieskaitot noklusējuma) atgriež atbildi formātā: '{"status": status_code, "data": data}')

headers - ir neobligāts parametrs pieprasījuma galveņu nodošanai

data - ir neobligāts parametrs; attēlo pieprasījuma pamattekstu, ja API nestrādā ar json.

auth - ir neobligāts parametrs, kas noder API autentifikācijai. Ja nevēlaties izmantot nevienu neobligāto parametru, bet nepieciešams nākamais, šeit nododiet 0

proxy - ir neobligāts parametrs; pieņem vienu vērtību: "de", kas novirza pieprasījumu caur Eiropas IP adresi.

! url - ir saite, uz kuru tiek veikts pieprasījums

answer_type - ir neobligāts parametrs, kas nosaka, kas jāatgriež no servera atbildes: ('status' – atgriež atbildes statusa kodu; 'json' – atgriež atbildes json pamattekstu; 'text' – atgriež atbildes neapstrādātu tekstu; jebkura cita vērtība (ieskaitot noklusējuma) atgriež atbildi formātā: '{"status": status_code, "data": data}')

headers - ir neobligāts parametrs pieprasījuma galveņu nodošanai

data - ir neobligāts parametrs; attēlo pieprasījuma pamattekstu, ja API nestrādā ar json.

json_data - ir neobligāts un var tikt izmantots arī kā pieprasījuma pamatteksts. Tomēr vienlaikus jāizmanto tikai viena iespēja

auth - ir neobligāts parametrs, kas noder API autentifikācijai. Ja nevēlaties izmantot nevienu neobligāto parametru, bet nepieciešams nākamais, šeit nododiet 0

proxy - ir neobligāts parametrs; pieņem vienu vērtību: "de", kas novirza pieprasījumu caur Eiropas IP adresi.

get_block_name_by_id(block_id)

! block_id — bloka identifikators (id)