ChatWerk Inbox API
API Dokumentation Link 🔗
Mit der Inbox API kannst du, über eine Programmierschnittstelle, auf alle Funktionen zugreifen, die ChatWerk dir in der Inbox anbietet. Sie teilt sich auf in Core und Inbox API, die jeweils unten beschrieben sind. Die Unified API ist für dich als Inbox Kunde uninteressant, da sie ausschließlich für eine Messaging-Nutzung ohne Inbox geeignet ist.
🧠 Getting started:
Um mit der API zu arbeiten, brauchst du stets deine Organization ID und deine Channel ID, diese findest du in deiner URL-Leiste
Beispiel:
https://inbox.chatwerk.de/settings/organization/{organization_id}/channel/{channel_id}
Zusätzlich benötigst du z.B. für die Templates und Campaigns die Gateway ID's, jeder Messenger ist ein Gateway und hat somit seine eigene ID, diese kannst du über den Gateway Call erhalten.
Beispiel Call:
https://api.chatwerk.de/core/gateways?channel_id0{channel_id}
✍️ Authentifizierung Call: https://api.chatwerk.de/core/auth/login
Für die Authentifizierung verwendest du deine ChatWerk-Logindaten, damit hast du die gleichen Zugriffsrechte, wie in der Inbox.
Du erhältst als Antwort einen Bearer-Token, den du unter Authorization, hinterlegst und somit bei jedem zukünftigen Call mitschickst.
_______________________________
Beispielhafte Auswahl von API-Calls die häufig von Kunden im API-Self-Service verwendet werden:
💎 Core API 🔗
Mit der Core API steuerst du alle Themen rund um dein Basis-Setup.
Campaigns/Chatbots
/core/channels/:channel_id/campaigns
Für das Set-up von Chatbots: "type": "bot_workflow"
Für das Set-up von Campaigns:
Push-Newsletter: "type": "proactive"
Keywordcampaign: "type": "reactive"
Botmanager
/core/channel
Da den ganzen channel holen und den bot manager teil aktualisiert und channel updaten
Webhooks
1. Dieser Webhook verarbeitet die Nachrichten und ihren Status: /core/channels/:channel_id/webhooks
2. Dieser Webhook verwaltet die Templates:
/core/organizations/:organisations_id/webhooks
Template Set-up
/core/templates
Erstelle über diesen Call Templates, die unser System automatisch bei WhatsApp einreicht. Die Bestätigung durch WhatsApp dauert meist 5-50 Minuten. Nur bestätigte Templates können für Campaigns und Template Send-out genutzt werden. Für Buchungsbestätigungen nutze Templates mit Parametern, die du flexibel ausfüllen kannst, um sie wiederzuverwenden.
📨 Inbox API 🔗
Die Inbox API steuert die aktive Kommunikation, Messaging und Contacts.
Template Send-out
/inbox/channels/:channel_id/messages/templates
Import Contacts
/inbox/channels/:channel_id/gateways/gateway_id/import-conversations
Mit diesem Call kannst du Kontakte hochladen, für die du bereits ein Opt-in zur Kommunikation hast. Beim Upload werden keine Benachrichtigungen versendet. Die Kommunikation startet erst mit deiner ersten Nachricht oder Kampagne. Dieser Call funktioniert für alle Messenger-Plattformen.
Mehr hier ->
Import Contacts
/inbox/channels/:channel_id/import-contacts/whatsapp
Kontakte in deiner Inbox erhalten automatisch ein Opt-in-Template. Mit der Bestätigung stimmen sie der WhatsApp-Kommunikation zu. Ideal für Kontakte ohne bisherige Zustimmung. Gilt nur für WhatsApp.
Mehr hier ->
Hinweis: Das Template "whatsapp_opt_in" ist in jeder Inbox standardmäßig verfügbar, kann jedoch via API (/core/templates) oder Support ersetzt werden. Beachte die Payload des Buttons.