API-Builder

URL der Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/callback

Diese Methode kann verwendet werden, um einen Trichter für einen Kunden auszulösen oder eine Aktion auf einer externen Ressource zu bestätigen. Der Kunde wird diese Nachricht nicht sehen.

Bitte beachten Sie: Alle zusätzlich übergebenen Parameter werden in einer Variablen gespeichert

Die Callback-Methode kann jetzt auch mit der E-Mail-Adresse des Kunden (client_email) oder der Telefonnummer des Kunden (client_phone) ausgelöst werden.

Zugriffsberechtigung beim Generieren eines Schlüssels: „Berechtigung zum Ändern/Löschen von Kundeninformationen“.

Pfad

api key* - Zugriffstoken

Body

client_phone - Telefonnummer, die zum Nachschlagen des Kunden verwendet wird

client_email - E-Mail-Adresse, die zum Nachschlagen des Kunden verwendet wird

client_id - Kunden-ID im Builder

message - Nachrichtentext

resume_bot - True (optionaler Parameter). Wenn der Bot pausiert ist, wird dies verwendet, um ihn zu entsperren.

Beispiel: resume_bot = True

time_shift - Zahl. Wenn angegeben, wird die Nachricht nach der angegebenen Anzahl von Sekunden ab der aktuellen Zeit gesendet.

send_time - Datum und Uhrzeit im Format „%Y-%m-%d %H:%M:%S“ (z. B. „2024-10-16 13:15:59“). Dies legt das Datum und die Uhrzeit für das Senden der Nachricht fest. Wenn sowohl time_shift als auch send_time angegeben sind, hat time_shift Vorrang.

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-Anfrage: https://chatter.mavibot.ai/api/\\<api_key>/whatsapp_callback

Diese Methode kann den WhatsApp-Bot auslösen, nachdem sich ein Kunde auf der Website registriert oder eine Anfrage mit seiner Telefonnummer eingereicht hat.

Bitte beachten: Alle zusätzlich übergebenen Parameter werden in einer Variable gespeichert.

Zugriffsberechtigung bei der Generierung eines Schlüssels: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Pfad

api key* - Zugriffstoken

Body

name - Kundenname
message - Nachrichtentext
phone - Telefonnummer des Kunden
bot_id - Bot-ID
resume_bot - True (optionaler Parameter). Wenn der Bot pausiert ist, verwenden Sie dies, um ihn fortzusetzen. Beispiel: resume_bot = True

time_shift - Zahl. Wenn angegeben, wird die Nachricht nach der angegebenen Anzahl von Sekunden ab der aktuellen Zeit gesendet.

send_time - Datum und Uhrzeit im Format "%Y-%m-%d %H:%M:%S" (z. B. "2024-10-16 13:15:59"). Dies legt das Datum und die Uhrzeit für das Senden der Nachricht fest. Wenn sowohl time_shift als auch send_time angegeben sind, hat time_shift Vorrang.

URL-Anfrage: https://chatter.mavibot.pro/api/#{api\\_key}/tg\\_callback

Diese Methode kann verwendet werden, um einen Trichter für einen Kunden auszulösen oder eine Aktion auf einer externen Website zu bestätigen. Der Kunde wird diese Nachricht nicht sehen.

Bitte beachten: Alle zusätzlich übergebenen Parameter werden in Variablen gespeichert.

Zugriffsberechtigung bei der Generierung eines Schlüssels: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Pfad

api key* - Zugriffstoken

Body

message - Nachrichtentext
user_id - Telegram-Benutzer-ID
group_id - Bot-Name (endet auf bot)
resume_bot - True (optionaler Parameter). Wenn der Bot pausiert ist, verwenden Sie dies, um ihn fortzusetzen. Beispiel: resume_bot = True

time_shift - Zahl. Wenn angegeben, wird die Nachricht nach der angegebenen Anzahl von Sekunden ab der aktuellen Zeit gesendet.

send_time - Datum und Uhrzeit im Format "%Y-%m-%d %H:%M:%S" (z. B. "2024-10-16 13:15:59"). Dies legt das Datum und die Uhrzeit für das Senden der Nachricht fest. Wenn sowohl time_shift als auch send_time angegeben sind, hat time_shift Vorrang.

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\\_key}/send\\_callback\\_by\\_platform\\_id

