Constructeur d'API

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/callback

Cette méthode peut être utilisée pour déclencher un entonnoir 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 également être déclenchée à l'aide de l'email 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 client ».

Chemin

clé api* - jeton d'accès

Corps

client_phone - numéro de téléphone utilisé pour rechercher le client

client_email - email utilisé pour rechercher le client

client_id - ID du client dans le builder

message - texte du message

resume_bot - True (paramètre facultatif). Si le bot est en pause, il est utilisé pour le réactiver.

Exemple : resume_bot = True

time_shift - nombre. S'il est spécifié, le message sera envoyé après le nombre de secondes donné à partir de l'heure actuelle.

send_time - date et heure au format "%Y-%m-%d %H:%M:%S" (par exemple, "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 prévaudra.

import requests
import json

params = {"message": "some_text", "client_id": "25554"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.salebot.pro/api/{token}/callback'
requests.post(url, json=params)

URL de la requête : https://chatter.mavibot.ai/api/\<api_key>/whatsapp_callback>

Cette méthode permet de déclencher le bot WhatsApp après qu'un client s'est inscrit 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 supplément seront enregistrés dans une variable

Permission d'accès lors de la génération d'une clé : "Permission de modifier ou supprimer les informations du client".

Chemin

api key* - 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 optionnel). Si le bot est en pause, utilisez ceci pour le reprendre. Exemple : resume_bot = True

time_shift - nombre. S'il est spécifié, le message sera envoyé après le nombre de secondes donné à partir de l'heure actuelle.

send_time - date et heure au format "%Y-%m-%d %H:%M:%S" (par exemple, "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 aura la priorité.

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 entonnoir 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 supplément seront enregistrés dans des variables.

Permission d'accès lors de la génération d'une clé : "Permission de modifier ou supprimer les informations du client".

Chemin

api key* - jeton d'accès

Corps

message - texte du message
user_id - ID utilisateur Telegram
group_id - nom du bot (se terminant par bot)
resume_bot - True (paramètre optionnel). Si le bot est en pause, utilisez ceci pour le reprendre. Exemple : resume_bot = True

time_shift - nombre. S'il est spécifié, le message sera envoyé après le nombre de secondes donné à partir de l'heure actuelle.

send_time - date et heure au format "%Y-%m-%d %H:%M:%S" (par exemple, "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 aura la priorité.

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 rappel 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"}

Permission d'accès lors de la génération d'une clé : "Permission de modifier ou supprimer les informations du client".

Chemin

api key* - jeton d'accès

Corps

platform_ids - Liste des ID clients dans le messager
callback_text - texte du rappel
group_id - ID du bot

time_shift - nombre. S'il est spécifié, le message sera envoyé après le nombre de secondes donné à partir de l'heure actuelle.

send_time - date et heure au format "%Y-%m-%d %H:%M:%S" (par exemple, "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 aura la priorité.

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/email\_callback

Cette méthode peut déclencher le bot email après qu'un client s'est inscrit sur le site web ou a soumis une demande avec son email. La méthode localisera l'email du client ou le créera s'il n'est pas trouvé.

Permission d'accès lors de la génération d'une clé : "Permission de modifier ou supprimer les informations du client".

Veuillez noter : tous les paramètres que vous transmettez en supplément seront enregistrés dans une variable

Chemin

api key* - jeton d'accès

Corps

name - nom du client
message - texte du message
email - adresse email
email_id_bot - adresse email du bot
resume_bot - True (paramètre optionnel).

Si le bot est en pause, utilisez ceci pour le reprendre. Exemple : resume_bot = True

time_shift - nombre. S'il est spécifié, le message sera envoyé après le nombre de secondes donné à partir de l'heure actuelle.

send_time - date et heure au format "%Y-%m-%d %H:%M:%S" (par exemple, "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 aura la priorité.

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 obligatoire sauf si vous envoyez un fichier. Si vous envoyez un fichier, le texte est optionnel.

Permission d'accès lors de la génération d'une clé : "Permission de modifier ou supprimer les informations du client".

Chemin

api key* - jeton d'accès

Corps

message_id - numéro du bloc pour l'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. S'il est spécifié, le message sera envoyé après le nombre de secondes donné à partir de l'heure actuelle.

send_time - date et heure au format "%Y-%m-%d %H:%M:%S" (par exemple, "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 aura la priorité.

import requests
import json

# Envoi d'un message texte
params = {"message": "some_text", "client_id": "25554"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/message'
requests.post(url, json=params)

# Envoi d'une pièce jointe
params = {
    "message": "some message",
    "client_id": "1234565",
    "attachment_type": "video/image/file",
    "attachment_url": "https://qwreqw"
}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/message'
requests.post(url, json=params)

# Dans 'attachment_type', spécifiez soit 'video', 'image', ou 'file'
# selon le type de pièce jointe : vidéo, image ou document.

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 pris dans la section "Messageries et chats". Chaque compte WhatsApp connecté se voit attribuer un identifiant unique par le constructeur.

Permission d'accès lors de la génération d'une clé : "Permission de modifier ou supprimer les informations du client".

Chemin

api key* - jeton d'accès

Corps

message_id - numéro du bloc pour l'envoi
whatsapp_bot_id - ID du bot WhatsApp à partir duquel 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. S'il est spécifié, le message sera envoyé après le nombre de secondes donné à partir de l'heure actuelle.

send_time - date et heure au format "%Y-%m-%d %H:%M:%S" (par exemple, "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 aura la priorité.

import requests
import json

params = {"message": "some_text", "phone": "79875146788"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/whatsapp_message'
requests.post(url, json=params)

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/broadcast

Cette méthode permet de lancer une diffusion.

Vous pouvez utiliser une des options mutuellement exclusives suivantes :

1. paramètre list — la diffusion sera envoyée à la liste spécifiée de clients.
2. paramètre clients — la diffusion sera envoyée à un tableau d'ID clients.
3. paramètres platform_ids et group_id — la diffusion sera envoyée à un tableau de platform_ids (ID de messagerie) pour le bot spécifié (group_id).
4. 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.

Permission d'accès lors de la génération d'une clé : "Permission de modifier ou supprimer les informations du client".

Chemin

api key* - jeton d'accès

Corps

list - numéro de la liste à laquelle la diffusion doit être envoyée

clients - ID clients dans le constructeur

message - texte du message

platform_ids - ID des destinataires dans le messager. Doit être utilisé avec le paramètre obligatoire group_id

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 pour l'envoi

shift — nombre de secondes entre les messages. La valeur par défaut est 0,2.

time_shift - nombre. S'il est spécifié, le message sera envoyé après le nombre de secondes donné à partir de l'heure actuelle.

send_time - date et heure au format "%Y-%m-%d %H:%M:%S" (par exemple, "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 aura la priorité.

import requests
import json

params = {"message": "some_text", "clients": ["5", "58", "110"]}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/broadcast'
requests.post(url, json=params)

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

api key* - 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 (obligatoire si stop_date est spécifié), format : jj.mm.aaaa

stop_date - date de fin de la période de sélection (obligatoire si start_date est spécifié), format : jj.mm.aaaa

{
  "status": "success",
  "result": [
    {
      "id": 104500,
      "answered": true,
      "client_replica": false,
      "message_id": 390,
      "message_from_outside": 0,
      "created_at": 1587895014,
      "text": "Meow meow",
      "attachments": {
        
      },
      "delivered": true,
      "error_message": "true",
      "manager_id": 12486,
      "manager_email": "[email protected]"
    },
  ]
}

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/clear\_history?client\_id=

Supprime l'historique des discussions

Autorisation d'accès lors de la génération de la clé : "Autorisation de modifier/supprimer les informations du client".

Chemin

api key* - jeton d'accès

Corps

client_id - ID du client

import requests
import json


token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/clear_history?client_id=85856'
requests.get(url)

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/assign\_to\_user

Cette méthode permet d'attribuer un client à un employé. Le paramètre email est facultatif. Si aucun email n'est fourni, le système attribuera le client selon son algorithme.

Autorisation d'accès lors de la génération de la clé : "Autorisation de modifier/supprimer les informations du client".

Chemin

api key* - jeton d'accès

Corps

client_id - ID du client
email - email de l'employé (facultatif)

import requests
import json

params = {"client_id":"#{client_id}","email":"[email protected]"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/broadcast'
requests.post(url, json=params)

URL de la requête : https://chatter.mavibot.pro/api/#{api\_key}/load\_clients

Cette méthode permet d'importer des clients dans le système. Lors du téléchargement 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 messagerie d'où vient 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 de la clé : "Autorisation de modifier ou supprimer les informations du client".

Chemin

api key* - jeton d'accès

Corps

platform_id - numéro de téléphone
group_id - ID du groupe
client_type - le type de messagerie d'où vient le client

import requests
import json
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/load_clients'
params = [{ "platform_id": 274827917, "group_id": 169166236, "client_type":0},
{"platform_id":"[email protected]", "group_id": "1hwF7lwEjv4SKYIGFhQnBw==", "client_type": 6}]
requests.post(url, json=params)
# en cas de succès, la fonction retournera un ID et un statut d'ajout pour chaque élément
# exemple de réponse
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}

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 de la clé : "Autorisation de modifier ou supprimer les informations du client".

Chemin

api key* - jeton d'accès

Corps

list_id - numéro de la liste
clients - tableau d'ID de clients

Exemple :
Paramètres JSON
{"list_id":1170282, "clients":[411262772, 646410963]}

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 de la clé : "Autorisation de modifier ou supprimer les informations du client".

Chemin

api key* - jeton d'accès

Corps

list_id - numéro de la liste
clients - tableau des numéros de clients dans le constructeur Mavibot (valeurs de client_id)

URL de la requête : https://chatter.mavibot.a/aipi/\<api_key>/get_clients

Autorisation d'accès lors de la génération de la clé : "Autorisation de modifier ou supprimer les informations du client".

Chemin

api key* - jeton d'accès

Corps

offset – Décalage par rapport au premier élément

limit – Nombre d'éléments dans la réponse / Par défaut : 500, Maximum : 500

list – Numéro de la 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.

Retourne le statut et un tableau d'éléments.

{
"status":"success",
"clients":[{
    "id":44483,
    "platform_id":"146467928",
    "client_type":0,
    "name":null,
    "avatar":null,
    "message_id":null,
    "project_id":1,
    "created_at":1588248599,
    "updated_at":1588248599,
    "custom_answer":null,
    "tag":null,
    "group":"143414131",
    "operator_start_dialog":null
    }
]
}

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/subscribers

Récupère les informations du client à partir d'une messagerie sélectionnée.

Remarque ! Cette méthode ne retourne pas les variables.

Autorisation d'accès lors de la génération de la clé : "Autorisation de modifier ou supprimer les informations du client".

Chemin

api key* - jeton d'accès

Corps

page
tag – Balise 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 (timestamp)
date_to – Abonné avant cette date (timestamp)
client_type – ID de la messagerie pour laquelle récupérer la liste des abonnés. S'il n'est pas spécifié, tous les clients seront retournés

[  
  {
    "id": 44886,
    "tag": null,
    "created_at": 1609867984,
    "name": "John Smith",
    "vk_id": "146467928",
    "group": "155824294",
    "variables": null
  },
  {
    "id": 44889,
    "tag": null,
    "created_at": 1609867984,
    "name": "Anna Smith",
    "vk_id": "1609867984",
    "group": "155824294",
    "variables": {
      "utm_source": "some_value"
    }
  }
]

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.&#x20;Par défaut, la requête d'attribution de variable les ajoute aux variables de l'affaire.&#x20;Pour mettre à jour les variables dans le profil du 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 de la clé : "Autorisation de modifier ou supprimer les informations du client".

Mise à jour : Le paramètre clients permet d'attribuer des variables en masse.
Exemple : {"client_id":49177759, "variables":{"client.phone":"88888888888"}}

Chemin

api key* - jeton d'accès

Corps

clients – Tableau d'ID de clients pour l'attribution de variables

client_id – ID du client

variables – Hachage de variables (paires clé-valeur)

import requests
import json

params = {"client_id": "25554", "variables": {"var_name": "var_value"}}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/save_variables'
requests.post(url, json=params)

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 de la clé : "Autorisation de modifier ou supprimer les informations du client".

Exemple : https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/get\_variables?client\_id=49177759

Chemin

api key* - jeton d'accès

Corps

client_id - ID du client

import requests
import json


token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/get_variables?client_id=85856'
requests.get(url)

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 de la clé : "Autorisation de modifier ou supprimer les informations du client".

Chemin

api key* - jeton d'accès

Corps

platform_ids - Tableau d'ID dans une messagerie
group_id - ID du bot

[{
"id":15099119,
"tag":null,
"created_at":1618815253,
"name":"ОЛЬГА БЕЛИК",
"avatar":"https:\/\/files.mavibot.ai\/uploads\/avatars\/256865200.jpg",
"platform_id":"2568652",
"group":"Mavibotai_bot",
"variables":{"tg_username":"@belik"}},

{"id":21087377,
"tag":null,
"created_at":1626275893,
"name":"John Smith",
"avatar":"https:\/\/files.mavibot.ai\/uploads\/avatars\/571830542.jpg",
"platform_id":"571830542",
"group":"Mavibotai_bot",
"variables":{"tg_username":"@jsmith61"}
}]

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/online\_chat\_client\_id?recipient=

Cette méthode 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 de la clé : "Autorisation de modifier ou supprimer les informations du client".

Chemin

api key* - jeton d'accès

Corps

tag - tag (tag client)\nname - nom du client\nrecipient - ID de dialogue 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.

{ "client_id": 36553 }

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/whatsapp\_client\_id?phone=

Cette méthode renvoie l'ID client pour effectuer des requêtes API si vous connaissez le numéro de téléphone WhatsApp du client.
Si aucun client n'existe avec ce numéro, la méthode renverra une erreur 404.

Permission d'accès lors de la génération d'une clé : "Permission de modifier ou supprimer les informations client".

Chemin

api key* - jeton d'accès

Corps

phone - numéro de téléphone\ngroup_id - ID du bot

URL de la requête : https://chatter.mavibot.ai/api/\<api_key>/find_client_id_by_phone?phone=

Cette méthode renvoie l'ID client pour effectuer des requêtes API.

La recherche est effectuée à la fois parmi les clients WhatsApp et via les variables.

Permission d'accès lors de la génération d'une clé : "Permission de modifier ou supprimer les informations client".

Chemin

api key* - jeton d'accès

Corps

phone - numéro de téléphone

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_email?email=&#x20;

Cette méthode renvoie l'ID client pour effectuer des requêtes API.
La recherche est effectuée à l'aide de variables.

Permission d'accès lors de la génération d'une clé : "Permission de modifier ou supprimer les informations client".

Chemin

api key* - jeton d'accès

Corps

email - email pour la recherche

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_var?var=\&val=

Cette méthode renvoie l'ID client pour effectuer des requêtes API.

Permission d'accès lors de la génération de la clé : "Permission de lire les informations client"

Chemin

api key* - jeton d'accès

Corps

var - nom de la variable pour la recherche
val - valeur de la variable
group_id - ID du groupe
search_in - passez la valeur 'order' pour rechercher dans les variables d'affaire ; recherche jusqu'à trois variables pour les clients du projet et renvoie une liste de clients qui possèdent toutes les variables spécifiées.

URL de la 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 le plus récemment créé pour effectuer des requêtes API. Elle recherche à la fois les variables client et d'affaire.

Permission d'accès lors de la génération de la clé : "Permission de lire les informations client"

Chemin

api key* - jeton d'accès

Corps

var - nom de la variable pour la recherche
val - valeur de la variable

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/find\_all\_client\_id\_by\_var?var=\&val=

Cette méthode renvoie une liste d'IDs clients qui possèdent la variable spécifiée avec la valeur spécifiée.

Permission d'accès lors de la génération de la clé : "Permission de lire les informations client"

Chemin

api key* - jeton d'accès

Corps

var - nom de la variable pour la recherche
val - valeur de la variable

{
    // Réponse
}

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/find\_all\_client\_id\_by\_several\_vars?var=val

Permission d'accès lors de la génération de la clé : "Permission de lire les informations client".

Chemin

api key* - jeton d'accès

Corps

variable1 - Valeur1

variable2 - Valeur2

variable3 - Valeur3

{
 "status":"success","client_ids":[93891114]
}

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/find\_clients

Cette méthode recherche par variables et renvoie une liste d'IDs 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 posséder toutes les variables spécifiées

Recherche dans les variables d'affaire, 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 PAS égal à l'une 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 même un seul client a une chaîne, la requête échouera.

Permission d'accès lors de la génération de la clé : "Permission de lire les informations client"

Paramètres

Chemin

api key* - jeton d'accès

Corps

q – paramètre obligatoire, contient les conditions de la requête pour rechercher des variables

search_in – spécifie dans les variables de quelle entité effectuer la recherche ; s'il n'est pas fourni, la recherche est effectuée sur les variables client. Peut prendre la valeur order.

include_all – si toutes les conditions dans q doivent être remplies ;

False – si au moins une condition correspond, l'entité est sélectionnée

Succès
{"status":"success","client_ids":[41203, 5622354, 785212]} 
{"status":"success","client_ids":[]} 
{"status": "fail", "message": "Parameter "q" required"} {"status": "fail", "message": "Error in parameter format"}
Erreur
{"status":"fail","message":"Something went wrong"}

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/get\_current\_order\_id

Permission d'accès lors de la génération de la clé : "Permission de lire les informations CRM".

Chemin

api key* - jeton d'accès

Corps

client_id - ID client

Réponse réussie : {"status":"success","order_id":40632}, où
order_id - ID de l'affaire en cours
Réponse d'erreur : {"status":"client_not_found"}

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/get\_orders

Permission d'accès lors de la génération de la clé : "Permission de lire les informations CRM"

Chemin

api key* - jeton d'accès

Corps

client_id - ID client

order_status - étape de l'affaire :
0 - affaires actives
1 - affaires réussies
2 - affaires échouées

Réponse réussie : {"status":"success","order_id":[40338,40340,40341]} 
Réponse d'erreur : {"status":"client_not_found"}

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/move\_order\_to\_next\_state

Permission d'accès lors de la génération de la clé : "Permission de modifier/supprimer les informations CRM"

Chemin

api key* - jeton d'accès

Corps

client_id - ID client

order_id - ID de l'affaire

Réponse réussie : 
{"status":"success","state_id":37}, où 
state_id - ID de l'étape dans MavibotCRM 
Réponse d'erreur : 
{"status":"client_not_found"}

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/get\_order\_vars

Permission d'accès lors de la génération de la clé : "Permission de lire les informations CRM"

Chemin

api key* - jeton d'accès

Corps

client_id - ID client

order_id - ID de l'affaire

variables - tableau de variables
(format:["var_name1", "var_name2"])

Réponse réussie : 
{"status":"success","result":{"var_name1":"111","var_name2":"13.04.2023"}} 

Exemple d'erreur : 
{"status":"client_not_found"}

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/set\_order\_vars

Permission d'accès lors de la génération de la clé : "Permission de modifier/supprimer les informations CRM"

Chemin

api key* - jeton d'accès

Corps

client_id - ID client

order_id - ID de l'affaire

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"})

Réponse réussie : {"status":"success"} 
Réponse d'erreur : {"status":"order 12345 not found"}

URL de la requête : https://chatter.mavibot.ai/api/#{api\_key}/create\_order

Permission d'accès lors de la génération de la clé : "Permission de modifier/supprimer les informations CRM"

Chemin

api key* - jeton d'accès

Corps

client_id - ID client

name - nom de l'affaire

description - description de l'affaire

budget - montant de l'affaire

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 email, un nouveau client sera créé.

Réponse réussie : {"status":"success","order_id":40654}, 
où order_id est l'ID de la nouvelle affaire active.
Réponse d'erreur : {"status":"client_not_found"}

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é : « Permission de modifier/supprimer les informations CRM »

Chemin

api key* - jeton d'accès

Corps

client_id - identifiant du client

state_id - le numéro de l'étape vers laquelle l'affaire du client doit être déplacée

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é : « Permission de lire les informations CRM »

Chemin

api key* - jeton d'accès

Corps

client_id - identifiant du client

state_id - identifiant de l'affaire (si non spécifié, la méthode retournera l'ID de l'étape de l'affaire en cours)

Exemple de réponse réussie :
{'status': 'success', 'state_id': 123456}

Exemple de réponse échouée :
{'status': 'order not found'}

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é : « Permission de modifier ou supprimer les informations client ».

Peut être appelée en utilisant GET ou POST.
Le numéro de téléphone peut être fourni dans n'importe quel format.

Chemin

api key* - jeton d'accès

Corps

phone - numéro de téléphone à vérifier

URL de la requête : https://chatter.mavibot.ai/api/\<api_key>/connected_channels

Autorisation d'accès lors de la génération d'une clé : « Permission de modifier ou supprimer les informations client ».

La fonction retourne le paramètre group_id pour chaque messagerie, qui doit être utilisé lors de l'importation des clients.

Pour WhatsApp, elle retourne également un champ status, qui peut avoir les valeurs suivantes :

NOT_STARTED = 0
STARTED = 1
ASLEEP = 2
STOPPED = 3

Chemin

api key* - jeton d'accès

{'project_id': 1, 
'viber': [{
        'id': 14, 
        'uri': 'mavibotstage', 
        'name': 'mavibotstage', 
        'enabled': true,
        'group_id': 11}], 
'facebook': [], 
'telegram': [{
        'id': 23, 
        'short_name': 'bulls_vs_bears_bot', 
        'name': 'bulls_vs_bears_bot', 
        'enabled': true,
        'group_id': 'bulls_vs_bears_bot'}], 
'whatsapp': [], 
'avito': [], 
'ok': [], 
'vkontakte': [{
        'id': 33, 
        'group': '143414131',
        'group_id': '143414131'}]
}

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é : « Permission de modifier ou supprimer les informations client ».

Chemin

api key* - jeton d'accès

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 délimiteur.

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'identifiant 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 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 :

1. Démarrer le bot : https://chatter.mavibotbot.ai/api/\<api_key>/callback
2. Démarrer le bot par numéro WhatsApp : https://chatter.mavibotbot.ai/api/\<api_key>/whatsapp_callback
3. Démarrer le bot par ID Telegram : https://chatter.mavibotbot.ai/api/\<api_key>/tg_callback
4. Envoyer un message de rappel au client par e-mail : https://chatter.mavibotbot.ai/api/\<api_key>/email_callback
5. Envoyer un message au client : https://chatter.mavibotbot.ai/api/\<api_key>/message
6. Envoyer un message WhatsApp : https://chatter.mavibotbot.ai/api/\<api_key>/whatsapp_message
7. Envoi groupé : https://chatter.mavibotbot.ai/api/\<api_key>/broadcast
8. Assigner des variables : https://chatter.mavibotbot.ai/api/\<api_key>/save_variables \