Entwickler-API

Eine DM mit einem POST.

Eine REST-API für Ihr CRM im Business-Plan: Kontakte, Konversationen, Deals, Aufgaben, Sequenzen und Nachrichten über Telegram, X und den Social-Posteingang. Bearer-Authentifizierung, Schlüssel mit Scopes, Idempotenz, Rate-Limit-Header und ausgehende Webhooks. Kein SDK nötig.

  • JSON über HTTPS
  • Kurze Antwortzeiten
  • Auf Zuverlässigkeit gebaut

Zuletzt aktualisiert:

Wählen Sie Ihren Stack

Ein Endpunkt. Vier Sprachen.

Ein JSON-Vertrag. Kopieren, einfügen, live gehen. Die vollständige OpenAPI-Spezifikation beschreibt jeden Endpunkt, jeden Fehler und jede Webhook-Payload.

curl -X POST https://api.pinlyx.com/v1/telegram/messages \  -H "Authorization: Bearer csk_live_***" \  -H "Idempotency-Key: $(uuidgen)" \  -H "Content-Type: application/json" \  -d '{"accountId":7421,"username":"sarah_miller","text":"Willkommen an Bord"}'

Vollständige Referenz und Fehlerkatalog unter docs.pinlyx.com/api

Authentifizierung

Schlüssel mit Scopes. Minimale Rechte als Standard.

Erstellen Sie API-Schlüssel mit klar begrenzten Scopes: nur Lesen für Analyse-Dashboards, Schreiben für produktive Sender, Verwalten für die Ops-Automatisierung. Rotieren Sie ohne Ausfallzeit: Alter und neuer Schlüssel gelten während der Umstellung parallel, damit nichts bricht.

  • Bearer-Authentifizierung

    Senden Sie Authorization: Bearer csk_live_… bei jeder Anfrage mit. Live- und Testschlüssel sehen unterschiedlich aus, damit produktive Abläufe sicher bleiben.

  • Berechtigungen nach Scope

    Vergeben Sie nur die Scopes, die ein Schlüssel wirklich braucht. Ein geleakter Dashboard-Schlüssel kann niemals eine Nachricht senden.

  • Rotation ohne Ausfallzeit

    Neuen Schlüssel ausstellen, deployen, dann den alten widerrufen. Während der Überlappung gelten beide, also keine Welle von 401-Fehlern.

Produktiver SenderLive
csk_live_a4f9_
Scopes
  • contacts:readKontakte und ihre Konversationen auflisten, durchsuchen und lesen.
  • telegram:readDen Status einer eingereihten Telegram-Nachricht prüfen.
  • analytics:readFunnel-, Sequenz- und Kontostatistiken abrufen.
  • telegram:sendTelegram-Nachrichten über Ihre eigenen Konten einreihen.
  • contacts:writeKontakte anlegen, aktualisieren und taggen.
  • sequences:writeKontakte in Sequenzen aufnehmen, pausieren und fortsetzen.
  • webhooks:writeWebhook-Endpunkte registrieren und rotieren.
Zuverlässigkeit

Backpressure, die Ihnen alles verrät.

Mit Idempotenzschlüsseln sind Wiederholungen sicher: Dieselbe Nachricht geht nie zweimal raus. Rate-Limit-Header sagen Ihrem Client, wann er bremsen sollte, lange bevor ein 429 eintrifft.

Antwort · 200 OK187 ms
X-RateLimit-Limit
60
# Anfragen pro Minute und Schlüssel
X-RateLimit-Remaining
48
# verbleibend im aktuellen Zeitfenster
X-RateLimit-Reset
1778077380
# Unix-Zeit, zu der das Fenster zurückgesetzt wird
Retry-After
12
# bei 429 so viele Sekunden warten
  • Idempotenzschlüssel

    Senden Sie Idempotency-Key bei jedem Schreibzugriff mit. Eine Wiederholung mit demselben Schlüssel innerhalb von 24 Stunden liefert die ursprüngliche Antwort, statt erneut zu senden.

  • Rate-Limits pro Schlüssel

    Jeder API-Schlüssel erlaubt standardmäßig 60 Anfragen pro Minute, einzeln anpassbar. Telegram-Nachrichten laufen danach im Tempo des jeweiligen Kontos: standardmäßig 20 Nachrichten pro Stunde und 10 Sekunden Abstand, mit Backoff bei Flood-Wait.

  • Stabiler Fehlerkatalog

    Jeder Fehler liefert einen stabilen Wert in Error für Ihre Programmlogik und einen lesbaren Text in Message zum Anzeigen, an jedem Endpunkt im selben JSON-Format.

Webhooks

Ausgehende Webhooks für jedes Ereignis.

Empfangen Sie 31 CRM-Ereignisse in Echtzeit. HMAC-SHA256-Signaturen, automatische Wiederholungen mit exponentiellem Backoff und ein Zustellprotokoll, aus dem Sie jede Zustellung erneut auslösen können.

Weitere Ereignisse
  • message.sent
  • contact.created
  • pipeline.stage_changed
  • sequence.completed
  • outreach.replied
  • task.completed
  • support.ticket.created
  • subscription.changed
POSTyour-handlerzugestellt
{  "event": "message.received",  "id": "8c1f4b9e2d7a4c03b5e6f1a2",  "deliveredAt": "2026-05-06T14:32:18Z",    "channel": "telegram",    "contactId": 8821,    "counterparty": "@sarah_miller",    "text": "Hallo, können Sie mir die Demo schicken?"}
Beim Empfang prüfenNode.js
const sig = crypto.createHmac('sha256', secret).update(rawBody).digest('hex');if ('sha256=' + sig !== headers['x-webhook-signature']) return 401;

Legen Sie los, wann Sie wollen

Mit Pinlyx entwickeln. In Minuten live.

Im Business-Plan erstellen Sie im Panel einen Schlüssel, fügen einen curl-Befehl ein und sehen zu, wie die Nachricht in die Warteschlange geht. Die OpenAPI-Referenz dokumentiert jeden Endpunkt und jeden Fehler.

  • Im Business-Plan
  • Schlüssel im Panel erstellt
  • Webhooks mit HMAC-Signatur