Wenn Kunden mit einer platform_id aus der Liste im Projekt gefunden werden, wird ein Callback mit dem Text aus dem Feld callback_text gesendet.
Limit: 1 Anfrage = maximal 300 Sendungen

Beispiel für Anfrageparameter:
{"platform_ids":[407184121, "79609879898", "2rwewefw"], "callback_text": "test_callback"}

Zugriffsberechtigung bei der Generierung eines Schlüssels: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Pfad

api key* - Zugriffstoken

Body

platform_ids - Liste der Kunden-IDs im Messenger
callback_text - Callback-Text
group_id - Bot-ID

time_shift - Zahl. Wenn angegeben, wird die Nachricht nach der angegebenen Anzahl von Sekunden ab der aktuellen Zeit gesendet.

send_time - Datum und Uhrzeit im Format "%Y-%m-%d %H:%M:%S" (z. B. "2024-10-16 13:15:59"). Dies legt das Datum und die Uhrzeit für das Senden der Nachricht fest. Wenn sowohl time_shift als auch send_time angegeben sind, hat time_shift Vorrang.

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\\_key}/email\\_callback

Diese Methode kann den E-Mail-Bot auslösen, nachdem sich ein Kunde auf der Website registriert oder eine Anfrage mit seiner E-Mail-Adresse eingereicht hat. Die Methode findet die E-Mail-Adresse des Kunden oder erstellt sie, falls sie nicht gefunden wird.

Zugriffsberechtigung bei der Generierung eines Schlüssels: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Bitte beachten: Alle zusätzlich übergebenen Parameter werden in einer Variable gespeichert.

Pfad

api key* - Zugriffstoken

Body

name - Kundenname
message - Nachrichtentext
email - E-Mail-Adresse
email_id_bot - Bot-E-Mail-Adresse
resume_bot - True (optionaler Parameter).

Wenn der Bot pausiert ist, verwenden Sie dies, um ihn fortzusetzen. Beispiel: resume_bot = True

time_shift - Zahl. Wenn angegeben, wird die Nachricht nach der angegebenen Anzahl von Sekunden ab der aktuellen Zeit gesendet.

send_time - Datum und Uhrzeit im Format "%Y-%m-%d %H:%M:%S" (z. B. "2024-10-16 13:15:59"). Dies legt das Datum und die Uhrzeit für das Senden der Nachricht fest. Wenn sowohl time_shift als auch send_time angegeben sind, hat time_shift Vorrang.

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\\_key}/message

Diese Methode kann zum Senden von Benachrichtigungsnachrichten verwendet werden. Der Nachrichtenparameter ist erforderlich, es sei denn, Sie senden eine Datei. Wenn Sie eine Datei senden, ist der Text optional.

Zugriffsberechtigung bei der Generierung eines Schlüssels: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Pfad

api key* - Zugriffstoken

Body

message_id - Blocknummer zum Senden
message - Nachrichtentext
client_id - Kunden-ID im Builder
attachment_type - Dateianzeigetyp. Erforderlich, wenn attachment_url angegeben ist.
attachment_url - Datei-URL
buttons - Schaltflächen

time_shift - Zahl. Wenn angegeben, wird die Nachricht nach der angegebenen Anzahl von Sekunden ab der aktuellen Zeit gesendet.

send_time - Datum und Uhrzeit im Format "%Y-%m-%d %H:%M:%S" (z. B. "2024-10-16 13:15:59"). Dies legt das Datum und die Uhrzeit für das Senden der Nachricht fest. Wenn sowohl time_shift als auch send_time angegeben sind, hat time_shift Vorrang.

import requests
import json

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

# Senden eines Anhangs
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)

# Geben Sie in 'attachment_type' entweder 'video', 'image' oder 'file' an,
# je nach Art des Anhangs: Video, Bild oder Dokument.

URL-Anfrage: https://chatter.mavibot.pro/api/\\<api_key>/whatsapp_message

Ermöglicht das Senden einer Nachricht im Namen des verbundenen Bots an die angegebene Nummer. Die whatsapp_bot_id muss aus dem Abschnitt „Messenger und Chats“ entnommen werden. Jedes verbundene WhatsApp-Konto erhält eine eindeutige Kennung vom Builder.

Zugriffsberechtigung bei der Generierung eines Schlüssels: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Pfad

api key* - Zugriffstoken

Body

