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.
Brauchen Sie Hilfe? api@smsmobileapi.com
Schnellstart
Basis-URL
ERHALTEN https://api.smsmobileapi.com
Alle unten aufgeführten Endpunkte sind dokumentiert als ERHALTEN Anfragen ersetzen. IHR_API_SCHLÜSSEL mit Ihrem echten Schlüssel (geben Sie ihn nicht öffentlich weiter).
Beispiele
GET https://api.smsmobileapi.com/call/missed/list/?apikey=IHR_API-SCHLÜSSEL
GET https://api.smsmobileapi.com/call/incoming/list/?apikey=YOUR_API_KEY&limit=50&offset=0&sort_by=call_date_ms&sort_dir=desc
GET https://api.smsmobileapi.com/call/outgoing/list/?apikey=YOUR_API_KEY&q=3247&date_from_ms=1700000000000&date_to_ms=1700864000000
Authentifizierung
Anrufverwaltungs-Endpunkte authentifizieren sich mithilfe von apikey Abfrageparameter.
Abonnementvalidierung: Eingehende/ausgehende Endpunkte validieren Ihren API-Schlüssel und prüfen die Gültigkeit Ihres Abonnements (dateLimit >= CURRADE()Falls abgelaufen, erhalten Sie api_expired.
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
ERHALTEN https://api.smsmobileapi.com/call/missed/list/
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). |
Eingehende Anrufe – Liste
Eingehende, angenommene Anrufe werden vom Mobilgerät synchronisiert.
Endpunkt
ERHALTEN https://api.smsmobileapi.com/call/incoming/list/
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). |
Ausgehende Anrufe – Liste
Ausgehende Anrufe abrufen, die vom Mobilgerät synchronisiert wurden.
Endpunkt
ERHALTEN https://api.smsmobileapi.com/call/outgoing/list/
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). |
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). |
| 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. |
English 
French 
German 
Spanish 
Portuguese 
Russian 
Finnish 
Japanese 
Chinese 
Vietnamese 
Dutch 
Greek 
Arabic 
Danish 
Italian 
Ukrainian