Créateur d’API
Certaines fonctions de requête API peuvent être exécutées dans le Calculateur.
Les requêtes sont envoyées via la POST ou GET méthode vers une URL au format suivant :
https://chatter.mavibot.ai/api/{api_key}/{action}
Où :
api_key — la clé d’accès API générée dans les paramètres du projet.
Pour utiliser le jeton dans une requête URL, vous devez d’abord générer une clé API.
Les instructions pour cela sont fournies dans la section « Génération d’une clé API ». lien
Lors de la copie d’une URL depuis cette page, un espace peut apparaître et doit être supprimé.
Exemple de lien incorrect : https://chatter.mavibot.pro /api/callback
Si l’espace après .pro subsiste, la requête ne fonctionnera pas.
N’utilisez pas de caractères interdits lors de l’envoi d’une requête GET.
Assurez-vous de bien comprendre le format correct des requêtes GET.
Comment générer une clé API
L’ancienne fonctionnalité de génération de clé API fonctionne toujours comme avant, mais elle n’est pas disponible pour les nouveaux projets.
Si votre projet possède déjà des clés API générées sans les paramètres d’accès décrits dans cette section, ces clés API existantes continueront de fonctionner normalement.
Si vous devez générer de nouvelles clés, utilisez les paramètres mis à jour.
Pour générer une clé API, allez dans les paramètres du projet :
Ensuite, allez dans la section « Intégrations » :
Vous trouverez le bouton « Ajouter une clé API » dans la section « Intégrations » :
Après avoir cliqué sur le bouton, une fenêtre modale s’ouvrira avec les paramètres d’accès et les options de génération de clé API :
Ensuite, vous devez sélectionner les autorisations d’accès pour la clé API :
La fonction API fonctionnera selon les autorisations d’accès que vous sélectionnez.
Veuillez noter !
La fonction API dépend des autorisations d’accès que vous définissez : si vous générez une clé API avec un accès en lecture seule aux informations du client, puis que vous l’utilisez pour envoyer un message à un client ou modifier ses variables, la requête API échouera. L’autorisation requise pour chaque requête API est indiquée dans la carte de requête API :
Ensuite, saisissez un nom pour la clé API :
Générez la clé API en cliquant sur le bouton « Générer » :
Après cela, cliquez sur « Terminé » et la clé api sera ajoutée à la section :
Vous pouvez ajouter autant de clés API que nécessaire, en attribuant des autorisations d’accès différentes à chacune.
Ensuite, vous devez définir une clé principale du projet. Cela vous permet d’utiliser la clé dans une URL de requête avec l’espace réservé #{api_key}.
Pour ce faire, cliquez sur le bouton « {+} » à droite de la clé API souhaitée :
Un libellé apparaîtra alors à côté de la clé, indiquant qu’il s’agit de la clé principale du projet.
Vous pouvez accéder à la clé principale du projet via api_key : générez simplement la clé requise, définissez ses autorisations et désignez-la comme clé principale du projet. Ensuite, dans le Calculateur, utilisez l’URL de requête avec l’espace réservé #{api_key}, qui contiendra la valeur de la clé principale du projet.
Toute autre clé générée avec des paramètres d’accès sera considérée comme une clé secondaire. Dans l’URL de requête, vous pouvez utiliser sa valeur à la place de #{api_key}. Pour ce faire, copiez la valeur de la clé secondaire :
et collez-la dans l’URL de requête à la place de #{api_key} :
Une clé API générée avec l’ancienne méthode est définie par défaut comme clé principale du projet et dispose de toutes les autorisations.
Remarque !
Si vous supprimez la clé définie comme clé principale du projet, vous devrez désigner manuellement une nouvelle clé comme principale.
Veuillez noter !
Si vous disposez de clés API générées avec l’ancienne méthode, elles continueront de fonctionner normalement. Il n’est pas possible de générer de nouvelles clés API de l’ancien type.
Comment recevoir des messages à l’URL Webhook spécifiée dans les paramètres du projet
Chaque message entrant ou sortant sera envoyé sous forme de requête JSON POST suivante :
Si une requête renvoie une erreur, elle ne sera pas réessayée. Même si le serveur renvoie des erreurs, les notifications continueront d’être envoyées.
Comment créer une requête JSON
Accédez aux paramètres du bloc où les données seront enregistrées dans le tableau.
Ajoutez une section Requête API.
Sélectionnez POST-JSON comme type de requête.
Ensuite, remplissez les champs de la requête :
URL de la requête — le chemin vers la fonction à appeler. Dans la documentation, il est toujours affiché sur la première ligne à côté du type de requête :
Valeurs enregistrées — une liste de paramètres de réponse avec les noms de variables où les résultats doivent être stockés, au format suivant :
request_parameter -> votre_variable
Si la réponse contient des paramètres avec une structure complexe, analysez-les comme suit :
"cell_number":{"row":4,"col":2} cell_number|row ->String; cell_number|col -> Column
En-têtes de la requête — à remplir si nécessaire. Cela inclut généralement le format des données et/ou le jeton d’accès.
Paramètres JSON — le corps de la requête, où vous spécifiez les paramètres de données au format JSON. Exemple :
{"client_id": "#{recipient_id_in_builder}", "message":"Hello!"}
Pour comprendre la structure de la réponse, écrivez #{custom_answer} dans le champ Message afin d’afficher la valeur de la variable.
Ensuite, la documentation liste les paramètres autorisés dans la section « Body » :
Comment utiliser un webhook universel
Les méthodes listées peuvent maintenant être exécutées sous forme de requêtes POST ou GET.
Auparavant, nos méthodes avaient des paramètres fixes (comme client_id et fb_id) pour déclencher les actions des abonnés, ce qui imposait certaines limitations lors de l’intégration avec des services tiers.
Vous pouvez désormais spécifier quel paramètre de requête SaleBot doit utiliser pour trouver l’ID de l’utilisateur. Utilisez un paramètre avec le préfixe value_, par exemple, value_user_id ou value_group_id.
De plus, la méthode d’envoi callback peut désormais être déclenchée à l’aide de l’e-mail du client (client_email) ou du numéro de téléphone (client_phone).
Le callback, fb_callback, et whatsapp_callback Les méthodes ne sont pas liées à des noms de paramètres spécifiques. Vous pouvez préciser quel paramètre contient le numéro de téléphone, l’e-mail ou l’ID du client.
Ceci est utile lors de la configuration de la réception d’un webhook depuis un site web.
Pour spécifier quelle variable contient client_id, utilisez le paramètre value_client_id et indiquez le nom du paramètre contenant cette valeur.
Pour spécifier quelle variable contient le numéro de téléphone, utilisez value_phone.
Pour spécifier quelle variable contient l’e-mail, utilisez value_email.
Pour spécifier quelle variable contient user_id, utilisez value_user_id.
Pour spécifier quelle variable contient group_id, utilisez value_group_id.
Pour spécifier la variable contenant le message lui-même dans le webhook, utilisez value_message (transmis de la même manière que les autres paramètres).
Exemple :
Dans l’adresse, indiquez value_client_id = my_client.
https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback?value_client_id=my_client
{"my_client":49177759, "message":"Hello world"}
La requête sera équivalente à celle ci-dessous :
https://chatter.mavibot.pro/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback
{"client_id":49177759, "message":"Hello world"}
Comme vous pouvez le voir, le nom du paramètre contenant la valeur est précédé du préfixe value_.
Veuillez noter !
Certains événements génèrent des notifications système au sein du projet.
Par exemple, il existe des notifications système avec un champ message qui n’est pas vide, mais qui ne contient aucun texte client.
En même temps, le projet peut également générer des hooks de message avec un contenu spécifique, tel que « message: new_chat_member ».
Il est donc important de vérifier le contenu : il s’agira soit d’une notification système, soit d’un hook pour un événement spécifique.
Comment démarrer le bot
Démarrer le bot
POST https://chatter.mavibot.ai/api/#{api_key}/callback
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/callback
Cette méthode peut être utilisée pour déclencher un tunnel pour un client ou confirmer une action sur une ressource externe. Le client ne verra pas ce message.
Veuillez noter : tous les paramètres que vous transmettez en plus seront enregistrés dans la variable
La méthode callback peut désormais aussi être déclenchée à l’aide de l’e-mail du client (client_email) ou de son numéro de téléphone (client_phone).
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier/supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
client_phone - numéro de téléphone utilisé pour rechercher le client
client_email - e-mail utilisé pour rechercher le client
client_id - ID du client dans le constructeur
message - texte du message
resume_bot - True (paramètre facultatif). Si le bot est en pause, cela permet de le réactiver.
Exemple : resume_bot = True
time_shift - nombre. Si spécifié, le message sera envoyé après le nombre donné de secondes à partir du moment actuel.
send_time - date et heure au format "%Y-%m-%d %H:%M:%S" (par ex. "2024-10-16 13:15:59"). Cela définit la date et l’heure d’envoi du message. Si time_shift et send_time sont tous deux spécifiés, time_shift sera prioritaire.
Démarrer le bot à l’aide d’un numéro WhatsApp
POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback
URL de la requête : https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback
Cette méthode peut déclencher le bot WhatsApp après qu’un client s’est enregistré sur le site web ou a soumis une demande avec son numéro de téléphone.
Veuillez noter : tous les paramètres que vous transmettez en plus seront enregistrés dans la variable
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
name - nom du client message - texte du message phone - numéro de téléphone du client bot_id - ID du bot resume_bot - True (paramètre facultatif). Si le bot est en pause, utilisez ceci pour le reprendre. Exemple : resume_bot = True
time_shift - nombre. Si spécifié, le message sera envoyé après le nombre donné de secondes à partir du moment actuel.
send_time - date et heure au format "%Y-%m-%d %H:%M:%S" (par ex. "2024-10-16 13:15:59"). Cela définit la date et l’heure d’envoi du message. Si time_shift et send_time sont tous deux spécifiés, time_shift sera prioritaire.
Démarrer le bot à l’aide d’un ID Telegram
POST https://chatter.mavibot.pro/api/#{api_key}/tg_callback
URL de la requête : https://chatter.mavibot.pro/api/#{api_key}/tg_callback
Cette méthode peut être utilisée pour déclencher un tunnel pour un client ou confirmer une action sur un site web externe. Le client ne verra pas ce message.
Veuillez noter : tous les paramètres que vous transmettez en plus seront enregistrés dans des variables.
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
message - texte du message user_id - ID utilisateur Telegram group_id - nom du bot (se termine par bot) resume_bot - True (paramètre facultatif). Si le bot est en pause, utilisez ceci pour le reprendre. Exemple : resume_bot = True
time_shift - nombre. Si spécifié, le message sera envoyé après le nombre donné de secondes à partir du moment actuel.
send_time - date et heure au format "%Y-%m-%d %H:%M:%S" (par ex. "2024-10-16 13:15:59"). Cela définit la date et l’heure d’envoi du message. Si time_shift et send_time sont tous deux spécifiés, time_shift sera prioritaire.
Envoi de messages callback à une liste de clients par platform_id
POST https://chatter.mavibot.ai/api/#{api_key}/send_callback_by_platform_id
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/send_callback_by_platform_id
Lorsque des clients avec un platform_id de la liste sont trouvés dans le projet, un callback sera envoyé avec le texte du champ callback_text. Limite : 1 requête = maximum 300 envois
Exemple de paramètres de requête : {"platform_ids":[407184121, "79609879898", "2rwewefw"], "callback_text": "test_callback"}
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
platform_ids - liste des IDs clients dans le messager callback_text - texte du callback group_id - ID du bot
time_shift - nombre. Si spécifié, le message sera envoyé après le nombre donné de secondes à partir du moment actuel.
send_time - date et heure au format "%Y-%m-%d %H:%M:%S" (par ex. "2024-10-16 13:15:59"). Cela définit la date et l’heure d’envoi du message. Si time_shift et send_time sont tous deux spécifiés, time_shift sera prioritaire.
Envoi d’un message callback à un client par e-mail
POST https://chatter.mavibot.ai/api/#{api_key}/email_callback
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/email_callback
Cette méthode peut déclencher le bot e-mail après qu’un client s’est enregistré sur le site web ou a soumis une demande avec son e-mail. La méthode localisera l’e-mail du client ou le créera s’il n’est pas trouvé.
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Veuillez noter : tous les paramètres que vous transmettez en plus seront enregistrés dans la variable
Chemin
clé api* - jeton d’accès
Corps
name - nom du client message - texte du message aemail - adresse e-mail email_id_bot - adresse e-mail du bot resume_bot - True (paramètre facultatif).
Si le bot est en pause, utilisez ceci pour le reprendre. Exemple : resume_bot = True
time_shift - nombre. Si spécifié, le message sera envoyé après le nombre donné de secondes à partir du moment actuel.
send_time - date et heure au format "%Y-%m-%d %H:%M:%S" (par ex. "2024-10-16 13:15:59"). Cela définit la date et l’heure d’envoi du message. Si time_shift et send_time sont tous deux spécifiés, time_shift sera prioritaire.
Comment travailler avec les messages
Paramètres d’envoi des messages
attachment_type — peut être : image, vidéo, lien, fichier ou audio. Lors de l’envoi d’une pièce jointe, le paramètre message est facultatif.
buttons — définit les boutons à joindre au message. Le format des boutons correspond aux paramètres avancés des boutons.
Les boutons peuvent être transmis de deux manières : avec un indice pour les messagers qui ne prennent pas en charge les boutons, ou sans celui-ci.
Exemple du paramètre buttons :
Envoi d’un message à un client
POST https://chatter.mavibot.ai/api/#{api_key}/message
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/message
Cette méthode peut être utilisée pour envoyer des messages de notification. Le paramètre message est requis, sauf si vous envoyez un fichier. Si vous envoyez un fichier, le texte est facultatif.
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
message_id - numéro du bloc d’envoi message - texte du message client_id - ID du client dans le constructeur attachment_type - type d’affichage du fichier. Requis si attachment_url est fourni. attachment_url - URL du fichier buttons - boutons
time_shift - nombre. Si spécifié, le message sera envoyé après le nombre donné de secondes à partir du moment actuel.
send_time - date et heure au format "%Y-%m-%d %H:%M:%S" (par ex. "2024-10-16 13:15:59"). Cela définit la date et l’heure d’envoi du message. Si time_shift et send_time sont tous deux spécifiés, time_shift sera prioritaire.
Envoi d’un message dans WhatsApp
POST https://chatter.salebot.pro/api/<api_key>/whatsapp_message
URL de la requête : https://chatter.mavibot.pro/api/<api_key>/whatsapp_message
Permet d’envoyer un message au nom du bot connecté au numéro spécifié. Le whatsapp_bot_id doit être récupéré dans la section « Messageries et chats ». Chaque compte WhatsApp connecté se voit attribuer un identifiant unique par le constructeur.
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
message_id - numéro du bloc d’envoi whatsapp_bot_id - ID du bot WhatsApp depuis lequel le message doit être envoyé attachment_url - URL du fichier attachment_type - type d’affichage du fichier. Requis si attachment_url est fourni. message - texte du message phone - numéro de téléphone du destinataire
time_shift - nombre. Si spécifié, le message sera envoyé après le nombre donné de secondes à partir du moment actuel.
send_time - date et heure au format "%Y-%m-%d %H:%M:%S" (par ex. "2024-10-16 13:15:59"). Cela définit la date et l’heure d’envoi du message. Si time_shift et send_time sont tous deux spécifiés, time_shift sera prioritaire.
Envoi de messages en masse
POST https://chatter.mavibot.ai/api/#{api_key}/broadcast
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/broadcast
Cette méthode permet de lancer une diffusion.
Vous pouvez utiliser l’une des options mutuellement exclusives suivantes:
paramètre list — la diffusion sera envoyée à la liste de clients spécifiée.
paramètre clients — la diffusion sera envoyée à un tableau d’IDs clients.
paramètres platform_ids et group_id — la diffusion sera envoyée à un tableau de platform_ids (IDs du messager) pour le bot spécifié (group_id).
Si aucun des paramètres ci-dessus n’est fourni, la diffusion ne sera pas envoyée.
Paramètres requis : message (et/ou attachment_type et attachment_url) ou message_id.
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
list - numéro de liste à laquelle la diffusion doit être envoyée
clients - IDs clients dans le constructeur
message - texte du message
platform_ids - IDs des destinataires dans le messager. Doit être utilisé avec le paramètre group_id requis
group_id - requis uniquement lors de l’utilisation de platform_ids. Ignoré avec les autres options. Spécifie le bot pour l’envoi aux platform_ids donnés
attachment_url - URL du fichier
attachment_type - type d’affichage du fichier. Requis si attachment_url est fourni.
buttons - boutons
message_id - numéro du bloc d’envoi
shift — nombre de secondes entre les messages. La valeur par défaut est 0.2.
time_shift - nombre. Si spécifié, le message sera envoyé après le nombre donné de secondes à partir du moment actuel.
send_time - date et heure au format "%Y-%m-%d %H:%M:%S" (par ex. "2024-10-16 13:15:59"). Cela définit la date et l’heure d’envoi du message. Si time_shift et send_time sont tous deux spécifiés, time_shift sera prioritaire.
Récupération de l’historique des messages
GET https://chatter.mavibot.ai/api/#{api_key}/get_history?client_id=
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/get_history?client_id=
Le paramètre client_id peut être obtenu ici. lien
Autorisation d’accès lors de la génération de la clé : « Autorisation de lire les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
client_id - ID du client
limit - nombre d’éléments dans la réponse. Par défaut : 2000, maximum : 2000
start_date - date de début de la période de sélection (requis si stop_date est spécifiée), format : jj.mm.aaaa
stop_date - date de fin de la période de sélection (requis si start_date est spécifiée), format : jj.mm.aaaa
Effacer l’historique des messages
GET https://chatter.mavibot.ai/api/#{api_key}/clear_history?client_id=
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/clear_history?client_id=
Supprime l’historique du chat
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier/supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
client_id - ID du client
Comment attribuer des clients
Attribuer un client à un employé
POST https://chatter.mavibot.ai/api/#{api_key}/assign_to_user
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/assign_to_user
Cette méthode vous permet d’attribuer un client à un employé. Le paramètre email est facultatif. Si aucun e-mail n’est fourni, le système attribuera le client selon son algorithme.
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier/supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
client_id - ID du client aemail - e-mail de l’employé (facultatif)
Importation de clients dans le système
POST https://chatter.mavibot.ai/api/#{api_key}/load_clients
URL de la requête : https://chatter.mavibot.pro/api/#{api_key}/load_clients
Cette méthode vous permet d’importer des clients dans le système. Lors du téléversement de clients WhatsApp, vous pouvez fournir le numéro dans n’importe quel format, avec ou sans la terminaison @s.whatsapp.net.
L’ID du groupe (group_id) peut être obtenu ICI via /api/<api_key>/connected_channels. (Si client_type = 13 (téléphonie), alors group_id est une chaîne vide : ""). lien
Le type de messager d’où provient le client (client_type) peut être trouvé ICI. lien
Exemple : [{"platform_id":"79875555555","group_id":34810,"client_type":6}]
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
platform_id - numéro de téléphone group_id - ID du groupe client_type - type de messager d’où provient le client
Ajouter des clients à une liste
POST https://chatter.mavibot.ai/api/<api_key>/add_to_list
URL de la requête : https://chatter.mavibot.ai/api/<api_key>/add_to_list
Ajoute des clients à une liste
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
list_id - numéro de liste clients - tableau d’IDs clients
Exemple : Paramètres JSON {"list_id":1170282, "clients":[411262772, 646410963]}
Supprimer des clients d’une liste
POST https://chatter.mavibot.ai/api/#{api_key}/remove_from_list
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/remove_from_list
Supprime des clients d’une liste
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
list_id - numéro de liste clients - tableau des numéros de clients dans le constructeur Mavibot (valeurs de client_id)
Récupérer la liste des clients
GET https://chatter.mavibot.ai/api/<api_key>/get_clients
URL de la requête : https://chatter.mavibot.a/aipi/<api_key>/get_clients
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
offset – décalage à partir du premier élément
limit – nombre d’éléments dans la réponse / Par défaut : 500, maximum : 500
list – numéro de liste
reverse – indique un tri inversé (du plus ancien enregistrement au plus récent). Ce paramètre fonctionne uniquement si la liste n’est pas spécifiée.
Renvoie le statut et un tableau d’éléments.
Récupérer la liste des abonnés du bot dans n’importe quel messager
GET https://chatter.mavibot.ai/api/#{api_key}/subscribers
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/subscribers
Récupère les informations client depuis un messager sélectionné.
Remarque ! Cette méthode ne renvoie pas de variables.
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
page tag – étiquette spécifiée sur la page d’abonnement group – ID du groupe VK auquel l’abonné est lié date_from – Abonné après cette date (horodatage) date_to – Abonné avant cette date (horodatage) client_type – ID du messager pour lequel récupérer la liste des abonnés. Si non spécifié, tous les clients seront renvoyés
Comment travailler avec les variables
Affectation des variables
POST https://chatter.mavibot.ai/api/#{api_key}/save_variables
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/save_variables
! Aucune limite ne s’applique à cette requête.
Permet d’enregistrer des variables à la fois dans le lead et dans le client. Par défaut, la requête d’affectation de variables les ajoute aux variables du deal. Pour mettre à jour les variables dans le profil client, utilisez le préfixe client. Par exemple, pour un téléphone : client.phone.
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Mettre à jour: Le paramètre clients permet d’affecter des variables en masse. Exemple : {"client_id":49177759, "variables":{"client.phone":"88888888888"}}
Chemin
clé api* - jeton d’accès
Corps
clients – tableau d’IDs clients pour l’affectation des variables
client_id – ID du client
variables – table de hachage des variables (paires clé-valeur)
Récupérer les variables
GET https://chatter.mavibot.ai/api/#{api_key}/get_variables?client_id=
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/get_variables?client_id=
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Exemple : https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/get_variables?client_id=49177759
Chemin
clé api* - jeton d’accès
Corps
client_id - ID du client
Comment récupérer l’ID du client (client_id)
Récupérer client_id à l’aide de la valeur platform_id
POST https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_platform_id
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_platform_id
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
platform_ids - tableau d’ID dans un messager group_id - ID du bot
Récupérer l’ID du client depuis le chat en ligne
GET https://chatter.mavibot.ai/api/#{api_key}/online_chat_client_id?recipient=
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/online_chat_client_id?recipient=
Cette méthode vous permet d’intégrer un site web à un chatbot. Par exemple, si un utilisateur visite une page promotionnelle, vous pouvez immédiatement envoyer un message dans le chat avec une offre personnalisée.
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Chemin
api key* - jeton d’acces
Corps
tag - étiquette (tag du client) name - nom du client recipient - ID de la conversation sur un site web
Où obtenir le recipient ?
Vous pouvez l’obtenir sur le site web avec le chat en ligne Mavibot.ai, utilisez JS pour obtenir la propriété MavibotAi.recipient_id.
Récupérer client_id par numéro WhatsApp
GET https://chatter.mavibot.ai/api/#{api_key}/whatsapp_client_id?phone=
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/whatsapp_client_id?phone=
Cette méthode renvoie l’ID du client pour effectuer des requêtes API si vous connaissez le numéro WhatsApp du client. Si aucun client n’existe avec ce numéro, la méthode renverra une erreur 404.
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
phone - numéro de téléphone group_id - ID du bot
Récupérer client_id par numéro de téléphone
GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=
URL de la requête : https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=
Cette méthode renvoie l’ID du client pour effectuer des requêtes API.
La recherche est effectuée à la fois parmi les clients WhatsApp et via les variables.
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
phone - numéro de téléphone
Récupérer client_id par e-mail
GET https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_email?email=
URL de requête : https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_email?email=
Cette méthode renvoie l'ID du client pour effectuer des requêtes API. La recherche est effectuée à l'aide de variables.
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Corps
email - e-mail pour la recherche
Récupérer client_id par valeur de variable
GET https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_var?var=&val=
URL de requête : https://chatter.mavibot.ai/api/#{api_key}/find_client_id_by_var?var=&val=
Cette méthode renvoie l’ID du client pour effectuer des requêtes API.
Autorisation d'accès lors de la génération de la clé : « Autorisation de lire les informations client »
Chemin
clé api* - jeton d’accès
Corps
var - nom de la variable à rechercher val - la valeur de la variable group_id - ID du groupe search_in - passez la valeur 'order' pour rechercher dans les variables de deal ; recherche jusqu'à trois variables pour les clients de projet et renvoie une liste de clients qui possèdent toutes les variables spécifiées.
Récupérer l'ID du client créé le plus récemment par valeur de variable
GET https://chatter.mavibot.ai/api/#{api_key}/find_latest_client_id_by_var?var=&val=
URL de requête : https://chatter.mavibot.ai/api/#{api_key}/find_latest_client_id_by_var ?var=&val=
Cette méthode renvoie l'ID du client créé le plus récemment pour effectuer des requêtes API. Elle recherche à la fois dans les variables client et deal.
Autorisation d'accès lors de la génération de la clé : « Autorisation de lire les informations client »
Chemin
clé api* - jeton d’accès
Corps
var - nom de la variable à rechercher val - la valeur de la variable
Récupérer une liste de valeurs client_id par valeur de variable
GET https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_var?var=&val=
URL de requête : https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_var?var=&val=
Cette méthode renvoie une liste d'ID de clients qui ont la variable spécifiée avec la valeur spécifiée.
Autorisation d'accès lors de la génération de la clé : « Autorisation de lire les informations client »
Chemin
clé api* - jeton d’accès
Corps
var - nom de la variable à rechercher val - la valeur de la variable
Récupérer une liste de valeurs client_id sur la base de plusieurs valeurs de variables
GET https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_several_vars?var=val
URL de requête : https://chatter.mavibot.ai/api/#{api_key}/find_all_client_id_by_several_vars?var=val
Autorisation d'accès lors de la génération de la clé : « Autorisation de lire les informations client ».
Chemin
clé API* - jeton d'accès
Corps
variable1 - Valeur1
variable2 - Valeur2
variable3 - Valeur3
Recherche par variables
POST https://chatter.mavibot.ai/api/#{api_key}/find_clients
URL de requête : https://chatter.mavibot.ai/api/#{api_key}/find_clients
Cette méthode recherche par variables et renvoie une liste d'ID de clients qui répondent aux conditions de la requête.
Par défaut, la recherche est effectuée sur les variables client (recommandé) : {"q": {"result": "ok", "var": "home", "var": "60"}} – le client doit avoir toutes les variables spécifiées
Recherche dans les variables de deal, au moins une des variables spécifiées doit être présente : {"q": {"result": "ok", "var": "home", "var": "60"}, "search_in": "order", "include_all": False}
Le nom de la variable client est égal à l'une des valeurs de la liste : {"q": {"name": {"_in": ["Joe", "Jane", "Donald"]}}}
Le nom de la variable client n'est ÉGAL à aucune des valeurs de la liste : {"q": {"name": {"_not_in": ["Joe", "Jane", "Donald"]}}}
Le nom de la variable client n'est pas égal à "Joe" : {"q": {"name": {"_not": "Joe"}}}
Remarque : la comparaison de nombres fonctionne uniquement si tous les clients ont des valeurs numériques dans la variable recherchée. Si un seul client a une chaîne de caractères, la requête échouera.
Autorisation d'accès lors de la génération de la clé : « Autorisation de lire les informations client »
Paramètres
Chemin
clé api* - jeton d’accès
Corps
q – paramètre requis, contient les conditions de requête pour la recherche de variables
search_in – spécifie les variables de quelle entité rechercher ; si non fourni, la recherche est effectuée sur les variables client. Peut prendre la valeur order.
include_all – indique si toutes les conditions de q doivent être remplies ;
False – si au moins une condition correspond, l'entité est sélectionnée
Comment travailler avec les deals
Récupérer l'ID du deal actuel
GET https://chatter.mavibot.ai/api/#{api_key}/get_current_order_id
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/get_current_order_id
Autorisation d'accès lors de la génération de la clé : « Autorisation de lire les informations CRM ».
Chemin
clé api* - jeton d’accès
Corps
client_id - ID du client
Récupérer la liste des deals
GET https://chatter.mavibot.ai/api/#{api_key}/get_orders
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/get_orders
Autorisation d'accès lors de la génération de la clé : « Autorisation de lire les informations CRM »
Chemin
clé api* - jeton d’accès
Corps
client_id - ID du client
order_status - étape du deal : 0 - deals actifs 1 - deals réussis 2 - deals non réussis
Déplacer un deal vers l'étape suivante du tunnel Mavibot
POST https://chatter.mavibot.ai/api/#{api_key}/move_order_to_next_state
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/move_order_to_next_state
Autorisation d'accès lors de la génération de la clé : « Autorisation de modifier/supprimer les informations CRM »
Chemin
clé api* - jeton d’accès
Corps
client_id - ID du client
order_id - ID du deal
Récupérer les données du deal
POST https://chatter.mavibot.ai/api/#{api_key}/get_order_vars
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/get_order_vars
Autorisation d'accès lors de la génération de la clé : « Autorisation de lire les informations CRM »
Chemin
clé api* - jeton d’accès
Corps
client_id - ID du client
order_id - ID du deal
variables - tableau de variables (format:["var_name1", "var_name2"])
Ajouter des variables de deal
POST https://chatter.mavibot.ai/api/#{api_key}/set_order_vars
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/set_order_vars
Autorisation d'accès lors de la génération de la clé : « Autorisation de modifier/supprimer les informations CRM »
Chemin
clé api* - jeton d’accès
Corps
client_id - ID du client
order_id - ID du deal
variables - un dictionnaire de variables (la clé est le nom de la variable, et la valeur est ce qui doit être enregistré dans cette variable) (format:{"var_name": "var_velue"})
Créer un deal
POST https://chatter.mavibot.ai/api/#{api_key}/create_order
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/create_order
Autorisation d'accès lors de la génération de la clé : « Autorisation de modifier/supprimer les informations CRM »
Chemin
clé api* - jeton d’accès
Corps
client_id - ID du client
name - nom du deal
description - description du deal
budget - montant du deal
Vous devez spécifier l'un des paramètres suivants dans la requête : client_id, email ou phone. Si plusieurs paramètres sont fournis, un seul sera utilisé. L'ordre de priorité est : client_id > phone > email. Si phone ou email est fourni et qu'aucun client n'existe avec ce numéro de téléphone ou cet e-mail, un nouveau client sera créé.
Déplacer un deal vers une étape dans MavibotCRM
POST https://chatter.mavibot.ai/api/#{api_key}/set_order_state
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/set_order_state
Autorisation d'accès lors de la génération de la clé : « Autorisation de modifier/supprimer les informations CRM »
Chemin
clé api* - jeton d’accès
Corps
client_id - ID du client
state_id - le numéro d'étape vers laquelle le deal du client doit être déplacé
Récupérer l'ID de l'étape du tunnel dans Mavibot CRM
GET https://chatter.mavibot.ai/api/#{api_key}/get_order_state
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/get_order_state
Autorisation d'accès lors de la génération de la clé : « Autorisation de lire les informations CRM »
Chemin
clé api* - jeton d’accès
Corps
client_id - ID du client
state_id - ID du deal (si non spécifié, la méthode renverra l'ID de l'étape du deal actuel)
Quelles autres fonctionnalités sont disponibles ?
Vérifier si un numéro de téléphone a WhatsApp
GET https://chatter.mavibot.ai/api/#{api_key}/check_whatsapp
URL de la requête : https://chatter.mavibot.ai/api/#{api_key}/check_whatsapp
Pour utiliser cette méthode, WhatsApp doit être connecté à Mavibot.
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Peut être appelé via GET ou POST. Le numéro de téléphone peut être fourni dans n'importe quel format.
Chemin
clé api* - jeton d’accès
Corps
phone - numéro de téléphone à vérifier
Obtenir la liste des messageries connectées au projet
GET https://chatter.mavibot.ai/api/<api_key>/connected_channels
URL de requête : https://chatter.mavibot.ai/api/<api_key>/connected_channels
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
La fonction renvoie le paramètre group_id pour chaque messagerie, qui doit être utilisé lors de l'importation des clients.
Pour WhatsApp, elle renvoie également un status champ, qui peut prendre les valeurs suivantes :
NOT_STARTED = 0 STARTED = 1 ASLEEP = 2 STOPPED = 3
Chemin
clé api* - jeton d’accès
Récupérer la liste des blocs du flux du bot
GET https://chatter.mavibot.ai/api/<api_key>/get_messages
URL de la requête : https://chatter.mavibot.ai/api/<api_key>/get_messages
Autorisation d’accès lors de la génération d’une clé : « Autorisation de modifier ou supprimer les informations du client ».
Chemin
clé api* - jeton d’accès
Récupérer des données client imbriquées
delimiter
Pour récupérer client_id et/ou le numéro de téléphone du client à partir de dictionnaires imbriqués (pas au premier niveau), utilisez le paramètre delimiter.
Ajoutez ce qui suit à l'URL de votre requête :
?delimiter=1&delimiter_value_client_id={key1}1{key2}&delimiter_value_phone={key1}1{key2}
où :
?delimiter=1 – la valeur du délimiteur qui sépare les clés {key1}1{key2}1{key3}
delimiter_value_client_id={key1}1{key2} – pour récupérer l'ID du client
delimiter_value_phone={key1}1{key2} – pour récupérer le numéro de téléphone du client
{key1}, {key2}, … – clés contenant les valeurs (peuvent inclure n'importe quel caractère sauf le délimiteur). Vous pouvez avoir un nombre illimité de clés : ?delimiter=1&delimiter_value_client_id={key1}1{key2}1{key3}1{key4}1{key5}1{key6}. Les clés sont transmises sans accolades.
Utilisez le délimiteur entre les clés. Par exemple, si delimiter=2, alors {key1}2{key2}2{key3} ; si delimiter=5, alors {key1}5{key2}5{key3}. Assurez-vous que la clé ne contient pas le caractère délimiteur.
Exemple :
https://chatter.mavibot.a/aipi/<api_key>/callback?delimiter=1&delimiter_value_client_id={key1}1{key2}&delimiter_value_phone={key1}1{key2}
Vous pouvez également récupérer uniquement l'ID ou uniquement le numéro de téléphone :
https://chatter.salebot.pro/api/<api_key>/callback?delimiter=1&delimiter_value_client_id={key1}1{key2} - uniquement l'ID du client ;
https://chatter.salebot.pro/api/<api_key>/callback?delimiter=1delimiter_value_phone={key1}1{key2} - uniquement le numéro de téléphone ;
Méthodes API :
Démarrer le bot : https://chatter.mavibotbot.ai/api/<api_key>/callback
Démarrer le bot par numéro WhatsApp : https://chatter.mavibotbot.ai/api/<api_key>/whatsapp_callback
Démarrer le bot par ID Telegram : https://chatter.mavibotbot.ai/api/<api_key>/tg_callback
Envoyer un message de callback au client e-mail : https://chatter.mavibotbot.ai/api/<api_key>/email_callback
Envoyer un message au client : https://chatter.mavibotbot.ai/api/<api_key>/message
Envoyer un message WhatsApp : https://chatter.mavibotbot.ai/api/<api_key>/whatsapp_message
Messagerie de masse : https://chatter.mavibotbot.ai/api/<api_key>/broadcast
Attribuer des variables : https://chatter.mavibotbot.ai/api/<api_key>/save_variables
Si vous avez besoin de méthodes supplémentaires, veuillez contacter le support.
Mis à jour