- Comment recevoir des messages sur l'URL Webhook spécifiée dans les paramètres du projet
- Comment utiliser un webhook universel
- Comment lancer le bot
- Comment travailler avec les messages
- Comment distribuer les clients
- Comment travailler avec les variables
- Comment obtenir client_id
- Quelles autres possibilités existent
Les requêtes sont effectuées avec la méthode POST sur l'URL, c'est-à-dire https://chatter.mavibot.ai/api/{api\\_key}/{action}
Où se trouve : api_key est la clé d'accès à l'API obtenue dans les paramètres du projet :

Vous pouvez obtenir la clé d'accès en utilisant la variable #{api_key}. Elle contient la clé générée correspondante. N'oubliez pas d'en générer une avant de l'utiliser.
Lors de la copie de l'URL de la requête depuis cette page, un espace est inséré qui doit être supprimé lors de l'appel
Un exemple de copie incorrecte du lien : https://chatter.mavibot.ai/api/callback 
L'espace après .pro est facile à ne pas remarquer, mais s'il est laissé en place, la requête ne fonctionnera pas
Lors de l'envoi de la requête avec la méthode GET, n'utilisez pas de mots interdits. Consultez la bonne formation des requêtes GET
Comment recevoir des messages sur l'URL Webhook spécifiée dans les paramètres du projet

