Funktionen (API) im Rechner

API-Funktionen sind nur in den Tarifen „Business“ und „MaviBot AI“ verfügbar.

API MaviBot

LEGENDE:\ ! -Erforderliche Parameter

So senden Sie einen Callback

callback()

Sie können einen Callback nur an einen ANDEREN Client senden.

Sie können KEINEN Callback an SICH SELBST senden!

callback(client_id, callback_message)

Parameter:

! client_id - Client-Identifikator

! callback_message - Text der Callback-Nachricht

Ein Callback ist eine spezielle Systemnachricht, die der Bot als Befehl zur Auslösung einer bestimmten Aktion erkennt. Diese Nachricht ist für den Benutzer unsichtbar und wird nur im Profil des Clients für die interne Verarbeitung protokolliert.

Senden wir einen Callback an den Client mit client_id=73704021

Als Nächstes legen wir die Antwort auf diesen Callback im Block mit der Bedingung fest.

callback('73704021', 'callback TEST123')

callback(client_id, 'callback TEST123')

So senden Sie einen Callback in Telegram

tg_callback()

tg_callback(platform_id , callback_message,group_id, business_connection_id)

Parameter:

! platform_id - Telegram-Client-Identifikator

! callback_message - Text der Callback-Nachricht

group_id - Telegram-Bot-Identifikator

tg_business - für die Arbeit mit Geschäftskunden wird der Wert „1“ übergeben.

Dies ist ein Beispiel mit den erforderlichen Parametern:

Dies ist ein Beispiel mit den optionalen Parametern:

tg_callback('73704021', 'callback TEST123')

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

Wie füge ich eine Bot-Weiterleitung mit einem Tag als Antwort auf eine Callback-Schaltfläche hinzu?

tg_callback_url_open(callback_query_id, url)

Parameter: \ ! callback_query_id - Diese ID ermöglicht es, die Person zu identifizieren, die die Schaltfläche gedrückt hat, und ihr eine Alert-Benachrichtigung anzuzeigen.\ ! url - URL, die den Bot und den Parameter angibt (sieht aus wie: t.me/your_bot?start=XXXX, anstelle von your_bot - Bot-Name)

So senden Sie eine Nachricht an den Client

message() | platform_message() | whatsapp_message()

Um Text mit Zeilenumbrüchen in einer Variable zu speichern, setzen Sie den Wert wie folgt:

text = "Text der ersten Zeile" + "\n" + "Text der zweiten Zeile" + "\n" +"Text der dritten Zeile"

message(client_id, text, message_id, timeout)

Parameter:\ ! client_id - Client-Identifikator\ ! text - Nachrichtentext
message_id - die Block-ID. Wenn Sie das Textfeld leer lassen (") und diesen Parameter ausfüllen, wird der Text aus dem angegebenen Block an den Client gesendet.

Hinweis: Wenn Sie den Parameter message_id an die message-Funktion übergeben, wird der Block trotzdem vollständig ausgeführt, und der im Parameter client_id angegebene Client wird zu dem Block verschoben, den Sie in message_id übergeben haben.

timeout - Nachrichtenverzögerung oder geplanter Sendezeitpunkt. Sie können den timeout-Parameter verwenden, um das Senden von Nachrichten zu verzögern:
a) Eine Verzögerung in Sekunden (bis zu 3600 Sekunden). Wenn der Wert 3600 überschreitet, wird die Nachricht in einer Stunde gesendet. Wenn der Wert negativ ist, wird die Nachricht sofort gesendet. Beispiel: timeout = 50

b) Ein bestimmtes Datum und eine bestimmte Uhrzeit im Format dd.mm.yyyy hh:mm, Beispiel: timeout = '03.04.2022 15:00'. Wenn ein vergangenes Datum angegeben wird, wird die Nachricht sofort gesendet.

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

Parameter:\ ! platform_id - Client-Identifikator im Messenger\ ! text - Nachrichtentext
client_type - Messenger-Typ, optionaler Parameter. Wenn nicht angegeben, wird der Client im selben Messenger gesucht, von dem der Bot die Nachricht sendet. Wenn angegeben, wird der Client in der Datenbank des angegebenen Messengers gefunden. Die Messenger-Typen finden Sie hier.
message_id - Block-ID. Wenn angegeben, erhält der Client die Nachricht aus dem angegebenen Block, nicht den Wert aus dem text-Parameter.
timeout - Sendezeitpunkt oder Verzögerung. Ähnlich wie der gleichnamige Parameter der message()-Funktion.
group_id - Bot-Identifikator

whatsapp_message(phone, text, message_id)

Parameter:\ ! phone- die Telefonnummer des Kunden, bei der Whatsapp registriert ist\ ! text - Nachrichtentext
message_id - ist die Block-ID. Wenn das Textfeld leer gelassen wird ('') und dieser Parameter gesetzt ist, erhält der Client den Nachrichteninhalt aus dem angegebenen Block.

Der Whatsapp-Bot muss mit dem Projekt verbunden sein.

Ein einfaches Beispiel zum Senden einer Nachricht per client_id:

Verschiedene Optionen zum Senden einer Nachricht per client_id:

Beispiel zum Senden einer Nachricht über platform_message():

/*Senden einer Nachricht per client_id*/
message(73704021, 'Nachrichtentext für den Client')
/*Senden einer Nachricht per client_id mit einer Verzögerung von 30 Sekunden*/
message(73704021, 'Hallo! Danke für Ihre Nachricht..','',30)
/*Senden einer Nachricht von Block 3190 per client_id am 03.04.2022 um 15 Uhr*/
message(73704021, '',3190, '03.04.2022 15:00')