message_id - Blocknummer zum Senden
whatsapp_bot_id - WhatsApp-Bot-ID, von der die Nachricht gesendet werden soll
attachment_url - Datei-URL
attachment_type - Dateianzeigetyp. Erforderlich, wenn attachment_url angegeben ist.
message - Nachrichtentext
phone - Telefonnummer des Empfängers

time_shift - Zahl. Wenn angegeben, wird die Nachricht nach der angegebenen Anzahl von Sekunden ab der aktuellen Zeit gesendet.

send_time - Datum und Uhrzeit im Format "%Y-%m-%d %H:%M:%S" (z. B. "2024-10-16 13:15:59"). Dies legt das Datum und die Uhrzeit für das Senden der Nachricht fest. Wenn sowohl time_shift als auch send_time angegeben sind, hat time_shift Vorrang.

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-Anfrage: https://chatter.mavibot.ai/api/#{api\\_key}/broadcast

Diese Methode ermöglicht es Ihnen, einen Broadcast zu starten.

Sie können eine der folgenden sich gegenseitig ausschließenden Optionen verwenden:

1. list-Parameter — der Broadcast wird an die angegebene Liste von Kunden gesendet.
2. clients-Parameter — der Broadcast wird an ein Array von Kunden-IDs gesendet.
3. platform_ids- und group_id-Parameter — der Broadcast wird an ein Array von platform_ids (Messenger-IDs) für den angegebenen Bot (group_id) gesendet.
4. Wenn keiner der oben genannten Parameter angegeben ist, wird der Broadcast nicht gesendet.

Erforderliche Parameter: message (und/oder attachment_type und attachment_url) oder message_id.

Zugriffsberechtigung bei der Generierung eines Schlüssels: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Pfad

api key* - Zugriffstoken

Body

list - Listennummer, an die der Broadcast gesendet werden soll

clients - Kunden-IDs im Builder

message - Nachrichtentext

platform_ids - Empfänger-IDs im Messenger. Muss zusammen mit dem erforderlichen Parameter group_id verwendet werden

group_id - nur erforderlich bei Verwendung von platform_ids. Wird bei anderen Optionen ignoriert. Gibt den Bot für das Senden an die angegebenen platform_ids an

attachment_url - Datei-URL

attachment_type - Dateianzeigetyp. Erforderlich, wenn attachment_url angegeben ist.

buttons - Schaltflächen

message_id - Blocknummer zum Senden

shift — Anzahl der Sekunden zwischen Nachrichten. Der Standardwert ist 0,2.

time_shift - Zahl. Wenn angegeben, wird die Nachricht nach der angegebenen Anzahl von Sekunden ab der aktuellen Zeit gesendet.

send_time - Datum und Uhrzeit im Format "%Y-%m-%d %H:%M:%S" (z. B. "2024-10-16 13:15:59"). Dies legt das Datum und die Uhrzeit für das Senden der Nachricht fest. Wenn sowohl time_shift als auch send_time angegeben sind, hat time_shift Vorrang.

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-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/get\_history?client\_id=

Der Parameter client_id kann hier abgerufen werden. link

Zugriffsberechtigung bei der Generierung des Schlüssels: „Berechtigung zum Lesen von Kundeninformationen“.

Pfad

api key* - Zugriffstoken

Body

client_id - Kunden-ID

limit - Anzahl der Elemente in der Antwort. Standard: 2000, Maximum: 2000

start_date - Startdatum des Auswahlzeitraums (erforderlich, wenn stop_date angegeben ist), Format: dd.mm.yyyy

stop_date - Enddatum des Auswahlzeitraums (erforderlich, wenn start_date angegeben ist), Format: dd.mm.yyyy