Chaque message entrant ou sortant est accompagné des requêtes POST json suivantes :
{
'id': l'identifiant du message dans le système,
'client': {
'id': l'identifiant du client dans le système,
'recepient': l'identifiant du client dans le messager,
'client_type': le type de messager,
'name': le nom du client,
'avatar': l'avatar du client,
'created_at': la date de création du client,
'tag': la clé d'abonnement,
'group': le bot auquel le client est lié,
},
'message': le texte du message,
'attachments': le tableau des liens vers les fichiers,
'message_id': l'identifiant du bloc à partir duquel le message a été envoyé,
'project_id': l'identifiant du projet,
'is_input': 1 si le message provient d'un client, 0 s'il provient du bot,
'delivered': 1 si le message est envoyé avec succès, 0 s'il y a eu une erreur,
'error_message': le message expliquant l'erreur
}
Si la requête est revenue avec une erreur, elle ne sera pas renvoyée. Si le serveur est revenu avec une erreur, les notifications continueront d'arriver malgré tout.
Comment utiliser un webhook universel
Ces méthodes peuvent désormais être lancées avec une requête POST ou GET.
Auparavant, les paramètres (avec lesquels les méthodes des clients étaient lancées, c'est-à-dire client_id) étaient très strictement écrits dans nos méthodes, ce qui imposait certaines restrictions lors de leur utilisation avec des services tiers.
Vous pouvez maintenant indiquer dans quel paramètre de la requête Mavibot recherchera l'identifiant de l'utilisateur : pour cela, un paramètre avec le préfixe value_ est utilisé, comme value_user_id et value_group_id.
De plus, la méthode d'envoi du callback callback peut être lancée en transmettant un email (client_email) et un numéro de téléphone du client (client_phone).
Les méthodes callback et whatsapp_callback ne sont pas liées aux noms des paramètres. Vous pouvez spécifier quel paramètre contiendra le numéro de téléphone, l'email et l'identifiant du client.
C'est utile lorsque vous configurez la réception du webhook via un autre site.
Pour spécifier quelle variable contient client_id, vous devez transférer value_client_id et mentionner le nom du paramètre contenant cette valeur
Pour spécifier quelle variable contient le téléphone, vous devez transférer value_phone et mentionner le nom du paramètre contenant cette valeur
Pour spécifier quelle variable contient l'email, vous devez transférer value_email et mentionner le nom du paramètre contenant cette valeur
Pour spécifier quelle variable contient user_id, vous devez transférer value_user_id et mentionner le nom du paramètre contenant cette valeur
Pour spécifier quelle variable contient group_id, vous devez transférer value_group_id et mentionner le nom du paramètre contenant cette valeur
Exemple :
Saisissez dans l'adresse 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 à la requête ci-dessous :
https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback
{"client_id":49177759, "message":"Hello world"}
Comme vous pouvez le voir, le nom du paramètre qui contient le nom est différencié par le préfixe value_
Comment lancer le bot
Le lancement du bot
POST https://chatter.mavibot.ai/api/<api_key>/callback
Cette méthode peut être utilisée pour lancer le workflow pour le client ou pour approuver une action sur un service tiers. Ce message ne sera pas visible pour le client.
Les paramètres supplémentaires transférés sont enregistrés dans les variables.
La méthode d'envoi du callback peut désormais être activée en partageant un email (client_email) ou le numéro de téléphone du client (client_phone)
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | jeton d'accès |
Corps de la requête
| Nom | Type | Description |
|---|---|---|
| client_phone | string | numéro de téléphone utilisé pour trouver le client |
| client_email | string | email utilisé pour trouver le client |
| client_id | string | identifiant du client dans l'éditeur |
| message | string | le texte du message |
**200: OK **
import requests
import json
params = {"message": "some_text", "client_id": "25554"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/callback'
requests.post(url, json=params)
Lancer le bot via le numéro sur WhatsApp
POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback
Cette méthode lance le bot dans WhatsApp après que le client se soit inscrit via le site ou après avoir laissé une demande avec son numéro de téléphone
Les paramètres supplémentaires transférés sont enregistrés dans les variables
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | jeton d'accès |
Corps de la requête
| Nom | Type | Description |
|---|---|---|
| name | string | le nom du client |
| message | string | le texte du message |
| phone | string | le numéro de téléphone du client |
| bot_id | string | l'identifiant du bot |
**200: OK **
{
// Response
}
Lancement du bot via l'identifiant Telegram
POST https://chatter.mavibot.ai/api/<api_key>/tg_callback
Cette méthode peut être utilisée pour lancer le workflow ou confirmer des actions sur un site tiers. Ce message ne sera pas visible pour le client.
Les paramètres supplémentaires transférés sont enregistrés dans les variables
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | jeton d'accès |
Corps de la requête
| Nom | Type | Description |
|---|---|---|
| message | string | le texte du message |
| user_id | string | l'identifiant de l'utilisateur dans Telegram |
| group_id | string | le nom du bot (doit se terminer par bot) |
**200: OK **
{
// Response
}
Comment travailler avec les messages
Paramètres pour l'envoi de messages
attachment_type peut prendre ces valeurs : image, video, link, file, audio
Lors de l'envoi de pièces jointes, le paramètre message n'est pas obligatoire
buttons identifie les boutons qui seront attachés au message. Le format des boutons est comparable aux paramètres avancés des boutons. Deux variantes de transmission des boutons sont possibles : une avec l'info-bulle dans les messagers sans boutons et une sans
Voici un exemple du paramètre buttons :
"buttons": {"hint": "Ce texte sera affiché dans Whatsapp",
"buttons": [
{"type": "reply",
"text": "Quels services nous pouvons fournir",
"line": 0, "index_in_line": 0},
{"type": "reply",
"text": "Infos de paiement",
"line": 0,
"index_in_line": 1},
{"type": "reply",
"text": "Nos coordonnées",
"line": 1, "index_in_line": 0},
{"type": "reply",
"text": "Laisser une demande",
"line": 1, "index_in_line": 1}
]
}
Envoyer le message au client
POST https://chatter.mavibot.ai/api/<api_key>/message
Cette méthode peut être utilisée pour envoyer des messages avec notifications. Le paramètre message est obligatoire si vous n'envoyez pas de fichier. Si vous en envoyez un, le texte n'est pas nécessaire
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | la clé d'accès |
Corps de la requête
| Nom | Type | Description |
|---|---|---|
| message_id | string | le numéro du bloc d'envoi |
| message | string | le texte du message |
| client_id | string | l'identifiant du client dans l'éditeur |
| attachment_type | string | le type d'affichage du fichier |
| attachment_url | string | l'URL du fichier |
| buttons | object | boutons |
**200: OK **
import requests
import json
params = {"message": "some_text", "client_id": "25554"}
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/message'
requests.post(url, json=params)
Envoyer des messages dans WhatsApp
POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_message
Permet d'envoyer un message au nom du bot connecté au numéro mentionné whatsapp_bot_id doit être pris dans la section « Messagers et chats ». Chaque page WhatsApp connectée reçoit une identification unique
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | la clé d'accès |
Corps de la requête
| Nom | Type | Description |
|---|---|---|
| message_id | string | le numéro du bloc d'envoi |
| whatsapp_bot_id | number | le bot WhatsApp qui envoie le message |
| attachment_url | string | l'url du fichier |
| attachment_type | string | le type d'affichage du fichier |
| message | string | le texte du message |
| phone | string | le numéro de téléphone du destinataire |
**200: OK **
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)
Envoyer des messages en masse
POST https://chatter.mavibot.ai/api/<api_key>/broadcast
Cette méthode permet la distribution de messages. Si le paramètre clients n'est pas mentionné, la diffusion sera envoyée à tous les utilisateurs. Il est nécessaire d'envoyer soit un fichier, soit un texte
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | la clé d'accès |
Corps de la requête
| Nom | Type | Description |
|---|---|---|
| message_id | string | le numéro du bloc d'envoi |
| list | string | la liste des numéros des destinataires |
| shift | string | le nombre de secondes entre les messages. 0,2 par défaut |
| message | string | le texte du message |
| clients | array | les identifiants des destinataires |
| attachment_type | string | le type d'affichage du fichier |
| attachment_url | string | l'URL du fichier |
| buttons | string | boutons |
**200: OK **
{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)
Obtenir l'historique des messages
GET https://chatter.mavibot.ai/api/<api_key>/get_history?client_id=
Obtenir l'historique des messages. Vous pouvez obtenir le paramètre client_id ICI
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | la clé d'accès |
Paramètres de requête
| Nom | Type | Description |
|---|---|---|
| client_id | string | l'identifiant du client |
**200: OK **
{
"status": "success",
"result": [
{
"id": 104500,
"answered": true,
"client_replica": false,
"message_id": 390,
"message_from_outside": 0,
"created_at": 1587895014,
"text": "CouCou",
"attachments": {
},
"delivered": true,
"error_message": "true"
},
]
}
Effacer l'historique des messages
GET https://chatter.mavibot.ai/api/<api_key>/clear_history?client_id=
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | la clé d'accès |
Paramètres de requête
| Nom | Type | Description |
|---|---|---|
| client_id | string | l'identifiant du client |
**200: OK **
import requests
import json
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/clear_history?client_id=85856'
requests.get(url)
Comment distribuer les clients
Assigner un client à un employé
GET https://chatter.mavibot.ai/api/<api_key>/assign_to_user
Cette méthode permet d'assigner un client à un employé. Le paramètre email est facultatif. Si l'email n'est pas fourni, la distribution se fera via l'algorithme du système
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | la clé d'accès |
Paramètres de requête
| Nom | Type | Description |
|---|---|---|
| client_id | String | l'identifiant du client |
| String | l'email du travailleur (facultatif) |
**200: OK **
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)
Charger des clients dans le système
GET https://chatter.mavibot.ai/api/<api_key>/load_clients
Cette méthode permet de charger des clients dans le système. Lors du téléchargement de clients WhatsApp, vous pouvez transférer librement le numéro avec @s.whatsapp.net à la fin ou sans.
Vous pouvez obtenir l'identifiant du groupe (group_id) ici via /api/<api_key>/connected_channels
(si client_type=13 (téléphonie) alors group_id=””)
Vous pouvez voir le type de messager d'où vient le client (client_type)
Ex. : [{"platform_id":"79875555555","group_id":34810,"client_type":6}]
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | la clé d'accès |
Corps de la requête
| Nom | Type | Description |
|---|---|---|
| platform_id | String | le numéro de téléphone |
| group_id | String | l'identifiant du groupe |
| client_type | String | le type de messager d'où vient le client |
**200: OK **
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 retourne pour chaque élément son identifiant et son statut d'ajout
# exemple de réponse
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}
Ajouter des clients à la liste
POST https://chatter.mavibot.ai/api/<api_key>/add_to_list
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | la clé d'accès |
Corps de la requête
| Nom | Type | Description |
|---|---|---|
| list_id | integer | le numéro de la liste |
| clients | array | le tableau des numéros des clients |
**200: OK **
{
// Response
}
Supprimer des clients de la liste
POST https://chatter.mavibot.ai/api/<api_key>/remove_from_list
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | la clé d'accès |
Corps de la requête
| Nom | Type | Description |
|---|---|---|
| list_id | integer | le numéro de la liste |
| clients | array | le tableau des numéros des clients |
**200: OK **
{
// Response
}
Obtenir la liste des clients
POST https://chatter.mavibot.ai/api/<api_key>/get_clients
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | la clé d'accès |
Paramètres de requête
| Nom | Type | Description |
|---|---|---|
| offset | string | décalage par rapport au premier élément |
| limit | integer | le nombre d'éléments dans la réponse. 500 par défaut, max. 500 |
| list | string | le numéro de la liste |
200: OK Retourne le statut et le tableau des é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
}
]
}
Obtenir la liste des abonnés dans n'importe quel messager
POST https://chatter.mavibot.ai/api/<api_key>/subscribers
Obtenir les informations sur les clients dans le messager choisi
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | la clé d'accès |
Paramètres de requête
| Nom | Type | Description |
|---|---|---|
| page | integer | |
| tag | string | le tag qui a été mentionné sur la page d'abonnement |
| group | integer | l'identifiant du groupe auquel l'abonné est lié |
| date_from | integer | timestamp de la date après laquelle ils se sont abonnés |
| date_to | integer | timestamp de la date jusqu'à laquelle ils se sont abonnés |
| client_type | integer | l'identifiant du messager pour lequel vous avez besoin de la sous-liste. si vous ne changez rien, tous les clients apparaissent |
**200: OK **
[
{
"id": 44886,
"tag": null,
"created_at": 1609867984,
"name": "John Smith",
"tg_id": "146467928",
"group": "155824294",
"variables": null
},
{
"id": 44889,
"tag": null,
"created_at": 1609867984,
"name": "Jane Austen",
"tg_id": "1609867984",
"group": "155824294",
"variables": {
"utm_source": "some_value"
}
}
]
Autorisation de supprimer des clients
POST ``https://chatter.mavibot.ai/api/<api_key>/get_clients
Autorisation d'accès lors de la génération de la clé : « Autorisation de supprimer des clients »
Paramètres
Chemin
api key* — jeton d'accès
Corps
client_ids — liste des identifiants clients à supprimer. Maximum 500. Exemple : [199571, 199707, 1935722]
Comment travailler avec les variables
Attribuer des variables
POST https://chatter.mavibot.ai/api/<api_key>/save_variables
Permet d'enregistrer des variables dans l'application et chez le client.
La demande d'attribution de variables ajoute par défaut aux variables de transaction.
Si vous devez modifier les variables dans le profil, vous devez ajouter le préfixe client.
Ex. pour mobile : client.phone
Le paramètre clients permet d'attribuer des variables en masse
Ex. : {"client_id":49177759, "variables":
{"client.phone":"1234567890"}}
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | la clé d'accès |
Corps de la requête
| Nom | Type | Description |
|---|---|---|
| clients | array | tableau des identifiants clients pour attribuer des variables |
| client_id | string | identifiant du client |
| variables | object | hachage de variables (paire clé-valeur) |
**200: OK **
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)
Obtenir des variables
GET https://chatter.mavibot.ai/api/<api_key>/get_variables?client_id=
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | jeton d'accès |
Paramètres de requête
| Nom | Type | Description |
|---|---|---|
| client_id | string | identifiant client |
**200: OK **
import requests
import json
token = 'b551e18c8b8e86bea6f14f38de3f5cc3c31ba1edb4d8'
url = f'https://chatter.mavibot.ai/api/{token}/get_variables?client_id=85856'
requests.get(url)
Comment obtenir client_id
Obtenir client_id par la valeur platform_id
POST https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_platform_id
Cette méthode retourne l'identifiant du client pour exécuter des requêtes vers l'API
Exemple de paramètres : {"platform_ids": ["571830542", "256865200"]}
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| string | clé d'accès |
Corps de la requête
| Nom | Type | Description |
|---|---|---|
| platform_ids | string | tableau des identifiants dans le messager |
**200: OK **
[{
"id":15099119,
"tag":null,
"created_at":1618815253,
"name":"Oscar Wilde",
"avatar":"https:\\/\\/files.mavibot.pro\\/uploads\\/avatars\\/256865200.jpg",
"platform_id":"2568652",
"group":"Mavibotpro_bot",
"variables":{"tg_username":"@wildeo"}},
{"id":21087377,
"tag":null,
"created_at":1626275893,
"name":"Freddie Mercury",
"avatar":"https:\\/\\/files.mavibot.pro\\/uploads\\/avatars\\/571830542.jpg",
"platform_id":"571830542",
"group":"Mavibotpro_bot",
"variables":{"tg_username":"@freddieisqueen"}
}]
Comment obtenir l'identifiant client sur le chat en ligne
GET https://chatter.mavibot.ai/api/<api_key>/online_chat_client_id?recipient=
Cette méthode permet d'intégrer le site et le chatbot, c'est-à-dire que si une personne accède à la page avec l'offre spéciale, vous pouvez envoyer instantanément un message concernant l'offre dans le chat
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | jeton d'accès |
Paramètres de requête
| Nom | Type | Description |
|---|---|---|
| tag | string | tag du client |
| name | string | le nom du client |
| recipient | string | l'identifiant du dialogue sur le site |
**200: OK **
{ "client_id": 36553 }
Où obtenez-vous le recipient ? Sur le site qui utilise le chat en ligne « Mavibot.ai », vous devez obtenir la fonction MaviBotPro.recipient_id à l'aide de JS.

