SMS-Dokumentation

SMS senden

Endpunkt: 

Parameter:

Beispielanfrage:

Beispiel einer JSON-Antwort:

{ "result": { "error": 0, "sent": "1", "id": "c319d3b35e8f8712cde20dae39ac3c19f86eda25", "note": "gesendet per Mobiltelefon", "datetime": "2026-03-20T21:07:44Z", "datetimeLocal": "2026-03-20T22:07:44+01:00", "port": null, "iac_control": "1", "iac_authorized": "1", "send_with_whatsapp": "0", "encrypted": { "status": "0" }, "trial_account": { "status": "0", "sms_sent": 0 } } }

Erläuterung der Antwort:

Eine nicht gesendete SMS erneut senden

Dieser Endpunkt ermöglicht das erneute Senden einer zuvor nicht gesendeten SMS nur dann, wenn sich die Nachricht aktuell in einem Fehlerstatus befindet.

Endpunkt:

Parameter: 

Beispielanfrage: 

Beispiel einer JSON-Antwort:

{ "result": { "error": "0", "sms": "erneut erfolgreich gesendet", "attempt": 1 } }

Erläuterung der Antwort:

Protokoll der von der API gesendeten SMS

Über diesen Endpunkt können Sie das Protokoll der über die API gesendeten SMS-Nachrichten abrufen.

Endpunkt: 

Parameter:

Beispielanfrage:

Beispiel einer JSON-Antwort:

{ "result": { "error": "0", "sms": [ { "sIdentifiantPhone": "abbg00055x5", "port": 0, "date_add": "2026-03-20", "hour_add": "22:07:44", "timestamp": 1774044464, "send_from_mobile": 1, "send_from_mobile_date": "2026-03-20", "send_from_mobile_heure": "22:10:05", "send_from_mobile_timestamp": 1774044605, "recipients": "32495898697", "sms": "test", "error_api": "", "send_from_mobile_erreur": "", "guid_message": "c319d3b35e8f8712cde20dae39ac3c19f86eda25", "timearea": "UTC+01", "date_add_server": "2026-03-20", "hour_add_server": "21:07:44", "timestamp_server": 1774040864, "send_from_mobile_date_server": "2026-03-20", "send_from_mobile_heure_server": "21:10:05" } ] } }

Erläuterung der Antwort:

Liste der vom Mobiltelefon gesendeten SMS

Dieser Endpunkt ermöglicht es Ihnen, SMS-Nachrichten aufzulisten, die von Ihrem Mobilgerät gesendet und mit Ihrem SMSMobileAPI-Konto synchronisiert wurden.

Wichtig: Diese Funktion ist ab Android-Version verfügbar. 4.1.20.

Wichtig: Diese Funktion ist Standardmäßig nicht aktiviert in der Android-App.

Datenschutz: Alle synchronisierten Informationen werden anonymisiert, vertraulich behandelt und sicher verarbeitet.

Verlaufslimit: Diese API gibt nur Daten vom letzten 7 Tage.

Notiz: Wenn Sie SMS über den Standard-API-Endpunkt senden https://api.smsmobileapi.com/sendsms/Diese SMS können auch in dieser Liste erscheinen, da sie physisch von Ihrem Mobilgerät gesendet werden.

Endpunkt:

Parameter: 

Zurückgegebene Felder: 

Beispielanfrage: 

Beispiel mit Filtern:

Beispiel mit vordefiniertem Zeitraum:

Beispiel einer JSON-Antwort:

