Dokumentation der Call Management API
Über diese Endpunkte können Sie Ihre Daten abrufen Verpasste Anrufe, Eingehende Anrufe (angenommen), Und Ausgehende Anrufe Synchronisiert von der SMSMobileAPI-Mobil-App in Ihr Dashboard + API.
Wichtig: Wenn die mobile App im Hintergrund läuft, kann das Telefonsystem die Synchronisierung verzögern (oft bis zu ca. 10 Minuten). Sie können die App bei Bedarf jederzeit öffnen und manuell synchronisieren.
Schnellstart
Basis-URL
Beispiele
Authentifizierung
Anrufverwaltungs-Endpunkte authentifizieren sich mithilfe von apikey Abfrageparameter.
Gemeinsame Konzepte
Pagination
Verwenden Limit Und Versatz Ergebnisse paginieren.
Zeitstempel
- Anrufdatum_ms ist ein UNIX-Zeitstempel in Millisekunden.
- Anrufdatum/Uhrzeit (UTC) wird als UTC-Datums-/Zeitzeichenfolge (Datenbankfeld) gespeichert.
- Bei verpassten Anrufen gibt die API ein formatiertes Ergebnis zurück. Datum Zeichenkette (abgeleitet von einem Millisekundenwert).
Suchen
- Verpasste Anrufe: suchen Entspricht Nummer oder Name.
- Eingehend/Ausgehend: Q Spiele Telefonnummer oder zwischengespeicherter Name.
Sortierung (nur eingehende/ausgehende E-Mails)
Die Sortierung wird gesteuert durch sort_by + sort_dir (Nur Felder auf der Whitelist). Verpasste Anrufe werden immer nach dem neuesten Datum zuerst sortiert.
Fehler
| HTTP | Beispielfehler | Bedeutung |
|---|---|---|
| 400 | {"success":false,"error":"missing_apikey"} | Fehlend oder leer apikey. |
| 403 | {"success":false,"error":"invalid_apikey"} | API-Schlüssel nicht gefunden / nicht erkannt. |
| 403 | {"success":false,"error":"api_expired"} | Ihr Abonnement ist abgelaufen (Datumslimit (ist vor heute). |
| 500 | {"success":false,"error":"server_error","detail":"..."} | Serverfehler (Datenbank, SQL, Ausnahme). |
Hinweis: Der Endpunkt „Verpasste Anrufe“ kann auch Meldungen wie die folgenden zurückgeben: Fehlender API-Schlüssel oder SQL-Vorbereitungsfehler, je nach Situation.
Verpasste Anrufe – Liste
Verpasste Anrufe vom Mobilgerät abrufen.
Endpunkt
Abfrageparameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| apikey | Zeichenkette | Erforderlich Ihr API-Schlüssel ist mit dem Mobiltelefon verknüpft. |
| Versatz | int | Optional Seitenumbruch (Standardwert: 0). |
| Limit | int | Optional Maximale Zeilenanzahl (Standardwert: 100, max: 500). |
| suchen | Zeichenkette | Optional Suche nach Nummer oder Name (SQL LIKE). |
| Startdatum | JJJJ-MM-TT | Optional Filter ab diesem Tag (00:00:00). |
| Datum_Ende | JJJJ-MM-TT | Optional Filter bis heute (23:59:59). |
Beispielanfrage
Beispiel einer JSON-Antwort
{ "success": true, "offset": 0, "limit": 100, "count": 3, "data": [ { "number": "+15551230001", "name": "", "date": "2026-03-20 16:12:28" }, { "number": "+15551230002", "name": "Alex Carter", "date": "2026-03-20 16:12:00" }, { "number": "+447700900123", "name": "Taylor Reed", "date": "2026-03-20 15:48:41" } ] }
Antworterklärung
| Feld | Beschreibung |
|---|---|
| Erfolg | WAHR bedeutet, dass die Anfrage erfolgreich bearbeitet wurde. |
| Versatz | Vom API zurückgegebener Paginierungs-Offset. |
| Limit | Für die Anfrage wurde ein Seitenbegrenzungslimit angewendet. |
| zählen | Anzahl der zurückgegebenen Zeilen in Daten. |
| Daten | Array mit Einträgen verpasster Anrufe. |
| Daten[].Zahl | Telefonnummer des Anrufers. |
| data[].name | Zwischengespeicherter Kontaktname. Kann leer sein, wenn kein Kontaktname verfügbar ist. |
| Daten[].Datum | Formatiertes Anrufdatum und -uhrzeit. |
Eingehende Anrufe – Liste
Eingehende, angenommene Anrufe werden vom Mobilgerät synchronisiert.
Endpunkt
Abfrageparameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| apikey | Zeichenkette | Erforderlich Ihr API-Schlüssel (gegenüber dem Abonnement validiert). |
| Limit | int | Optional Zeilen pro Seite (Standard: 50, max: 200). |
| Versatz | int | Optional Seitenumbruch (Standardwert: 0). |
| sort_by | Zeichenkette | Optional Erlaubt: Anrufdatum_ms Anrufdatum/Uhrzeit (UTC) Dauer_Sekunden Telefonnummer erstellt am zwischengespeicherter Name Geolokalisierung |
| sort_dir | aufsteigend|absteigend | Optional Standard: Beschreibung. |
| Datum_von_Millisekunden | int (ms) | Optional Filter, wo call_date_ms >= date_from_ms. |
| Datum in Millisekunden | int (ms) | Optional Filter, wo call_date_ms <= date_to_ms. |
| Q | Zeichenkette | Optional Suche auf Telefonnummer oder zwischengespeicherter Name (WIE). |
Beispielanfrage
Beispiel einer JSON-Antwort
{ "success": true, "apikey": "YOUR_API_KEY_HASH", "limit": 50, "offset": 0, "sort_by": "call_date_ms", "sort_dir": "desc", "filters": { "date_from_ms": null, "date_to_ms": null, "q": null }, "count": 3, "rows": [ { "phone_number": "+15551230010", "cached_name": "Jordan Blake", "call_date_ms": 1774027779390, "call_datetime_utc": "2026-03-20 17:29:39", "duration_sec": 23, "geo_location": "Canada", "created_at": "2026-03-20 17:46:45" }, { "phone_number": "+15551230011", "cached_name": "Morgan Lee", "call_date_ms": 1774018268663, "call_datetime_utc": "2026-03-20 14:51:08", "duration_sec": 50, "geo_location": "Canada", "created_at": "2026-03-20 14:58:37" }, { "phone_number": "+447700900124", "cached_name": "Sam Parker", "call_date_ms": 1774011205123, "call_datetime_utc": "2026-03-20 12:53:25", "duration_sec": 92, "geo_location": "Canada", "created_at": "2026-03-20 12:59:01" } ] }
Antworterklärung
| Feld | Beschreibung |
|---|---|
| Erfolg | WAHR bedeutet, dass die Anfrage erfolgreich bearbeitet wurde. |
| apikey | Der zurückgegebene API-Schlüsselwert sollte in Dokumentationsbeispielen immer maskiert werden. |
| Limit | Anzahl der angeforderten Zeilen pro Seite. |
| Versatz | Vom API zurückgegebener Paginierungs-Offset. |
| sort_by | Sortierfeld, das von der API angewendet wird. |
| sort_dir | Die von der API angewendete Sortierrichtung. |
| Filter | Objekt, das die für die Anfrage verwendeten aktiven Filter enthält. |
| zählen | Anzahl der zurückgegebenen Zeilen in Zeilen. |
| Zeilen | Array mit Einträgen für eingehende, beantwortete Anrufe. |
| rows[].phone_number | Mit dem Anruf verknüpfte Telefonnummer. |
| rows[].cached_name | Zwischengespeicherter Kontaktname. Kann je nach verfügbaren Daten null oder leer sein. |
| rows[].call_date_ms | Zeitstempel des Aufrufs in Millisekunden. |
| rows[].call_datetime_utc | Datum und Uhrzeit des Anrufs in UTC. |
| rows[].duration_sec | Anrufdauer in Sekunden. |
| rows[].geo_location | Geografische Bezeichnung der Nummer, sofern verfügbar. |
| rows[].created_at | Datum und Uhrzeit, zu der die Zeile auf dem Server eingefügt wurde. |
Ausgehende Anrufe – Liste
Ausgehende Anrufe abrufen, die vom Mobilgerät synchronisiert wurden.
Endpunkt
Abfrageparameter
Gleiche Parameter und gleiches Verhalten wie bei eingehenden Anrufen.
| Parameter | Typ | Beschreibung |
|---|---|---|
| apikey | Zeichenkette | Erforderlich Ihr API-Schlüssel (gegenüber dem Abonnement validiert). |
| Limit | int | Optional Zeilen pro Seite (Standard: 50, max: 200). |
| Versatz | int | Optional Seitenumbruch (Standardwert: 0). |
| sort_by | Zeichenkette | Optional Erlaubt: Anrufdatum_ms Anrufdatum/Uhrzeit (UTC) Dauer_Sekunden Telefonnummer erstellt am zwischengespeicherter Name Geolokalisierung |
| sort_dir | aufsteigend|absteigend | Optional Standard: Beschreibung. |
| Datum_von_Millisekunden | int (ms) | Optional Filter, wo call_date_ms >= date_from_ms. |
| Datum in Millisekunden | int (ms) | Optional Filter, wo call_date_ms <= date_to_ms. |
| Q | Zeichenkette | Optional Suche auf Telefonnummer oder zwischengespeicherter Name (WIE). |
Beispielanfrage
Beispiel einer JSON-Antwort
{ "success": true, "apikey": "YOUR_API_KEY_HASH", "limit": 50, "offset": 0, "sort_by": "call_date_ms", "sort_dir": "desc", "filters": { "date_from_ms": null, "date_to_ms": null, "q": null }, "count": 3, "rows": [ { "phone_number": "+15551230020", "cached_name": "Casey Morgan", "call_date_ms": 1774025965645, "call_datetime_utc": "2026-03-20 16:59:25", "duration_sec": 15, "geo_location": "Canada", "created_at": "2026-03-20 17:17:58" }, { "phone_number": "+15551230021", "cached_name": "Taylor Brooks", "call_date_ms": 1774023172638, "call_datetime_utc": "2026-03-20 16:12:52", "duration_sec": 556, "geo_location": "Canada", "created_at": "2026-03-20 16:28:38" }, { "phone_number": "+33198765432", "cached_name": "Jamie Carter", "call_date_ms": 1774019040000, "call_datetime_utc": "2026-03-20 15:04:00", "duration_sec": 61, "geo_location": "Canada", "created_at": "2026-03-20 15:09:11" } ] }
Antworterklärung
| Feld | Beschreibung |
|---|---|
| Erfolg | WAHR bedeutet, dass die Anfrage erfolgreich bearbeitet wurde. |
| apikey | Der zurückgegebene API-Schlüsselwert sollte in Dokumentationsbeispielen immer maskiert werden. |
| Limit | Anzahl der angeforderten Zeilen pro Seite. |
| Versatz | Vom API zurückgegebener Paginierungs-Offset. |
| sort_by | Sortierfeld, das von der API angewendet wird. |
| sort_dir | Die von der API angewendete Sortierrichtung. |
| Filter | Objekt, das die für die Anfrage verwendeten aktiven Filter enthält. |
| zählen | Anzahl der zurückgegebenen Zeilen in Zeilen. |
| Zeilen | Array mit Einträgen für ausgehende Anrufe. |
| rows[].phone_number | Mit dem Anruf verknüpfte Telefonnummer. |
| rows[].cached_name | Zwischengespeicherter Kontaktname. Kann je nach verfügbaren Daten null oder leer sein. |
| rows[].call_date_ms | Zeitstempel des Aufrufs in Millisekunden. |
| rows[].call_datetime_utc | Datum und Uhrzeit des Anrufs in UTC. |
| rows[].duration_sec | Anrufdauer in Sekunden. |
| rows[].geo_location | Geografische Bezeichnung der Nummer, sofern verfügbar. |
| rows[].created_at | Datum und Uhrzeit, zu der die Zeile auf dem Server eingefügt wurde. |
Felder für verpasste Anrufe
| Feld | Typ | Beschreibung |
|---|---|---|
| Erfolg | bool | Anfragestatus. |
| Versatz | int | Seitenumbruch zurückgegeben. |
| Limit | int | Seitenbegrenzung zurückgegeben. |
| zählen | int | Anzahl der zurückgegebenen Zeilen in Daten. |
| Daten | Array | Liste der verpassten Anrufe. |
| Daten[].Zahl | Zeichenkette | Telefonnummer des Anrufers. |
| data[].name | Zeichenkette | Zwischengespeicherter Kontaktname (kann leer sein). |
| Daten[].Datum | Zeichenkette | Formatierte Datums-/Zeitzeichenfolge, abgeleitet aus einem Millisekunden-Zeitstempel. |
Eingehende/Ausgehende Felder
| Feld | Typ | Beschreibung |
|---|---|---|
| Erfolg | bool | Anfragestatus. |
| apikey | Zeichenkette | Wird von der API zurückgesendet (Ihr Schlüssel). In öffentlichen Dokumenten muss dieser immer maskiert werden. |
| Limit | int | Anzahl der zurückgegebenen Zeilen pro Seite. |
| Versatz | int | Seitenumbruch zurückgegeben. |
| sort_by | Zeichenkette | Sortierfeld angewendet. |
| sort_dir | Zeichenkette | Sortierrichtung angewendet. |
| Filter | Objekt | Echoed filters (Datum_von_Millisekunden, Datum in Millisekunden, Q). |
| zählen | int | Anzahl der zurückgegebenen Zeilen in Zeilen. |
| Zeilen | Array | Anrufliste. |
| rows[].phone_number | Zeichenkette | Telefonnummer. |
| rows[].cached_name | Zeichenkette|null | Zwischengespeicherter Kontaktname (kann null sein). |
| rows[].call_date_ms | int | Zeitstempel des Aufrufs in Millisekunden. |
| rows[].call_datetime_utc | Zeichenkette | UTC-Datums-/Zeitfeld (Datenbank). |
| rows[].duration_sec | int | Dauer in Sekunden. |
| rows[].geo_location | Zeichenkette|null | Geografische Standortbezeichnung (kann null/leer sein). |
| rows[].created_at | Zeichenkette | Zeitstempel der Servereinfügung. |