Comment obtenir l'identifiant client avec le numéro WhatsApp
GET https://chatter.mavibot.ai/api/<api_key>/whatsapp_client_id?phone=
Cette méthode renvoie l'identifiant du client pour exécuter des requêtes vers l'API si vous connaissez le numéro de téléphone du client dans WhatsApp.
S'il n'existe aucun client avec ce numéro, vous obtiendrez une erreur 404.
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | jeton d'accès |
Paramètres de requête
| Nom | Type | Description |
|---|---|---|
| phone | string | le numéro de téléphone |
**200: OK **
{
// Response
}
Obtenir l'identifiant client avec le numéro de téléphone
GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=
Cette méthode renvoie l'identifiant du client pour exécuter des requêtes vers l'API.
La recherche s'effectue parmi les clients WhatsApp, ainsi que via les variables.
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | jeton d'accès |
Paramètres de requête
| Nom | Type | Description |
|---|---|---|
| phone | string | le numéro de téléphone |
**200: OK **
{
// Response
}
Obtenir l'identifiant client via l'email
GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_email?email=
Cette méthode renvoie l'identifiant du client pour exécuter des requêtes vers l'API. La recherche s'effectue via les variables.
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | jeton d'accès |
Paramètres de requête
| Nom | Type | Description |
|---|---|---|
| string | email pour la recherche |
**200: OK **
{
// Response
}
Obtenir l'identifiant client par la valeur de la variable
GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_var?var=&val=
Cette méthode renvoie l'identifiant du client pour exécuter des requêtes vers l'API
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | jeton d'accès |
Paramètres de requête
| Nom | Type | Description |
|---|---|---|
| var | string | le nom de la variable sur laquelle la recherche sera effectuée |
| val | string | la valeur de la variable |
**200: OK **
{
// Response
}
Quelles autres possibilités existent
Déplacer la transaction dans l'état MavibotCRM
POST https://chatter.mavibot.ai/api/<api_key>/set_order_state
Le numéro de transaction peut être obtenu dans la fenêtre d'édition du workflow MavibotCRM.
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | la clé d'accès |
Corps de la requête
| Nom | Type | Description |
|---|---|---|
| client_id | string | identifiant du client |
| state_id | string | le numéro d'état vers lequel transférer la transaction du client |
**200: OK **
{
// Response
}
Vérifier si la personne suit le compte Instagram
GET https://chatter.mavibot.ai/api/<api_key>/check_insta_subscription
Peut être appelée avec la méthode POST ou GET
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | la clé d'accès |
Corps de la requête
| Nom | Type | Description |
|---|---|---|
| user_name | string | le nom d'utilisateur du client que vous souhaitez vérifier |
| login | string | le login du bot qui est vérifié |
200: OK Le champ is_follower est celui qui contient l'information indiquant si la personne suit ou non
{
"username": "beyonce",
"account_id": "1463220603",
"avatar": "https://instagram.fhel6-1.fna.fbcdn.net/v/t51.2885-19/1060168..",
"real_name": "Beyonce",
"is_follower": true,
"status": 200
}
Vérifier si le numéro de téléphone utilise WhatsApp
GET https://chatter.mavibot.ai/api/<api_key>/check_whatsapp
Pour utiliser la méthode, vous DEVEZ avoir connecté WhatsApp et Mavibot
Peut être appelée avec la méthode POST ou GET
Le numéro de téléphone peut être transféré dans n'importe quel format
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | jeton d'accès |
Corps de la requête
| Nom | Type | Description |
|---|---|---|
| phone | string | le numéro de téléphone |
**200: OK **
{
// Response
}
Obtenir la liste des messagers connectés au projet (y compris group_id)
GET https://chatter.mavibot.ai/api/<api_key>/connected_channels
La fonction retourne le paramètre group_id pour chaque messager et c'est celui-ci qui doit être transféré lors du chargement des clients
Le champ status est également retourné pour WhatsApp, et il contient une valeur de :
NOT_STARTED = 0
STARTED = 1
ASLEEP = 2
STOPPED = 3
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | jeton d'accès |
**200: OK **
{'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': []
}
Obtenir la liste des blocs du schéma du bot
GET https://chatter.mavibot.ai/api/<api_key>/get_messages
Paramètres de chemin
| Nom | Type | Description |
|---|---|---|
| api_key | string | jeton d'accès |
**200: OK **
{
// Response
}
Si vous avez besoin de méthodes supplémentaires, veuillez contacter le support client