REST-API Dokumentation - teammessage.de

Interaktive API-Dokumentation

Unsere REST-API verfügt über integrierte Swagger-UI-Dokumentation. Testen Sie API-Aufrufe direkt im Browser, erkunden Sie alle Endpunkte und generieren Sie Code-Schnipsel.

Swagger UI öffnen OpenAPI-Schema (JSON)

API-Funktionen

Modernes REST-Design

Klare JSON-Antworten, Standard-HTTP-Methoden, aussagekräftige Statuscodes.

Bearer-Token-Auth

Sichere Authentifizierung mit API-Tokens. Keine Passwörter in URLs.

OpenAPI 3.0

Automatisch generiertes Schema für Code-Generierung und IDE-Integration.

Legacy-kompatibel

Bestehende Integrationen funktionieren weiterhin über PHP-Proxies.

Verfügbare Endpunkte

SMS-Versand `/api/v1/sms/`

Methode	Endpunkt	Beschreibung
GET	`/api/v1/sms/send/`	SMS per HTTP GET senden (legacy-kompatibel)
POST	`/api/v1/sms/send/`	SMS per HTTP POST senden (empfohlen)

Team-Verwaltung `/api/v1/teamlist/`

Methode	Endpunkt	Beschreibung
GET	`/credit/`	SMS-Kontingent und Verbrauch abrufen
GET	`/lists/`	Alle Teamlisten abrufen
GET	`/members/`	Teammitglieder abrufen
POST	`/member/`	Mitglied erstellen
PUT	`/member/`	Mitglied aktualisieren
DELETE	`/member/`	Mitglied löschen

Zustellprotokolle `/api/v1/logging/`

Methode	Endpunkt	Beschreibung
GET	`/sms/`	SMS-Zustellprotokoll mit Paginierung abrufen
GET	`/statuscodes/`	Alle Zustellstatus-Codes auflisten
GET	`/reasoncodes/`	Alle Reason-Codes auflisten

Authentifizierung

Bearer Token Authentication

Erstellen Sie einen API-Token in Ihren Kontoeinstellungen und fügen Sie ihn in den Authorization-Header ein:

Authorization: Bearer your-api-token-here

Sicher, einfach zu rotieren, keine Passwörter in Logs

Manage API Tokens

Hinweis: This documentation covers the modern REST API. If you have existing integrations using the legacy HTTP interface, they will continue to work unchanged.

Schnelle Beispiele

SMS mit cURL senden

curl -X POST "https://www.teammessage.de/api/v1/sms/send/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "team_id": 12345,
    "teamlist_email": "myteam@tmsg.de",
    "message": "Hello World!",
    "to_mobile": "+4917612345678"
  }'

SMS-Guthaben prüfen

curl "https://www.teammessage.de/api/v1/teamlist/credit/" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d "team_id=12345&list_id=67890"

Python-Beispiel

import requests

response = requests.post(
    "https://www.teammessage.de/api/v1/sms/send/",
    headers={"Authorization": "Bearer YOUR_TOKEN"},
    json={
        "team_id": 12345,
        "teamlist_email": "myteam@tmsg.de",
        "message": "Hello from Python!",
        "to_mobile": "+4917612345678"
    }
)
print(response.json())

Bereit zur Integration?

Erkunden Sie alle Endpunkte interaktiv mit unserer Swagger-Dokumentation.

API-Dokumentation öffnen

REST-API