Die Anfragen werden mit der Methode POST an die URL gesendet, d.h. https://chatter.mavibot.ai/api/{api\\_key}/{action}

Wo befindet es sich: api_key ist der Schlüssel für den API-Zugriff, der in den Projekteinstellungen abgerufen wird:

Sie können den Zugriffsschlüssel mit der Variable #{api_key} abrufen. Diese enthält den relevanten generierten Schlüssel. Vergessen Sie nicht, einen zu generieren, bevor Sie ihn verwenden.

Beim Kopieren der URL der Abfrage von dieser Seite wird ein Leerzeichen eingefügt, das beim Aufruf gelöscht werden muss

Ein Beispiel für das falsche Kopieren des Links: https://chatter.mavibot.ai/api/callback 

Das Leerzeichen nach .pro ist leicht zu übersehen, aber wenn es vorhanden ist, funktioniert die Abfrage nicht

Wenn Sie die Anfrage mit der GET-Methode senden, verwenden Sie keine verbotenen Wörter. Beachten Sie die korrekte Bildung von GET-Anfragen

So erhalten Sie Nachrichten an die im Projekt festgelegte Webhook-URL

Die Projekteinstellungen

Jede eingehende oder ausgehende Nachricht wird mit den folgenden JSON-POST-Anfragen gesendet:

{
    'id': die Kennung der Nachricht im System,
    'client': {
        'id': die Kennung des Kunden im System,
        'recepient': die Kennung des Kunden im Messenger,
        'client_type': der Typ des Messengers,
        'name': der Name des Kunden,
        'avatar': der Avatar des Kunden,
        'created_at': das Datum, an dem der Kunde erstellt wurde,
        'tag': der Abonnementschlüssel,
        'group': der Bot, an den der Kunde gebunden ist,
    },
    'message': der Nachrichtentext,
    'attachments': das Array mit Links zu Dateien,
    'message_id': die ID des Blocks, von dem die Nachricht gesendet wurde,
    'project_id': die ID des Projekts,
    'is_input': 1, wenn die Nachricht von einem Kunden kommt, 0, wenn sie vom Bot kommt,
    'delivered': 1, wenn die Nachricht erfolgreich gesendet wurde, 0, wenn ein Fehler aufgetreten ist,
    'error_message': die Nachricht, die den Fehler erklärt
}

Wenn die Anfrage mit einem Fehler zurückkam, wird sie nicht erneut gesendet. Wenn der Server mit einem Fehler antwortet, werden die Benachrichtigungen trotzdem eingehen.

So verwenden Sie einen universellen Webhook

Diese Methoden können jetzt sowohl mit der POST- als auch mit der GET-Anfrage gestartet werden.

Bisher waren die Parameter (mit denen die Methoden der Kunden gestartet wurden, d.h. client_id) in unseren Methoden sehr streng festgelegt, was bei der Verwendung mit Drittanbieterdiensten zu Einschränkungen führte.

Jetzt können Sie angeben, in welchem Parameter der Anfrage Mavibot nach der Kennung des Benutzers sucht: Dazu wird ein Parameter mit dem Präfix value_ verwendet, wie value_user_id und value_group_id.

Auch die Methode zum Senden des Callbacks callback kann durch die Übertragung einer E-Mail (client_email) und einer Telefonnummer des Kunden (client_phone) gestartet werden.

Die Methoden callback und whatsapp_callback sind nicht an die Parameternamen gebunden. Sie können angeben, welcher Parameter die Telefonnummer, E-Mail und ID des Kunden enthält.

Dies ist nützlich, wenn Sie den Webhook-Empfang über eine andere Website einrichten.

Um anzugeben, welche Variable client_id enthält, müssen Sie value_client_id übergeben und den Namen des Parameters mit diesem Wert nennen

Um anzugeben, welche Variable die Telefonnummer enthält, müssen Sie value_phone übergeben und den Namen des Parameters mit diesem Wert nennen