{ "result": { "error": "0", "count": 200, "limit": 200, "history_limit_days": 7, "sort_by": "mobile_date_ms", "sort_order": "DESC", "sms": [ { "sIdentifiant": "508b004b4aadacc4", "number": "+15551234567", "message": "Hallo, Ihr Termin wurde bestätigt.", "mobile_date_ms": 1774041004692, "mobile_date_formatted": "2026-03-20 22:10:04", "synchro_time": "2026-03-20 21:10:05" }, { "sIdentifiant": "e5b70a8a28b2ec3d", "number": "+447700900123", "message": "Ihr Bestätigungscode lautet 482915.", "mobile_date_ms": 1774040902284, "mobile_date_formatted": "2026-03-20 22:08:22", "synchro_time": "2026-03-20 21:08:35" }, { "sIdentifiant": "e5b70a8a28b2ec3d", "number": "+33198765432", "message": "Vielen Dank für Ihre Bestellung. Sie wird derzeit bearbeitet.", "mobile_date_ms": 1774026491230, "mobile_date_formatted": "2026-03-20 18:08:11", "synchro_time": "2026-03-20 17:19:19" } ] } }

Erläuterung der Antwort:

Empfangene SMS

Dieser Endpunkt ermöglicht es Ihnen, auf dem Smartphone empfangene SMS-Nachrichten abzurufen. 

Endpunkt:

Parameter: 

Beispielanfrage:

Beispiel einer JSON-Antwort:

{ "result": { "error": "", "sms": [ { "id": 466340, "sIdentifiantPhone": "e5b70a8a28b2ec3d", "date": "2026-03-20", "hour": "21:23:34", "timestamp_unix": 1774041814, "time_received": "20260320222332804", "indice": "27593", "message": "Hallo, Ihr Paket wurde zugestellt.", "number": "+15551234567", "guid": "6BFD7DC7-3492-422D-8D02-4AF4E614F122", "alias": null, "apikey": "YOUR_API_KEY_HASH" }, { "id": 466341, "sIdentifiantPhone": "e5b70a8a28b2ec3d", "date": "2026-03-20", "hour": "21:23:34", "timestamp_unix": 1774041814, "time_received": "20260320221005892", "indice": "27591", "message": "Ihr Termin ist für morgen bestätigt.", "number": "+447700900123", "guid": "BF3B38D7-8401-4A8C-8BA6-D8D58ACBB23E", "alias": null, "apikey": "IHR_API_SCHLÜSSEL_HASH" }, { "id": 466324, "sIdentifiantPhone": "e5b70a8a28b2ec3d", "date": "2026-03-20", "hour": "21:08:24", "timestamp_unix": 1774040904, "time_received": "20260320220822763", "indexe": "27590", "message": "Bitte rufen Sie uns zurück, sobald Sie verfügbar sind.", "number": "+33198765432", "guid": "08C88E20-9B98-453F-B361-9BB06D3275D6", "alias": null, "apikey": "IHR_API_SCHLÜSSEL_HASH" }, { "id": 466156, "sIdentifiantPhone": "e5b70a8a28b2ec3d", "date": "2026-03-20", "hour": "19:05:22", "timestamp_unix": 1774033522, "time_received": "20260320200026246", "indice": "27588", "message": "Erinnerung: Ihre Kontoüberprüfung steht noch aus.", "number": "10001", "guid": "551B2CF4-9330-4DD2-B2BA-5A4026EEEB15", "alias": null, "apikey": "IHR_API_SCHLÜSSEL_HASH" } ] } }

Erläuterung der Antwort:

Empfangene SMS-Nachrichten als gelesen markieren

Dieser API-Endpunkt dient dazu, eine empfangene SMS als gelesen zu markieren. Nur API-Status.
Dies ändert nichts am Lesestatus des Smartphones.  

Endpunkt:

Parameter: 

Beispiel:

SMS-Alias aktualisieren

Dieser API-Endpunkt dient dazu, den Alias einer empfangenen SMS anhand ihrer GUID zu aktualisieren.

Notiz: Der alias Der Parameter kann leer sein. In diesem Fall wird der Alias gelöscht.

Endpunkt:

Parameter: 

Beispiel: 

Beispiel zum Löschen des Alias:

SMS löschen

Dieser Endpunkt ermöglicht es Ihnen, SMS-Nachrichten aus dem Serverprotokoll der SMSMobileAPI zu löschen.

