REST · Version 1.0.0

malma API

Baue eigene Integrationen und Wrapper auf deinem Workspace: Leads anlegen und anrufen lassen, Agenten konfigurieren, Gesprächsanalysen abholen — oder sie dir direkt zuschicken lassen. Basis-URL: https://app.malma.ai

Authentifizierung

Jeder Aufruf erwartet einen Workspace-Token imAuthorization-Header. Den Token findest du in der Plattform unter Integrationen → API Key.

Anfrage

cURL

curl https://app.malma.ai/api/workspace/leads \
  -H "Authorization: Bearer ws_live_xxxxxxxxxxxxxxxx"

Der Token hat vollen Zugriff auf seinen Workspace — behandle ihn wie ein Passwort und halte ihn serverseitig. Zugriff auf fremde IDs liefert 404.

Namens-Konvention

Ein Stolperstein beim Bauen eines Wrappers: die Schreibweise ist nicht überall gleich.

camelCase

Alle CRUD-Endpunkte — z. B. firstName, phoneNumber.

snake_case

Nur die Ingestion-Pipeline: create-lead und der Webhook — z. B. first_name.

Fehlercodes

400Ungültige/fehlende Felder

401Kein/ungültiger Token

402Kein aktives Abo für Anrufe (nur Bulk-Call)

403Plan-Limit erreicht (z. B. Agent-Limit)

404Ressource nicht gefunden / gehört fremdem Workspace

422Validierung fehlgeschlagen (nur create-lead)

500Serverfehler

Call-Webhook statt Polling

Statt GET /calls/{id} abzufragen, schickt malma dir den fertig analysierten Call aktiv an deine URL — direkt nach Anrufende. Konfiguriert wird das pro Agent:

Aktivierung

JSON

PATCH /api/workspace/agents/{id}
{
  "webhookForwardingEnabled": true,
  "webhookForwardingUrl": "https://example.com/malma-webhook",
  "webhookForwardingHeaders": { "X-Api-Key": "geheim" }
}

•Idempotent: genau eine Zustellung pro Call.
•Ziel-URL muss HTTPS sein, eigene Header möglich.
•Ein Zustellversuch, keine Retries — plane deinen Empfänger robust.