Fonctions (API) dans la calculatrice
Les fonctions API sont disponibles uniquement dans les offres « Business » et « MaviBot AI ».
API MaviBot
LÉGENDE : ! -Paramètres requis
Comment envoyer un callback
callback()
Vous pouvez envoyer un callback uniquement à UN AUTRE client.
VOUS NE POUVEZ PAS envoyer un callback à VOUS-MÊME !
Description
callback(client_id, callback_message)
Paramètres :
! client_id - identifiant du client
! callback_message - texte du message de callback
Exemple
Un callback est un message système spécial que le bot reconnaît comme une commande déclenchant une action spécifique. Ce message est invisible pour l'utilisateur et n'est enregistré que dans le profil du client pour un traitement interne.
Envoyons un callback au client avec client_id=73704021
Ensuite, nous définissons la réponse à ce callback dans le bloc avec la condition.
Exemple de code à copier
callback('73704021', 'callback TEST123')
callback(client_id, 'callback TEST123')Comment envoyer un callback dans Telegram
tg_callback()
Description
tg_callback(platform_id , callback_message,group_id, business_connection_id)
Paramètres :
! platform_id - identifiant du client Telegram
! callback_message - texte du message de callback
group_id - identifiant du bot Telegram
tg_business - pour travailler avec des clients professionnels, la valeur « 1 » est transmise.
Exemple
Voici un exemple avec les paramètres requis :
Voici un exemple avec les paramètres facultatifs
Comment ajouter une redirection de bot avec une balise en réponse à un bouton de callback ?
Description
tg_callback_url_open(callback_query_id, url)
Paramètres : ! callback_query_id - cet identifiant vous permet d’identifier la personne qui a appuyé sur le bouton et de lui afficher une notification d’alerte, ! url - URL - spécifiant le bot et le paramètre (ressemble à : t.me/votre_bot?start=XXXX, au lieu de votre_bot - nom du bot)
Comment envoyer un message au client
message() | platform_message() | whatsapp_message()
Pour stocker un texte avec des sauts de ligne dans une variable, définissez la valeur comme suit :
text = "First line text" + "\n" + "Second line text" + "\n" +"Third line text"
Description
message(client_id, text, message_id, timeout)
Paramètres : ! client_id - identifiant du client ! text - texte du message message_id - l’ID du bloc. Si vous laissez le champ de texte vide (") et remplissez ce paramètre, le texte du bloc spécifié sera envoyé au client.
Remarque : si vous transmettez le paramètre message_id à la fonction message, le bloc sera quand même entièrement exécuté, et le client spécifié dans le paramètre client_id sera déplacé vers le bloc que vous avez transmis dans message_id.
timeout - délai du message ou heure d’envoi programmée. Vous pouvez utiliser le paramètre timeout pour retarder l’envoi du message : a) Un délai en secondes (jusqu’à 3600 secondes). Si la valeur dépasse 3600, le message sera envoyé dans une heure. Si la valeur est négative, le message sera envoyé immédiatement. Exemple : timeout = 50
b) Une date et une heure précises au format jj.mm.aaaa hh:mm, exemple : timeout = '03.04.2022 15:00'. Si une date passée est spécifiée, le message sera envoyé immédiatement.
platform_message(platform_id, text, client_type, message_id, timeout,group_id)
Paramètres : ! platform_id - identifiant du client dans le messager ! text - texte du message client_type - type de messager, paramètre facultatif. S’il n’est pas spécifié, le client sera recherché dans le même messager que celui depuis lequel le bot envoie le message. S’il est spécifié, le client sera recherché dans la base de données du messager spécifié. Vous pouvez trouver les types de messager ici. message_id - ID du bloc. S’il est spécifié, le client recevra le message du bloc spécifié, et non la valeur du paramètre text. timeout - heure d’envoi ou délai. C’est similaire au paramètre du même nom de la fonction message(). group_id - identifiant du bot
whatsapp_message(phone, text, message_id)
Paramètres : ! phone- le numéro de téléphone du client où WhatsApp est enregistré ! text - texte du message message_id - correspond à l’ID du bloc. Si le champ texte est laissé vide ('') et que ce paramètre est défini, le client recevra le contenu du message du bloc spécifié.
Le bot WhatsApp doit être connecté au projet.
Exemple
Un exemple simple d’envoi d’un message par client_id :
Différentes options pour envoyer un message par client_id :
Exemple d’envoi d’un message via platform_message() :
Obtention de client_id à partir de la valeur platform_id
get_client_id_by_platform_id()
Description
get_client_id_by_platform_id(client_type, platform_id , group)
Après exécution, la fonction renverra le client_id si un client correspondant aux conditions spécifiées est trouvé ; sinon, elle renverra None.
! client_type - messager. Pour la valeur de client_type, lisez cet article.
! platform_id - ID du client dans le messager spécifié.
group - est un paramètre requis si plus d’un bot de messagerie est connecté.
Si plusieurs messagers du même type sont connectés dans le projet, la recherche sera alors basée sur tous les messagers connectés de ce type.
Dans ce cas, nous recommandons de transmettre le paramètre group.
Fonction pour les requêtes GET : requests_get(url, answer_type, headers, params, auth, proxy)
Description
! url - est un lien sur lequel la requête est effectuée
answer_type – est un paramètre facultatif qui définit ce qui doit être renvoyé par la réponse du serveur : ('status' – renvoie le code d’état de la réponse ; 'json' – renvoie le corps JSON de la réponse ; 'text' – renvoie le texte brut de la réponse ; toute autre valeur (y compris la valeur par défaut) renvoie une réponse au format : '{"status": status_code, "data": data}')
headers - est un paramètre facultatif pour transmettre les en-têtes de la requête,
params - est get paramètres de requête (peuvent également être inclus directement dans l’URL),
auth - est un paramètre facultatif utile pour l’authentification API. Si vous ne souhaitez utiliser aucun paramètre facultatif mais avez besoin du suivant, passez 0 ici.
proxy - est un paramètre facultatif ; accepte une valeur : "de", qui achemine la requête via une adresse IP européenne.
Fonctions pour les requêtes POST
Description
requests_post(url, answer_type, headers, data, json_data, auth, proxy)
! url - est un lien sur lequel la requête est effectuée,
answer_type - est un paramètre facultatif qui définit ce qui doit être renvoyé par la réponse du serveur : ('status' – renvoie le code d’état de la réponse ; 'json' – renvoie le corps JSON de la réponse ; 'text' – renvoie le texte brut de la réponse ; toute autre valeur (y compris la valeur par défaut) renvoie une réponse au format : '{"status": status_code, "data": data}')
headers - est un paramètre facultatif pour transmettre les en-têtes de la requête
data - est un paramètre facultatif ; représente le corps de la requête lorsque l’API ne fonctionne pas avec JSON.
json_data - est un paramètre facultatif ; représente également le corps de la requête. Vous ne devez utiliser qu’un seul de ces paramètres à la fois.
Veuillez noter : certaines configurations d’en-têtes peuvent empêcher l’envoi de la requête avec un type de corps spécifique.
auth - est un paramètre facultatif utile pour l’authentification API. Si vous ne souhaitez utiliser aucun paramètre facultatif mais avez besoin du suivant, passez 0 ici
proxy - est un paramètre facultatif ; accepte une valeur : "de", qui achemine la requête via une adresse IP européenne.
Fonctions pour les requêtes PUT
Description
requests_put(url, answer_type, headers, data, auth, proxy)
! url - est un lien sur lequel la requête est effectuée
answer_type - est un paramètre facultatif qui définit ce qui doit être renvoyé par la réponse du serveur : ('status' – renvoie le code d’état de la réponse ; 'json' – renvoie le corps JSON de la réponse ; 'text' – renvoie le texte brut de la réponse ; toute autre valeur (y compris la valeur par défaut) renvoie une réponse au format : '{"status": status_code, "data": data}')
headers - est un paramètre facultatif pour transmettre les en-têtes de la requête
data - est un paramètre facultatif ; représente le corps de la requête lorsque l’API ne fonctionne pas avec JSON.
auth - est un paramètre facultatif utile pour l’authentification API. Si vous ne souhaitez utiliser aucun paramètre facultatif mais avez besoin du suivant, passez 0 ici
proxy - est un paramètre facultatif ; accepte une valeur : "de", qui achemine la requête via une adresse IP européenne.
data_is_json est un paramètre facultatif.
S’il est défini, les données passées dans data seront envoyées au format JSON.
Pour l’activer, passez '1'.
Fonctions pour les requêtes PATCH
requests_patch(url, answer_type, headers, data, auth, proxy)
Description
! url - est un lien sur lequel la requête est effectuée
answer_type - est un paramètre facultatif qui définit ce qui doit être renvoyé par la réponse du serveur : ('status' – renvoie le code d’état de la réponse ; 'json' – renvoie le corps JSON de la réponse ; 'text' – renvoie le texte brut de la réponse ; toute autre valeur (y compris la valeur par défaut) renvoie une réponse au format : '{"status": status_code, "data": data}')
headers - est un paramètre facultatif pour transmettre les en-têtes de la requête
data - est un paramètre facultatif ; représente le corps de la requête lorsque l’API ne fonctionne pas avec JSON.
auth - est un paramètre facultatif utile pour l’authentification API. Si vous ne souhaitez utiliser aucun paramètre facultatif mais avez besoin du suivant, passez 0 ici
proxy - est un paramètre facultatif ; accepte une valeur : "de", qui achemine la requête via une adresse IP européenne.
Fonctions pour les requêtes DELETE
requests_delete(url, answer_type, headers, data, json_data, auth, proxy)
Description
! url - est un lien sur lequel la requête est effectuée
answer_type - est un paramètre facultatif qui définit ce qui doit être renvoyé par la réponse du serveur : ('status' – renvoie le code d’état de la réponse ; 'json' – renvoie le corps JSON de la réponse ; 'text' – renvoie le texte brut de la réponse ; toute autre valeur (y compris la valeur par défaut) renvoie une réponse au format : '{"status": status_code, "data": data}')
headers - est un paramètre facultatif pour transmettre les en-têtes de la requête
data - est un paramètre facultatif ; représente le corps de la requête lorsque l’API ne fonctionne pas avec JSON.
json_data - est facultatif et peut également être utilisé comme corps de la requête. Cependant, une seule option doit être utilisée à la fois
auth - est un paramètre facultatif utile pour l’authentification API. Si vous ne souhaitez utiliser aucun paramètre facultatif mais avez besoin du suivant, passez 0 ici
proxy - est un paramètre facultatif ; accepte une valeur : "de", qui achemine la requête via une adresse IP européenne.
Fonction pour obtenir le nom du bloc à partir de son ID
Mis à jour