REST-API Dokumentation – SMS API Reference

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

Saubere JSON-Antworten, Standard-HTTP-Methoden, aussagekräftige Statuscodes.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	`/api/v1/teamlist/credit/`	SMS-Kontingent und Verbrauch abrufen
GET	`/api/v1/teamlist/info/`	Get team name and information
GET	`/api/v1/teamlist/key/`	Team-Keyword abrufen
GET	`/api/v1/teamlist/lists/`	Alle Teamlisten abrufen
GET	`/api/v1/teamlist/members/`	Alle Mitglieder einer Teamliste abrufen
GET	`/api/v1/teamlist/member/`	Einzelnes Mitglied abrufen
POST	`/api/v1/teamlist/member/`	Mitglied erstellen
PUT	`/api/v1/teamlist/member/`	Mitglied aktualisieren
DELETE	`/api/v1/teamlist/member/`	Mitglied löschen
GET	`/api/v1/teamlist/sendkeys/`	Sendeberechtigungs-Keywords abrufen
PUT	`/api/v1/teamlist/sendkeys/`	Sendeberechtigungs-Keywords setzen

Zustellprotokolle `/api/v1/logging/`

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

Nachrichten-Widget `/api/v1/widget/`

Methode	Endpunkt	Beschreibung
GET	`/api/v1/widget/messages/`	Teamnachrichten als JSON abrufen
GET	`/api/v1/widget/embed.html`	HTML-Widget zum Einbetten abrufen

Widget-Dokumentation →

SMS-Versand-Parameter

Parameter für POST /api/v1/sms/send/

Parameter	Erforderlich	Beschreibung
`team_id`	Ja	Team-ID / Kundennummer
`teamlist_email`	Ja*	Teamlisten-Adresse (z.B. 'meinteam@tmsg.de')
`tl`	Ja*	Teamlisten-ID (Alternative zu teamlist_email)
`message`	Ja	Nachrichtentext (max. 1600 Zeichen)
`to_mobile`	Ja	Empfänger-Telefonnummer(n), kommagetrennt
`sender_email`	Geschlossene Gruppen	Absender-E-Mail zur Authentifizierung. Pflicht bei geschlossenen Gruppen – muss mit der E-Mail eines registrierten Mitglieds übereinstimmen.
`keyword`	Wenn konfiguriert	Authentifizierungs-Keyword. Pflicht, wenn ein Sende-Keyword für die Teamliste konfiguriert ist – auch bei Verwendung von Bearer-Token-Authentifizierung.
`from_mobile`	Nein	SMS-Absenderkennung überschreiben (alphanumerisch oder Telefonnummer)
`test`	Nein	Testmodus (1 = nur Validierung, kein tatsächlicher Versand)
`date`	Nein	Geplantes Sendedatum (JJJJ-MM-TT)
`time`	Nein	Geplante Sendezeit (HH:MM)
`flash`	Nein	Flash-SMS (1 = wird direkt auf dem Display angezeigt, nicht gespeichert)
`ucs2`	Nein	UCS2-Kodierung (1 = Unicode-Unterstützung für Sonderzeichen)

* Entweder teamlist_email oder tl muss angegeben werden. Wenn beide angegeben sind, hat tl Vorrang.

Authentifizierung

Bearer-Token-Authentifizierung

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

API-Tokens verwalten

Hinweis: Diese Dokumentation behandelt die moderne REST-API. Falls Siebestehende Integrationen mit der Legacy-HTTP-Schnittstelle haben,funktionieren diese weiterhin. Siehe

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",
    "sender_email": "john@example.com"
  }'

SMS-Guthaben prüfen

curl "https://www.teammessage.de/api/v1/teamlist/credit/?tm=12345&tl=67890" \
  -H "Authorization: Bearer YOUR_TOKEN"

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",
        "sender_email": "john@example.com"
    }
)
print(response.json())

Bereit zur Integration?

Erkunden Sie alle Endpunkte interaktiv mit unserer Swagger-Dokumentation.

API-Dokumentation öffnen

REST-API