{
  "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-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/clear\_history?client\_id=

Löscht den Chatverlauf

Zugriffsberechtigung bei der Generierung des Schlüssels: „Berechtigung zum Ändern/Löschen von Kundeninformationen“.

Pfad

api key* - Zugriffstoken

Body

client_id - Kunden-ID

import requests
import json


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

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/assign\_to\_user

Diese Methode ermöglicht es, einen Kunden einem Mitarbeiter zuzuweisen. Der Parameter email ist optional. Wenn keine E-Mail angegeben wird, weist das System den Kunden gemäß seinem Algorithmus zu.

Zugriffsberechtigung bei der Generierung des Schlüssels: „Berechtigung zum Ändern/Löschen von Kundeninformationen“.

Pfad

api key* - Zugriffstoken

Body

client_id - Kunden-ID
email - E-Mail des Mitarbeiters (optional)

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-Anfrage: https://chatter.mavibot.pro/api/#{api\_key}/load\_clients

Diese Methode ermöglicht es, Kunden in das System zu importieren. Beim Hochladen von WhatsApp-Kunden können Sie die Nummer in jedem Format angeben, entweder mit der Endung @s.whatsapp.net oder ohne.

Die Gruppen-ID (group_id) kann HIER über /api/<api_key>/connected_channels abgerufen werden. (Wenn client_type = 13 (Telefonie), dann ist group_id ein leerer String: ""). link

Der Nachrichtentyp, von dem der Kunde stammt (client_type), kann HIER gefunden werden. link

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

Zugriffsberechtigung bei der Generierung des Schlüssels: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Pfad

api key* - Zugriffstoken

Body

platform_id - Telefonnummer
group_id - Gruppen-ID
client_type - Der Nachrichtentyp, von dem ein Kunde stammt

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)
# if successful, the function will return an ID and an addition status for each item
# response example
# {"status":"success","items":[{"platform_id":"[email protected]","group_id":"5kqchxwyvdvFZOsp80q2qw==","client_type":6,"status":"success","id":1469409}]}

URL-Anfrage: https://chatter.mavibot.ai/api/\<api_key>/add_to_list

Fügt Kunden zu einer Liste hinzu

Zugriffsberechtigung bei der Generierung des Schlüssels: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Pfad

api key* - Zugriffstoken

Body

list_id - Listennummer
clients - Array von Kunden-IDs

Beispiel:
JSON-Parameter
{"list_id":1170282, "clients":[411262772, 646410963]}

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/remove\_from\_list

Entfernt Kunden aus einer Liste

Zugriffsberechtigung bei der Generierung des Schlüssels: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Pfad

api key* - Zugriffstoken

Body

list_id - Listennummer
clients - Array von Kundennummern im Mavibot-Builder (Werte von client_id)

URL-Anfrage: https://chatter.mavibot.a/aipi/\<api_key>/get_clients

Zugriffsberechtigung bei der Generierung des Schlüssels: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Pfad

api key* - Zugriffstoken

Body

offset – Offset vom ersten Element

limit – Anzahl der Elemente in der Antwort / Standard: 500, Maximum: 500

list – Listennummer

reverse – Gibt eine umgekehrte Sortierung an (vom ältesten zum neuesten Datensatz). Dieser Parameter funktioniert nur, wenn die Liste nicht angegeben ist.

Gibt den Status und ein Array von Elementen 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
    }
]
}

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/subscribers

Ruft Kundeninformationen aus einem ausgewählten Messenger ab.

Hinweis! Diese Methode gibt keine Variablen zurück.

Zugriffsberechtigung bei der Generierung des Schlüssels: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Pfad

api key* - Zugriffstoken

Body

page
tag – Auf der Abonnementseite angegebenes Tag
group – VK-Gruppen-ID, mit der der Abonnent verknüpft ist
date_from – Nach diesem Datum abonniert (Timestamp)
date_to – Vor diesem Datum abonniert (Timestamp)
client_type – Messenger-ID, für die die Abonnentenliste abgerufen werden soll. Wenn nicht angegeben, werden alle Kunden zurückgegeben