Um anzugeben, welche Variable die E-Mail enthält, müssen Sie value_email übergeben und den Namen des Parameters mit diesem Wert nennen

Um anzugeben, welche Variable user_id enthält, müssen Sie value_user_id übergeben und den Namen des Parameters mit diesem Wert nennen

Um anzugeben, welche Variable group_id enthält, müssen Sie value_group_id übergeben und den Namen des Parameters mit diesem Wert nennen

Beispiel:

Geben Sie in der Adresse value_client_id = my_client ein

https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback?value_client_id=my_client
{"my_client":49177759, "message":"Hallo Welt"}

Die Abfrage entspricht der folgenden Abfrage:

https://chatter.mavibot.ai/api/d3f31dabef80ddeb73d43938b4ef8bb0/callback
{"client_id":49177759, "message":"Hallo Welt"}

Wie Sie sehen, wird der Name des Parameters, der den Namen enthält, durch das Präfix value_ unterschieden

So starten Sie den Bot

Der Bot-Start

POST https://chatter.mavibot.ai/api/<api_key>/callback

Die Methode kann verwendet werden, um den Workflow für den Kunden zu starten oder eine Aktion auf einem Drittanbieterdienst zu bestätigen. Diese Nachricht ist für den Kunden nicht sichtbar.
Zusätzlich übergebene Parameter werden in den Variablen gespeichert.
Die Methode zum Senden des Callbacks kann jetzt durch die Angabe einer E-Mail (client_email) oder der Telefonnummer des Kunden (client_phone) aktiviert werden.

Pfadparameter

Name Typ Beschreibung
api_key string Zugriffstoken

Anforderungstext

Name Typ Beschreibung
client_phone string Telefonnummer, mit der der Kunde gefunden wird
client_email string E-Mail, mit der der Kunde gefunden wird
client_id string ID des Kunden im Editor
message string der Nachrichtentext

**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)

Starten des Bots über die Nummer auf WhatsApp

POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_callback

Diese Methode startet den Bot in WhatsApp, nachdem sich der Kunde über die Website registriert oder eine Anfrage mit seiner Telefonnummer hinterlassen hat
Zusätzlich übergebene Parameter werden in den Variablen gespeichert

Pfadparameter

Name Typ Beschreibung
api_key string Zugriffstoken

Anforderungstext

Name Typ Beschreibung
name string der Name des Kunden
message string der Nachrichtentext
phone string die Telefonnummer des Kunden
bot_id string die ID des Bots

**200: OK **

{
    // Antwort
}

Bot-Start über Telegram-ID

POST https://chatter.mavibot.ai/api/<api_key>/tg_callback

Die Methode kann verwendet werden, um den Workflow zu starten oder Aktionen auf einer Drittanbieter-Website zu bestätigen. Diese Nachricht ist für den Kunden nicht sichtbar.

Zusätzlich übergebene Parameter werden in den Variablen gespeichert

Pfadparameter

Name Typ Beschreibung
api_key string Zugriffstoken

Anforderungstext

Name Typ Beschreibung
message string der Nachrichtentext
user_id string die ID des Benutzers in Telegram
group_id string der Name des Bots (muss auf bot enden)

**200: OK **

{
    // Antwort
}

So arbeiten Sie mit Nachrichten

Parameter zum Senden von Nachrichten

attachment_type kann diese Werte annehmen: image, video, link, file, audio
Beim Senden von Anhängen ist der Parameter message nicht zwingend erforderlich

buttons identifiziert die Schaltflächen, die an die Nachricht angehängt werden. Das Format der Schaltflächen ist vergleichbar mit den erweiterten Einstellungen der Schaltfläche. Es sind zwei Varianten der Schaltflächenübertragung möglich: eine mit dem Tooltip in Messengern ohne Schaltflächen und eine ohne

Hier ist ein Beispiel für den Parameter buttons:

