Developer API

euroSIP sicher integrieren

REST API v1Version 0.12.0JSON über HTTPS

Die Developer API stellt mandantenisolierte Kontakte, Warteschlangenberichte, Webhook-Verwaltung und eine sichere Call-Control-Auftragsbasis bereit. API-Clients werden im Admincenter unter Integrationen angelegt.

Einmalige Zugangsdaten: Ein API-Token wird nur beim Anlegen oder Rotieren vollständig angezeigt. Speichern Sie es direkt in einem Secretspeicher.

Sicherheitsmodell

Authentifizierung mit Authorization: Bearer …; serverseitig wird ausschließlich der SHA-256-Hash gespeichert.
Explizite Scopes: contacts:read, contacts:write, reports:read, webhooks:read, webhooks:write, calls:read und calls:control.
Als Test gekennzeichnete Clients sind technisch auf Lese-Scopes beschränkt. Schreibzugriffe erfordern einen bewusst angelegten Live-Client.
Optionale IPv4-/IPv6-CIDR-Freigaben, Ablaufdatum, sofortiger Widerruf und auditierte Nutzung.
120 Anfragen pro Minute und Client in der Standardkonfiguration.
POST, PATCH und DELETE erfordern einen 8 bis 128 Zeichen langen Idempotency-Key.

Basisadresse

https://admin.eurosip.de/api/v1

curl --fail-with-body \
  -H "Authorization: Bearer $EUROSIP_API_TOKEN" \
  "https://admin.eurosip.de/api/v1/contacts?limit=50"

Endpunkte

GET/contacts

Kontakte des authentifizierten Tenants seitenweise lesen.

POST/contacts

Einen Kontakt mit Anzeigename und optional Firma, Telefon, E-Mail oder externer ID anlegen.

GET / PATCH / DELETE/contacts/{contactId}

Einen tenantgebundenen Kontakt lesen, ändern oder soft-löschen.

GET/queue-reports

Warteschlangendaten im Umfang der gebuchten Workspace-Funktionen lesen.

GET / POST/webhooks

HTTPS-Webhook-Endpunkte lesen, anlegen oder aktualisieren.

POST/webhooks/{webhookId}/rotate

Ein neues HMAC-Signing-Secret erzeugen und einmalig zurückgeben.

DELETE/webhooks/{webhookId}

Einen tenantgebundenen Webhook samt Zustellhistorie entfernen.

GET/call-control/capabilities

Lesen, ob ein geprüfter Telefonie-Connector für den Tenant freigegeben ist und welche Aktionen der Vertrag kennt.

GET / POST/call-control/jobs

Tenantgebundene Steueraufträge lesen oder idempotent anlegen. Unterstützt werden Starten, Annehmen, Halten, Fortsetzen, Vermitteln und Auflegen.

GET / DELETE/call-control/jobs/{jobId}

Den Zustand eines Auftrags lesen oder einen noch nicht begonnenen Auftrag abbrechen.

Call-Control bleibt ohne Freigabe aus

Die API-Anbindung allein schaltet keine Telefonsteuerung ein. Ohne tenantbezogen freigegebenen Connector antwortet ein neuer Steuerauftrag mit HTTP 409 und call_control_not_configured; es wird dann kein Auftrag angelegt und kein Anruf ausgelöst. Test-Clients können nur calls:read erhalten. calls:control ist ausschließlich für bewusst angelegte Live-Clients verfügbar.

Antworten und Nachverfolgung

Erfolgreiche Antworten enthalten data, Fehler enthalten error.code und error.message. Jede Antwort liefert eine eindeutige request_id sowie den Header X-Request-ID. Rate-Limit-Antworten verwenden HTTP 429 und Retry-After.

Die maschinenlesbare vollständige Beschreibung steht als OpenAPI-3.1-Datei bereit.