/*Senden einer Nachricht in Whatsapp*/
whatsapp_message('79999999999', 'Nachrichtentext für den Client')

Abrufen von client_id anhand des platform_id-Werts

get_client_id_by_platform_id()

get_client_id_by_platform_id(client_type, platform_id , group)

Nach der Ausführung gibt die Funktion die client_id zurück, wenn ein Client gefunden wird, der den angegebenen Bedingungen entspricht; andernfalls wird None zurückgegeben.

! client_type - Messenger. Den Wert für client_type finden Sie in diesem Artikel.

! platform_id - ID des Clients im angegebenen Messenger.

group - ist ein erforderlicher Parameter, wenn mehr als ein Messenger-Bot verbunden ist.

Wenn im Projekt mehrere Messenger desselben Typs verbunden sind, erfolgt die Suche über alle verbundenen Messenger dieses Typs.

In diesem Fall empfehlen wir, den group-Parameter zu übergeben.

Funktion für GET-Anfragen: requests_get(url, answer_type, headers, params, auth, proxy)

! url - ist ein Link, an den die Anfrage gesendet wird

answer_type – ist ein optionaler Parameter, der definiert, was von der Serverantwort zurückgegeben werden soll: ('status' – gibt den Antwortstatuscode zurück; 'json' – gibt den JSON-Text der Antwort zurück; 'text' – gibt den rohen Text der Antwort zurück; jeder andere Wert (einschließlich des Standardwerts) gibt eine Antwort im Format: '{"status": status_code, "data": data}' zurück)

headers - ist ein optionaler Parameter zum Übergeben von Anfrage-Headern,

params - sind Parameter der GET-Anfrage (können auch direkt in die URL aufgenommen werden),

auth - ist ein optionaler Parameter, der für die API-Authentifizierung nützlich ist. Wenn Sie keinen optionalen Parameter verwenden möchten, aber den nächsten benötigen, übergeben Sie hier 0.

proxy - ist ein optionaler Parameter; akzeptiert einen Wert: "de", der die Anfrage über eine europäische IP-Adresse leitet.

Funktionen für POST-Anfragen

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

! url - ist ein Link, an den die Anfrage gesendet wird,

answer_type - ist ein optionaler Parameter, der definiert, was von der Serverantwort zurückgegeben werden soll: ('status' – gibt den Antwortstatuscode zurück; 'json' – gibt den JSON-Text der Antwort zurück; 'text' – gibt den rohen Text der Antwort zurück; jeder andere Wert (einschließlich des Standardwerts) gibt eine Antwort im Format: '{"status": status_code, "data": data}' zurück)

headers - ist ein optionaler Parameter zum Übergeben von Anfrage-Headern

data - ist ein optionaler Parameter; stellt den Anforderungstext dar, wenn die API nicht mit JSON arbeitet.

json_data - ist ein optionaler Parameter; stellt ebenfalls den Anforderungstext dar. Sie sollten jeweils nur einen dieser Parameter verwenden.

Bitte beachten Sie: Bestimmte Header-Konfigurationen können das Senden der Anfrage mit einem bestimmten Texttyp blockieren.

proxy - ist ein optionaler Parameter; akzeptiert einen Wert: "de", der die Anfrage über eine europäische IP-Adresse leitet.

Funktionen für PUT-Anfragen

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

! url - ist ein Link, an den die Anfrage gesendet wird

headers - ist ein optionaler Parameter zum Übergeben von Anfrage-Headern

data - ist ein optionaler Parameter; stellt den Anforderungstext dar, wenn die API nicht mit JSON arbeitet.

proxy - ist ein optionaler Parameter; akzeptiert einen Wert: "de", der die Anfrage über eine europäische IP-Adresse leitet.

data_is_json ist ein optionaler Parameter.
Wenn gesetzt, werden die in data übergebenen Daten im JSON-Format gesendet.
Um ihn zu aktivieren, übergeben Sie '1'.

Funktionen für PATCH-Anfragen

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

! url - ist ein Link, an den die Anfrage gesendet wird

headers - ist ein optionaler Parameter zum Übergeben von Anfrage-Headern

data - ist ein optionaler Parameter; stellt den Anforderungstext dar, wenn die API nicht mit JSON arbeitet.

proxy - ist ein optionaler Parameter; akzeptiert einen Wert: "de", der die Anfrage über eine europäische IP-Adresse leitet.

Funktionen für DELETE-Anfragen

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

! url - ist ein Link, an den die Anfrage gesendet wird

headers - ist ein optionaler Parameter zum Übergeben von Anfrage-Headern

data - ist ein optionaler Parameter; stellt den Anforderungstext dar, wenn die API nicht mit JSON arbeitet.

json_data - ist optional und kann ebenfalls als Anforderungstext verwendet werden. Es sollte jedoch jeweils nur eine Option verwendet werden

auth - ist ein optionaler Parameter, der für die API-Authentifizierung nützlich ist. Wenn Sie keinen optionalen Parameter verwenden möchten, aber den nächsten benötigen, übergeben Sie hier 0

proxy - ist ein optionaler Parameter; akzeptiert einen Wert: "de", der die Anfrage über eine europäische IP-Adresse leitet.

Funktion zum Abrufen des Blocknamens anhand seiner ID

get_block_name_by_id(block_id)

! block_id — Block-Identifikator (id)