"buttons": {"hint": "Dieser Text wird in Whatsapp angezeigt",
 "buttons": [
    {"type": "reply", 
     "text": "Welche Dienstleistungen wir anbieten", 
     "line": 0, "index_in_line": 0}, 
       
    {"type": "reply", 
     "text": "Zahlungsinformationen", 
     "line": 0, 
     "index_in_line": 1}, 
        
    {"type": "reply", 
     "text": "Unsere Kontaktdaten", 
     "line": 1, "index_in_line": 0}, 
        
    {"type": "reply", 
     "text": "Eine Bewerbung hinterlassen", 
     "line": 1, "index_in_line": 1}
   ] 
}

Senden der Nachricht an den Kunden

POST https://chatter.mavibot.ai/api/<api_key>/message

Diese Methode kann zum Senden von Nachrichten mit Benachrichtigungen verwendet werden. Der Parameter message ist zwingend erforderlich, wenn Sie keine Datei senden. Wenn Sie eine Datei senden, wird der Text nicht benötigt

Pfadparameter

Name Typ Beschreibung
api_key string der Zugriffsschlüssel

Anforderungstext

Name Typ Beschreibung
message_id string die Nummer des sendenden Blocks
message string der Nachrichtentext
client_id string die ID des Kunden im Editor
attachment_type string der Dateianzeigetyp
attachment_url string die URL der Datei
buttons object Schaltflächen

**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)

Senden von Nachrichten in WhatsApp

POST https://chatter.mavibot.ai/api/<api_key>/whatsapp_message

Ermöglicht das Senden einer Nachricht im Namen des verbundenen Bots an die genannte Nummer whatsapp_bot_id muss aus dem Bereich „Messenger und Chats“ entnommen werden. Jede verbundene WhatsApp-Seite erhält eine eindeutige Kennung

Pfadparameter

Name Typ Beschreibung
api_key string der Zugriffsschlüssel

Anforderungstext

Name Typ Beschreibung
message_id string die Nummer des sendenden Blocks
whatsapp_bot_id number der WhatsApp-Bot, der die Nachricht sendet
attachment_url string die URL der Datei
attachment_type string der Dateianzeigetyp
message string der Nachrichtentext
phone string die Telefonnummer des Empfängers

**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)

Massenversand von Nachrichten

POST https://chatter.mavibot.ai/api/<api_key>/broadcast

Die Methode ermöglicht die Nachrichtenverteilung. Wenn der Parameter clients nicht angegeben ist, wird die Sendung an alle Benutzer gesendet. Es ist notwendig, entweder eine Datei oder einen Text zu senden

Pfadparameter

Name Typ Beschreibung
api_key string der Zugriffsschlüssel

Anforderungstext

Name Typ Beschreibung
message_id string die Nummer des sendenden Blocks
list string die Liste der Empfängernummern
shift string die Anzahl der Sekunden zwischen den Nachrichten. Standardmäßig 0.2
message string der Nachrichtentext
clients array die IDs der Empfänger
attachment_type string der Dateianzeigetyp
attachment_url string die URL der Datei
buttons string Schaltflächen

**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)

Abrufen des Nachrichtenverlaufs

GET https://chatter.mavibot.ai/api/<api_key>/get_history?client_id=

Abrufen des Nachrichtenverlaufs. Sie können den Parameter client_id HIER abrufen

Pfadparameter

Name Typ Beschreibung
api_key string der Zugriffsschlüssel

Abfrageparameter

Name Typ Beschreibung
client_id string die ID des Kunden

**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"
    },
  ]
}

Löschen des Nachrichtenverlaufs

GET https://chatter.mavibot.ai/api/<api_key>/clear_history?client_id=

Pfadparameter

Name Typ Beschreibung
api_key string der Zugriffsschlüssel

Abfrageparameter

Name Typ Beschreibung
client_id string die ID des Kunden

**200: OK **

import requests
import json


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

So verteilen Sie die Kunden

Zuweisen eines Kunden zu einem Mitarbeiter

