Zum Hauptinhalt springen

ChatWerk Inbox API

ChatWerk SupportChatWerk Features

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 stehst 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

Terminbot
/core/bots

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



📨 Inbox API 🔗
Die Inbox API steuert die aktive Kommunikation, Messaging und Contacts.

Template Send-out
/inbox/channels/:channel_id/messages

Import Contacts
/inbox/channels/:channel_id/gateways/gateway_id/import-conversations