Endpunkt: 

Parameter:

Beispielanfrage:

Beispiel einer JSON-Antwort:

{ "result": { "error": null, "count_delete": 1 } }

Erläuterung der Antwort:

Hinweis: Nur SMS, die in den Serverprotokollen der SMSMobileAPI gespeichert sind, werden gelöscht. Bereits auf dem Mobilgerät gespeicherte SMS werden nicht gelöscht.

SMS-Konversationen auflisten

Dieser API-Endpunkt dient dazu, SMS-Konversationen aufzulisten, die mit Ihrem Konto verknüpft sind.

Jede Konversation ist nach Telefonnummer gruppiert und enthält die zugehörigen eingehenden und ausgehenden SMS-Nachrichten.

Notiz: Der Ausgangspunkt des Gesprächs wird definiert durch origineConversation Parameter:

• received: Konversationen werden zuerst anhand empfangener SMS erkannt in logsmsreceive
• sent: Konversationen werden zuerst anhand der gesendeten SMS erkannt in logsmssent

Notiz: Wenn numero Wird kein Wert angegeben, gibt die API nur die letzten Konversationen zurück. Standardmäßig werden die letzten Konversationen zurückgegeben. 20 Die Gespräche werden erwidert.

Notiz: Für ausgehende SMS, wenn timearea_of_message ist verfügbar (Beispiel: UTC+02Das angezeigte Datum wird automatisch anhand dieses Werts umgerechnet. Dieses umgerechnete Datum wird auch zum Sortieren verwendet.

Notiz: Wenn resume=1Es werden nur die neuesten Nachrichten jedes Gesprächs angezeigt. resume_line_how um festzulegen, wie viele der neuesten Nachrichten einbezogen werden sollen.

Endpunkt:

Parameter: 

Verhaltensdetails: 

Beispiel 1 – Liste der letzten Konversationen aus empfangenen SMS: 

Beispiel 2 – Liste der letzten Konversationen aus gesendeten SMS:

Beispiel 3 – Filtern einer bestimmten Telefonnummer:

Beispiel 4 – Filtern nach Datumsbereich:

Beispiel 5 – Fortsetzungsmodus mit den letzten 3 Nachrichten pro Konversation:

Beispiel für eine erfolgreiche Antwort: 

{ "success": true, "origineConversation": "received", "resume": 0, "resume_line_how": null, "conversations": [ { "phone_number": "+10470000001", "contact_alias": "John Doe", "messages": [ { "direction": "incoming", "message_id": "msg_1001", "date": "2026-03-13 08:45:12", "timestamp_utc": "2026-03-13T08:45:12Z", "message": "Hallo, ich hätte gerne weitere Informationen.", "status": "received", "mobile_sid": "device_sid_1" }, { "direction": "outgoing", "message_id": "msg_1002", "date": "2026-03-13 10:46:03", "timestamp_utc": "2026-03-13T08:46:03Z", "message": "Natürlich, was möchten Sie wissen?", "status": "gesendet", "mobile_sid": "device_sid_2" } ] } ] }

Antwortfelder:

Fehlerbeispiel:

{ "success": false, "error": "Fehlender erforderlicher Parameter: apikey" }

Anmerkungen:

Gateway – Liste der verbundenen Mobilgeräte

Liste der mit Ihrem Gerät verbundenen Mobilgeräte auf SMS-Gateway.

Endpunkt:

Parameter:

Beispiel:

Gateway – Aktualisieren eines mobilen Labels

Aktualisiere die Bezeichnung (nom_reference) eines verbundenen Mobilgeräts.

Endpunkt:

Parameter:

Beispiel:

Wichtig: Ein Etikett ist erforderlich, kann aber leer sein. (label=).

Gateway – Ein verbundenes Mobilgerät löschen

Entfernen Sie ein verbundenes Mobilgerät von Ihrem Gateway (löscht alle Verlaufszeilen für diese SID).

Endpunkt:

Parameter:

Beispiel:

Webhook – SMS empfangen

Dieses Webhook-System sendet bei jedem SMS-Empfang eine POST-Anfrage an die konfigurierte URL. Das System stellt Echtzeit-Updates sicher, indem es die SMS-Details an die angegebene Webhook-URL sendet.

So konfigurieren Sie den Webhook im Dashboard

Befolgen Sie diese Schritte, um Ihre Webhook-URL im Dashboard einzurichten:

1. Melden Sie sich bei Ihrem Konto an auf der Dashboard der SMS Mobile API.
2. Navigieren Sie zum Webhook-Einstellungen Abschnitt.
3. Geben Sie Ihre Webhook-URL ein (z. B. https://example.com/webhook-endpoint).
4. Klicken Sie auf das Webhook speichern Taste. 
5. Nach dem Speichern beginnt das System, SMS-Details an die konfigurierte URL zu senden.

Webhook-Nutzlast

Wenn eine SMS empfangen wird, sendet das System die folgende JSON-Nutzlast an Ihre Webhook-URL:

{ "date": "2025-01-20", "hour": "10:15:00", "time_received": "2025-01-20 10:14:50", "message": "Hallo, dies ist ein Test.", "number": "+123456789", "guid": "abcde12345" }

Nutzlastfelder:

• Datum: Datum, an dem die SMS hinzugefügt wurde (JJJJ-MM-TT).
• Stunde: Stunde, wann die SMS hinzugefügt wurde (HH:mm:ss).
• Empfangszeit: Uhrzeit des SMS-Empfangs.
• Nachricht: Inhalt der SMS. 
• Nummer: Telefonnummer des Absenders.
• Anleitung: Eindeutige Kennung der SMS.

Beispiel für einen Webhook-Endpunkt

Ihr Server sollte bereit sein, eingehende POST-Anfragen zu verarbeiten. Unten finden Sie ein Beispiel-PHP-Skript zur Verarbeitung der Webhook-Nutzlast:

Testen des Webhooks

Verwenden Sie zum Testen Ihrer Webhook-Konfiguration Tools wie:

• Webhook.site
• AnfrageBin

Fehlerbehebung

• Stellen Sie sicher, dass die Webhook-URL korrekt und öffentlich zugänglich ist.
• Überprüfen Sie, ob Ihr Server bei erfolgreichen Anfragen den HTTP-Statuscode 200 zurückgibt.
• Überprüfen Sie Ihre Serverprotokolle auf Fehler bei der Verarbeitung der Nutzlast.

Erweiterte SMS

Authentifizierung

Die SMSMobile-API unterstützt zwei Authentifizierungsmethoden: die Verwendung eines einfachen API-Schlüssels oder des OAuth2-Protokolls mit einer Client-ID und einem Client-Geheimnis.

1. API-Schlüsselauthentifizierung

 Diese Methode erfordert einen API-Schlüssel, der als Parameter in eine GET- oder POST-Anfrage eingefügt werden kann.

2. OAuth2-Authentifizierung

OAuth2 bietet eine sicherere Authentifizierungsmethode.
Verwenden Sie eine Client-ID und ein Client-Geheimnis, um ein Zugriffstoken zu erhalten, und fügen Sie es dann in die folgende ein: Genehmigung Kopfzeile.

Die Client-ID und das Client-Geheimnis sind in Ihrem Dashboard verfügbar.
Laden Sie jetzt die mobile App herunter oder Greifen Sie auf Ihr Dashboard zu.

Abrufen eines Zugriffstokens

Verwenden des Zugriffstokens:

Welche Methode sollten Sie verwenden?

- Verwenden API-Schlüsselauthentifizierung für schnelle und unkomplizierte Integrationen.

- Verwenden OAuth2-Authentifizierung für mehr Sicherheit und Skalierbarkeit.