GET https://chatter.mavibot.ai/api/<api_key>/assign_to_user

Die Methode ermöglicht das Zuweisen eines Kunden zu einem Mitarbeiter. Der E-Mail-Parameter ist optional. Wenn die E-Mail nicht angegeben wird, erfolgt die Verteilung über den Systemalgorithmus

Pfadparameter

Name Typ Beschreibung
api_key string der Zugriffsschlüssel

Abfrageparameter

Name Typ Beschreibung
client_id String die ID des Kunden
e-mail String die E-Mail des Mitarbeiters (optional)

**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)

Laden von Kunden in das System

GET https://chatter.mavibot.ai/api/<api_key>/load_clients

Die Methode ermöglicht das Laden von Kunden in das System. Beim Hochladen von WhatsApp-Kunden können Sie die Nummer frei mit oder ohne @s.whatsapp.net am Ende übertragen.

Sie können die Gruppen-ID (group_id) hier über /api/<api_key>/connected_channels abrufen

(wenn client_type=13 (Telefonie) dann group_id=””)

Sie können den Typ des Messengers sehen, von dem der Kunde kam (client_type)

Bsp.: [{"platform_id":"79875555555","group_id":34810,"client_type":6}]

Pfadparameter

Name Typ Beschreibung
api_key string der Zugriffsschlüssel

Anforderungstext

Name Typ Beschreibung
platform_id String die Telefonnummer
group_id String die Gruppen-ID
client_type String der Typ des Messengers, von dem der Kunde kam

**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)
# im Erfolgsfall gibt die Funktion für jedes Element seine ID und den Hinzufügungsstatus zurück
# Antwortbeispiel
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}

Hinzufügen von Kunden zur Liste

POST https://chatter.mavibot.ai/api/<api_key>/add_to_list

Pfadparameter

Name Typ Beschreibung
api_key string der Zugriffsschlüssel

Anforderungstext

Name Typ Beschreibung
list_id integer die Nummer der Liste
clients array das Array der Kundennummern'

**200: OK **

{
    // Antwort
}

Entfernen von Kunden aus der Liste

POST https://chatter.mavibot.ai/api/<api_key>/remove_from_list

Pfadparameter

Name Typ Beschreibung
api_key string der Zugriffsschlüssel

Anforderungstext

Name Typ Beschreibung
list_id integer die Nummer der Liste
clients array das Array der Kundennummern'

**200: OK **

{
    // Antwort
}

Abrufen der Kundenliste

POST https://chatter.mavibot.ai/api/<api_key>/get_clients

Pfadparameter

Name Typ Beschreibung
api_key string der Zugriffsschlüssel

Abfrageparameter

Name Typ Beschreibung
offset string Versatz vom ersten Element
limit integer die Anzahl der Elemente in der Antwort. Standardmäßig 500, max. 500
list string die Nummer der Liste

200: OK Gibt den Status der Elemente und ein Array zurück

{
"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
    }
]
}

Abrufen der Abonnentenliste in einem beliebigen Messenger

POST https://chatter.mavibot.ai/api/<api_key>/subscribers

Abrufen der Informationen über die Kunden im ausgewählten Messenger

Pfadparameter

Name Typ Beschreibung
api_key string der Zugriffsschlüssel

Abfrageparameter

Name Typ Beschreibung
page integer
tag string das Tag, das auf der Abonnementseite erwähnt wurde
group integer die ID der Gruppe, an die der Abonnent gebunden ist
date_from integer Zeitstempel des Datums, nach dem sie abonniert haben
date_to integer Zeitstempel des Datums, bis zu dem sie abonniert haben
client_type integer die ID des Messengers, für den die Unterliste benötigt wird. Wenn Sie nichts ändern, werden alle Kunden angezeigt

**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"
    }
  }
]

Berechtigung zum Löschen von Kunden

POST ``https://chatter.mavibot.ai/api/<api_key>/get_clients

