Les fonctions API sont disponibles uniquement sur les formules « Business » et « MaviBot AI ».
API MaviBot
LÉGENDE :\ ! -Paramètres obligatoires
Comment envoyer un callback
callback()
Vous ne pouvez envoyer un callback qu'à un AUTRE client.
Vous NE POUVEZ PAS envoyer un callback à VOUS-MÊME !
callback(client_id, callback_message)
Paramètres :
! client_id - identifiant du client
! callback_message - texte du message de callback
Un callback est un message système spécial que le bot reconnaît comme une commande pour déclencher une action spécifique. Ce message est invisible pour l'utilisateur et est uniquement enregistré 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.
callback('73704021', 'callback TEST123')
callback(client_id, 'callback TEST123')
Comment envoyer un callback dans Telegram
tg_callback()
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.
Voici un exemple avec les paramètres obligatoires :
Voici un exemple avec les paramètres facultatifs :
tg_callback('73704021', 'callback TEST123')
tg_callback(platform_id, 'callback TEST123', None, 1)
Comment ajouter une redirection de bot avec une balise en réponse à un bouton de callback ?
tg_callback_url_open(callback_query_id, url)
Paramètres : \ ! callback_query_id - cet identifiant permet d'identifier la personne qui a appuyé sur le bouton et de lui afficher une notification Alert,\ ! url - URL spécifiant le bot et le paramètre (ressemble à : t.me/your_bot?start=XXXX, à la place de your_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 = "Texte de la première ligne" + "\n" + "Texte de la deuxième ligne" + "\n" +"Texte de la troisième ligne"
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 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 toujours 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 spécifiques 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 messagerie\ ! text - texte du message
client_type - type de messagerie, paramètre facultatif. S'il n'est pas spécifié, le client sera recherché dans la même messagerie à partir de laquelle le bot envoie le message. S'il est spécifié, le client sera trouvé dans la base de données de la messagerie spécifiée. Vous pouvez trouver les types de messagerie 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. Similaire au paramètre de la fonction message() du même nom.
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 - est 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.
Un exemple simple d'envoi d'un message par client_id :
Différentes options d'envoi d'un message par client_id :
Exemple d'envoi d'un message via platform_message() :
/*Envoi d'un message par client_id*/
message(73704021, 'Texte du message pour le client')
/*Envoi d'un message par client_id avec un délai de 30 secondes*/
message(73704021, 'Bonjour ! Merci d\'avoir écrit..','',30)
/*Envoi d'un message depuis le bloc 3190 par client_id le 03.04.2022 à 15h*/
message(73704021, '',3190, '03.04.2022 15h')
/*Envoi d'un message dans Whatsapp*/
whatsapp_message('79999999999', 'Texte du message pour le client')
Obtention de client_id par la valeur platform_id
get_client_id_by_platform_id()
get_client_id_by_platform_id(client_type, platform_id , group)
Après exécution, la fonction retournera le client_id si un client correspondant aux conditions spécifiées est trouvé ; sinon, elle retournera None.
! client_type - messagerie. Pour la valeur de client_type, lisez cet article.
! platform_id - ID du client dans la messagerie spécifiée.
group - est un paramètre obligatoire si plus d'un bot de messagerie est connecté.
Si plusieurs messageries du même type sont connectées dans le projet, la recherche se fera sur toutes les messageries connectées 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)
! url - est un lien vers lequel la requête est faite
answer_type – est un paramètre facultatif qui définit ce qui doit être retourné depuis la réponse du serveur : ('status' – retourne le code de statut de la réponse ; 'json' – retourne le corps json de la réponse ; 'text' – retourne le texte brut de la réponse ; toute autre valeur (y compris la valeur par défaut) retourne 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 - sont les paramètres de la requête get (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 seule valeur : "de", qui achemine la requête via une adresse IP européenne.
Fonctions pour les requêtes POST
requests_post(url, answer_type, headers, data, json_data, auth, proxy)
! url - est un lien vers lequel la requête est faite,
answer_type - est un paramètre facultatif qui définit ce qui doit être retourné depuis la réponse du serveur : ('status' – retourne le code de statut de la réponse ; 'json' – retourne le corps json de la réponse ; 'text' – retourne le texte brut de la réponse ; toute autre valeur (y compris la valeur par défaut) retourne 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 bloquer 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 seule valeur : "de", qui achemine la requête via une adresse IP européenne.
Fonctions pour les requêtes PUT
requests_put(url, answer_type, headers, data, auth, proxy)
! url - est un lien vers lequel la requête est faite
answer_type - est un paramètre facultatif qui définit ce qui doit être retourné depuis la réponse du serveur : ('status' – retourne le code de statut de la réponse ; 'json' – retourne le corps json de la réponse ; 'text' – retourne le texte brut de la réponse ; toute autre valeur (y compris la valeur par défaut) retourne 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 seule 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 transmises 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)
! url - est un lien vers lequel la requête est faite
answer_type - est un paramètre facultatif qui définit ce qui doit être retourné depuis la réponse du serveur : ('status' – retourne le code de statut de la réponse ; 'json' – retourne le corps json de la réponse ; 'text' – retourne le texte brut de la réponse ; toute autre valeur (y compris la valeur par défaut) retourne 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 seule 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)
! url - est un lien vers lequel la requête est faite
answer_type - est un paramètre facultatif qui définit ce qui doit être retourné depuis la réponse du serveur : ('status' – retourne le code de statut de la réponse ; 'json' – retourne le corps json de la réponse ; 'text' – retourne le texte brut de la réponse ; toute autre valeur (y compris la valeur par défaut) retourne 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 seule valeur : "de", qui achemine la requête via une adresse IP européenne.
Fonction pour obtenir le nom d'un bloc par son ID
get_block_name_by_id(block_id)
! block_id — identifiant (id) du bloc