[  
  {
    "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-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/save\_variables

!** **Für diese Anfrage gilt kein Limit.

Ermöglicht das Speichern von Variablen sowohl im Lead als auch im Kunden.
Standardmäßig fügt die Anfrage zur Variablenzuweisung sie zu den Deal-Variablen hinzu.
Um Variablen im Kundenprofil zu aktualisieren, verwenden Sie das Präfix client.. Zum Beispiel für ein Telefon: client.phone.

Zugriffsberechtigung bei der Generierung des Schlüssels: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Update: Der Parameter clients ermöglicht die Massenzuweisung von Variablen.
Beispiel: {"client_id":49177759, "variables":{"client.phone":"88888888888"}}

Pfad

api key* - Zugriffstoken

Body

clients – Array von Kunden-IDs für die Variablenzuweisung

client_id – Kunden-ID

variables – Hash von Variablen (Schlüssel-Wert-Paare)

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-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/get\_variables?client\_id=

Zugriffsberechtigung bei der Generierung des Schlüssels: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

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

Pfad

api key* - Zugriffstoken

Body

client_id - Kunden-ID

import requests
import json


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

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_platform\_id

Zugriffsberechtigung bei der Generierung des Schlüssels: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Pfad

api key* - Zugriffstoken

Body

platform_ids - Array von IDs in einem Messenger
group_id - Bot-ID

[{
"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-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/online\_chat\_client\_id?recipient=

Diese Methode ermöglicht die Integration einer Website mit einem Chat-Bot. Wenn ein Benutzer beispielsweise eine Aktionsseite besucht, können Sie sofort eine Nachricht im Chat mit einem personalisierten Angebot senden.

Zugriffsberechtigung bei der Generierung des Schlüssels: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Pfad

api key* - access token

Body

tag - Tag (Client-Tag)\nname - Name des Kunden\nrecipient - Dialog-ID auf einer Website

Wo erhalte ich den recipient?

Sie können ihn auf der Website mit dem Mavibot.ai Online-Chat abrufen. Verwenden Sie JS, um die Eigenschaft MavibotAi.recipient_id zu erhalten.

{ "client_id": 36553 }

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/whatsapp\_client\_id?phone=

Diese Methode gibt die Client-ID für API-Anfragen zurück, wenn Sie die WhatsApp-Telefonnummer des Kunden kennen.
Wenn kein Kunde mit dieser Nummer existiert, gibt die Methode einen 404-Fehler zurück.

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Ändern oder Löschen von Kundeninformationen".

Pfad

api key* - access token

Body

phone - Telefonnummer\ngroup_id - Bot-ID

URL-Anfrage: https://chatter.mavibot.ai/api/\<api_key>/find_client_id_by_phone?phone=

Diese Methode gibt die Client-ID für API-Anfragen zurück.

Die Suche erfolgt sowohl unter WhatsApp-Kunden als auch über Variablen.

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Ändern oder Löschen von Kundeninformationen".

Pfad

api key* - access token

Body

phone - Telefonnummer

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_email?email=&#x20;

Diese Methode gibt die Client-ID für API-Anfragen zurück.
Die Suche erfolgt über Variablen.

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Ändern oder Löschen von Kundeninformationen".

Pfad

api key* - access token

Body

email - E-Mail für die Suche

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/find\_client\_id\_by\_var?var=\&val=

Diese Methode gibt die Client-ID für API-Anfragen zurück.

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Lesen von Kundeninformationen"

Pfad

api key* - access token

Body

var - Variablenname für die Suche\nval - Variablenwert\ngroup_id - Gruppen-ID\nsearch_in - Übergeben Sie den Wert 'order', um in Deal-Variablen zu suchen; sucht bis zu drei Variablen für Projektkunden und gibt eine Liste von Kunden zurück, die alle angegebenen Variablen besitzen.

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/find\_latest\_client\_id\_by\_var ?var=&val=

Diese Methode gibt die ID des zuletzt erstellten Kunden für API-Anfragen zurück. Sie durchsucht sowohl Kunden- als auch Deal-Variablen.

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Lesen von Kundeninformationen"

Pfad

api key* - access token

Body

var - Variablenname für die Suche\nval - Variablenwert

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/find\_all\_client\_id\_by\_var?var=\&val=

Diese Methode gibt eine Liste von Client-IDs zurück, die die angegebene Variable mit dem angegebenen Wert besitzen.

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Lesen von Kundeninformationen"

Pfad

api key* - access token

Body

var - Variablenname für die Suche\nval - Variablenwert

{
    // Antwort
}

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/find\_all\_client\_id\_by\_several\_vars?var=val

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Lesen von Kundeninformationen".

Pfad

api key* - access token

Body

variable1 - Wert1

variable2 - Wert2

variable3 - Wert3

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

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/find\_clients

Diese Methode sucht nach Variablen und gibt eine Liste von Client-IDs zurück, die den Abfragebedingungen entsprechen.

Standardmäßig wird in Kunden-Variablen gesucht (empfohlen): {"q": {"result": "ok", "var": "home", "var": "60"}} – der Kunde muss alle angegebenen Variablen besitzen

Suche in Deal-Variablen, mindestens eine der angegebenen Variablen muss vorhanden sein: {"q": {"result": "ok", "var": "home", "var": "60"}, "search_in": "order", "include_all": False}

Kunden-Variablenname entspricht einem der Listenwerte: {"q": {"name": {"_in": ["Joe", "Jane", "Donald"]}}}

Kunden-Variablenname entspricht KEINEM der Listenwerte: {"q": {"name": {"_not_in": ["Joe", "Jane", "Donald"]}}}

Kunden-Variablenname ist nicht gleich "Joe": {"q": {"name": {"_not": "Joe"}}}

Hinweis: Der Zahlenvergleich funktioniert nur, wenn alle Kunden numerische Werte in der gesuchten Variable haben. Wenn auch nur ein Kunde einen String hat, schlägt die Anfrage fehl.

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Lesen von Kundeninformationen"

Parameter

Pfad

api key* - access token

Body

q – erforderlicher Parameter, enthält die Abfragebedingungen für die Variablensuche

search_in – gibt an, in welcher Entität die Variablen gesucht werden sollen; wenn nicht angegeben, wird in Kunden-Variablen gesucht. Kann den Wert order annehmen.

include_all – ob alle Bedingungen in q erfüllt sein müssen;

False – wenn mindestens eine Bedingung zutrifft, wird die Entität ausgewählt

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

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/get\_current\_order\_id

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Lesen von CRM-Informationen".

Pfad

api key* - access token

Body

client_id - Kunden-ID

Erfolgreiche Antwort: {"status":"success","order_id":40632}, wobei
order_id - aktuelle Deal-ID
Fehlerantwort: {"status":"client_not_found"}

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/get\_orders

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Lesen von CRM-Informationen"

Pfad

api key* - access token

Body

client_id - Kunden-ID

order_status - Deal-Phase:
0 - aktive Deals
1 - erfolgreiche Deals
2 - erfolglose Deals

Erfolgreiche Antwort: {"status":"success","order_id":[40338,40340,40341]} 
Fehlerantwort: {"status":"client_not_found"}

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/move\_order\_to\_next\_state

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Ändern/Löschen von CRM-Informationen"

Pfad

api key* - access token

Body

client_id - Kunden-ID

order_id - Deal-ID

Erfolgreiche Antwort: 
{"status":"success","state_id":37}, wobei 
state_id - Phasen-ID in MavibotCRM 
Fehlerantwort: 
{"status":"client_not_found"}

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/get\_order\_vars

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Lesen von CRM-Informationen"

Pfad

api key* - access token

Body

client_id - Kunden-ID

order_id - Deal-ID

variables - Variablen-Array
(Format:["var_name1", "var_name2"])

Erfolgreiche Antwort: 
{"status":"success","result":{"var_name1":"111","var_name2":"13.04.2023"}} 

Fehlerbeispiel: 
{"status":"client_not_found"}

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/set\_order\_vars

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Ändern/Löschen von CRM-Informationen"

Pfad

api key* - access token

Body

client_id - Kunden-ID

order_id - Deal-ID

variables - Ein Wörterbuch von Variablen (der Schlüssel ist der Variablenname, und der Wert ist das, was in dieser Variable gespeichert werden soll)
(Format:{"var_name": "var_value"})

Erfolgreiche Antwort: {"status":"success"} 
Fehlerantwort: {"status":"order 12345 not found"}

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/create\_order

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Ändern/Löschen von CRM-Informationen"

Pfad

api key* - access token

Body

client_id - Kunden-ID

name - Deal-Name

description - Deal-Beschreibung

budget - Deal-Betrag

Sie müssen einen der folgenden Parameter in der Anfrage angeben: client_id, email oder phone.
Wenn mehrere Parameter angegeben werden, wird nur einer verwendet. Die Prioritätsreihenfolge ist: client_id > phone > email.
Wenn phone oder email angegeben wird und kein Kunde mit dieser Telefonnummer oder E-Mail existiert, wird ein neuer Kunde erstellt.

Erfolgreiche Antwort: {"status":"success","order_id":40654}, 
wobei order_id die ID des neuen aktiven Deals ist.
Fehlerantwort: {"status":"client_not_found"}

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/set\_order\_state

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Ändern/Löschen von CRM-Informationen“

Pfad

api key* - Zugriffstoken

Body

client_id - Kunden-ID

state_id - die Phasennummer, in die der Deal des Kunden verschoben werden soll

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/get\_order\_state

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Lesen von CRM-Informationen“

Pfad

api key* - Zugriffstoken

Body

client_id - Kunden-ID

state_id - Deal-ID (wenn nicht angegeben, gibt die Methode die Phasen-ID des aktuellen Deals zurück)

Beispiel einer erfolgreichen Antwort:
{'status': 'success', 'state_id': 123456}

Beispiel einer erfolglosen Antwort:
{'status': 'order not found'}

URL-Anfrage: https://chatter.mavibot.ai/api/#{api\_key}/check\_whatsapp

Um diese Methode zu verwenden, muss WhatsApp mit Mavibot verbunden sein.

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Kann entweder mit GET oder POST aufgerufen werden.
Die Telefonnummer kann in jedem Format angegeben werden.

Pfad

api key* - Zugriffstoken

Body

phone - zu prüfende Telefonnummer

URL-Anfrage: https://chatter.mavibot.ai/api/\<api_key>/connected_channels

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Die Funktion gibt für jeden Messenger den Parameter group_id zurück, der beim Importieren von Kunden verwendet werden muss.

Für WhatsApp wird außerdem ein status-Feld zurückgegeben, das die folgenden Werte haben kann:

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

Pfad

api key* - Zugriffstoken

{'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-Anfrage: https://chatter.mavibot.ai/api/\<api_key>/get_messages

Zugriffsberechtigung bei der Schlüsselerstellung: „Berechtigung zum Ändern oder Löschen von Kundeninformationen“.

Pfad

api key* - Zugriffstoken

Um client_id und/oder die Telefonnummer des Kunden aus verschachtelten Wörterbüchern (nicht auf der ersten Ebene) abzurufen, verwenden Sie den Parameter delimiter.

Fügen Sie Folgendes zu Ihrer Anfrage-URL hinzu:

?delimiter=1&delimiter_value_client_id={key1}1{key2}&delimiter_value_phone={key1}1{key2}

wobei:

?delimiter=1 – der Trennwert, der die Schlüssel {key1}1{key2}1{key3} trennt

delimiter_value_client_id={key1}1{key2} – zum Abrufen der Kunden-ID

delimiter_value_phone={key1}1{key2} – zum Abrufen der Telefonnummer des Kunden

{key1}, {key2}, … – Schlüssel, die die Werte enthalten (können beliebige Zeichen außer dem Trennzeichen enthalten). Sie können eine unbegrenzte Anzahl von Schlüsseln haben:
?delimiter=1&delimiter_value_client_id={key1}1{key2}1{key3}1{key4}1{key5}1{key6}.
Schlüssel werden ohne geschweifte Klammern übergeben.

Verwenden Sie das Trennzeichen zwischen den Schlüsseln. Wenn beispielsweise delimiter=2, dann {key1}2{key2}2{key3}; wenn delimiter=5, dann {key1}5{key2}5{key3}. Stellen Sie sicher, dass der Schlüssel das Trennzeichen nicht enthält.

Beispiel:

https://chatter.mavibot.a/aipi/\<api_key>/callback****?delimiter=1&delimiter_value_client_id={key1}1{key2}&delimiter_value_phone={key1}1{key2}****

Sie können auch nur die ID oder nur die Telefonnummer abrufen:

https://chatter.salebot.pro/api/\<api_key>/callback****?delimiter=1&delimiter_value_client_id={key1}1{key2} -**** nur Kunden-ID;

https://chatter.salebot.pro/api/\<api_key>/callback****?delimiter=1delimiter_value_phone={key1}1{key2}**** - nur Telefonnummer;

API-Methoden:

1. Bot starten: https://chatter.mavibotbot.ai/api/\<api_key>/callback
2. Bot per WhatsApp-Nummer starten: https://chatter.mavibotbot.ai/api/\<api_key>/whatsapp_callback
3. Bot per Telegram-ID starten: https://chatter.mavibotbot.ai/api/\<api_key>/tg_callback
4. Callback-Nachricht an E-Mail-Kunden senden: https://chatter.mavibotbot.ai/api/\<api_key>/email_callback
5. Nachricht an Kunden senden: https://chatter.mavibotbot.ai/api/\<api_key>/message
6. WhatsApp-Nachricht senden: https://chatter.mavibotbot.ai/api/\<api_key>/whatsapp_message
7. Massenversand: https://chatter.mavibotbot.ai/api/\<api_key>/broadcast
8. Variablen zuweisen: https://chatter.mavibotbot.ai/api/\<api_key>/save_variables
   \