Zugriffsberechtigung beim Generieren des Schlüssels: „Berechtigung zum Löschen von Kunden“

Parameter

Pfad
api key* — Zugriffstoken

Text
client_ids — Liste der zu löschenden Kunden-IDs. Maximal 500. Beispiel: [199571, 199707, 1935722]

So arbeiten Sie mit Variablen

Zuweisen von Variablen

POST https://chatter.mavibot.ai/api/<api_key>/save_variables

Ermöglicht das Speichern von Variablen in der Anwendung und beim Kunden.
Die Anforderung zum Zuweisen von Variablen fügt standardmäßig Transaktionsvariablen hinzu.
Wenn Sie die Variablen im Profil ändern müssen, müssen Sie das Präfix client hinzufügen.
Bsp. für Mobil: client.phone

Der Parameter clients ermöglicht das Zuweisen von Variablen in großen Mengen

Bsp.: {"client_id":49177759, "variables":
{"client.phone":"1234567890"}}

Pfadparameter

Name Typ Beschreibung
api_key string der Zugriffsschlüssel

Anforderungstext

Name Typ Beschreibung
clients array Array der Kunden-IDs zum Zuweisen von Variablen
client_id string ID des Kunden
variables object Variablen-Hash (Schlüssel-Wert)

**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)

Abrufen von Variablen

GET https://chatter.mavibot.ai/api/<api_key>/get_variables?client_id=

Pfadparameter

Name Typ Beschreibung
api_key string Zugriffstoken

Abfrageparameter

Name Typ Beschreibung
client_id string Kunden-ID

**200: OK **

import requests
import json


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

So erhalten Sie client_id

Abrufen von client_id anhand des platform_id-Werts

POST https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_platform_id

Die Methode gibt die Kunden-ID für die Ausführung von Anfragen an die API zurück

Beispiel für Parameter: {"platform_ids": ["571830542", "256865200"]}

Pfadparameter

Name Typ Beschreibung
string Zugriffsschlüssel

Anforderungstext

Name Typ Beschreibung
platform_ids string Array der IDs im Messenger

**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"}
}]

So erhalten Sie die Kunden-ID im Online-Chat

GET https://chatter.mavibot.ai/api/<api_key>/online_chat_client_id?recipient=

Diese Methode ermöglicht die Integration von Website und Chatbot, d.h. wenn eine Person auf die Seite mit dem Sonderangebot geht, können Sie sofort eine Nachricht über das Angebot im Chat senden

Pfadparameter

Name Typ Beschreibung
api_key string Zugriffstoken

Abfrageparameter

Name Typ Beschreibung
tag string Kunden-Tag
name string der Name des Kunden
recipient string die Dialog-ID auf der Website

**200: OK **

{ "client_id": 36553 }

Woher erhalten Sie den Empfänger? Auf der Website, die den Online-Chat „Mavibot.ai“ führt, müssen Sie die Funktion MaviBotPro.recipient_id mit Hilfe von JS abrufen.

So erhalten Sie die Kunden-ID mit der WhatsApp-Nummer

GET https://chatter.mavibot.ai/api/<api_key>/whatsapp_client_id?phone=

Die Methode gibt die Kunden-ID für die Ausführung von Anfragen an die API zurück, wenn Sie die Telefonnummer des Kunden in WhatsApp kennen.
Wenn es keinen solchen Kunden mit dieser Nummer gibt, erhalten Sie eine 404.

Pfadparameter

Name Typ Beschreibung
api_key string Zugriffstoken

Abfrageparameter

Name Typ Beschreibung
phone string die Telefonnummer

**200: OK **

{
    // Antwort
}

Abrufen der Kunden-ID mit der Telefonnummer

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_phone?phone=

Die Methode gibt die Kunden-ID für die Ausführung von Anfragen an die API zurück.
Die Suche erfolgt über WhatsApp-Kunden sowie über Variablen.

Pfadparameter

Name Typ Beschreibung
api_key string Zugriffstoken

Abfrageparameter

Name Typ Beschreibung
phone string die Telefonnummer

**200: OK **

{
    // Antwort
}

Abrufen der Kunden-ID per E-Mail

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_email?email=

Die Methode gibt die Kunden-ID für die Ausführung von Anfragen an die API zurück. Die Suche erfolgt über Variablen.

Pfadparameter

Name Typ Beschreibung
api_key string Zugriffstoken

Abfrageparameter

Name Typ Beschreibung
email string E-Mail für die Suche

**200: OK **

{
    // Antwort
}

Abrufen der Kunden-ID anhand des Variablenwerts

GET https://chatter.mavibot.ai/api/<api_key>/find_client_id_by_var?var=&val=

Die Methode gibt die Kunden-ID für die Ausführung von Anfragen an die API zurück

Pfadparameter

Name Typ Beschreibung
api_key string Zugriffstoken

Abfrageparameter

Name Typ Beschreibung
var string der Name der Variable, nach der gesucht werden soll
val string der Variablenwert

**200: OK **

{
    // Antwort
}

Welche weiteren Möglichkeiten gibt es

Verschieben der Transaktion in den MavibotCRM-Status

POST https://chatter.mavibot.ai/api/<api_key>/set_order_state

Die Transaktionsnummer kann im Bearbeitungsfenster des MavibotCRM-Workflows abgerufen werden.

Pfadparameter

Name Typ Beschreibung
api_key string der Zugriffsschlüssel

Anforderungstext

Name Typ Beschreibung
client_id string ID des Kunden
state_id string die Statusnummer, in die die Transaktion des Kunden übertragen werden soll

**200: OK **

{
    // Antwort
}

Überprüfen, ob die Person dem Instagram-Konto folgt

GET https://chatter.mavibot.ai/api/<api_key>/check_insta_subscription

Kann sowohl mit der POST-Methode als auch mit der GET-Methode aufgerufen werden

Pfadparameter

Name Typ Beschreibung
api_key string der Zugriffsschlüssel

Anforderungstext

Name Typ Beschreibung
user_name string der Benutzername des Kunden, den Sie überprüfen möchten
login string der Login des Bots, der überprüft wird

200: OK Das Feld is_follower enthält die Information, ob die Person folgt oder nicht

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

Überprüfen, ob die Telefonnummer WhatsApp hat

GET https://chatter.mavibot.ai/api/<api_key>/check_whatsapp

Um die Methode zu verwenden, MÜSSEN Sie WhatsApp und Mavibot verbunden haben

Kann sowohl mit der POST-Methode als auch mit der GET-Methode aufgerufen werden
Die Telefonnummer kann in jedem Format übergeben werden

Pfadparameter

Name Typ Beschreibung
api_key string Zugriffstoken

Anforderungstext

Name Typ Beschreibung
phone string die Telefonnummer

**200: OK **

{
    // Antwort
}

Abrufen der Liste der mit dem Projekt verbundenen Messenger (einschließlich group_id)

GET https://chatter.mavibot.ai/api/<api_key>/connected_channels

Die Funktion gibt den Parameter group_id für jeden Messenger zurück, und dieser muss beim Laden der Kunden übergeben werden

Das Feld status wird auch für WhatsApp zurückgegeben und enthält einen der folgenden Werte:
NOT_STARTED = 0
STARTED = 1
ASLEEP = 2
STOPPED = 3

Pfadparameter

Name Typ Beschreibung
api_key string Zugriffstoken

**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': [] 
}

Abrufen der Liste der Blöcke aus dem Bot-Schema

GET https://chatter.mavibot.ai/api/<api_key>/get_messages

Pfadparameter

Name Typ Beschreibung
api_key string Zugriffstoken

**200: OK **

{
    // Antwort
}

Wenn Sie zusätzliche Methoden benötigen, wenden Sie sich bitte an den Kundensupport