Dokumentation der Benachrichtigungs-API
Diese Endpunkte ermöglichen Ihnen Interne mobile Benachrichtigungen senden Und Benachrichtigungsverlauf abrufen von SMSMobileAPI. Benachrichtigungen können an ein bestimmtes Mobilgerät gesendet und anschließend über den Listenendpunkt verfolgt werden.
Der Benachrichtigung/Liste Der Endpunkt gibt die Sendezeit und die Verteilungszeit der Benachrichtigung zurück. GMTeinschließlich vollständiger Datums- und Zeitzeichenfolgen und Unix-Zeitstempel.
Schnellstart
Basis-URL
Beispiele
Authentifizierung
Benachrichtigungsendpunkte authentifizieren sich mithilfe von apikey Parameter.
Gemeinsame Konzepte
Target Mobile
Benachrichtigungen werden an ein bestimmtes Mobilgerät gesendet mithilfe von SeiteDer Listenendpunkt kann dasselbe Ziel filtern mithilfe von Identifikator oder Seite.
Verteilter Status
- verteilt=1 bedeutet, dass die Benachrichtigung verteilt wurde.
- verteilt=0 bedeutet nicht verteilt.
- verteilter_status Rückgaben verteilt oder nicht_verteilt.
Datum und Zeitzonen
- gesendet_* Die Felder stellen das Datum/die Uhrzeit des Benachrichtigungsversands dar. GMT.
- verteilt_* Die Felder stellen das Verteilungsdatum/-zeitpunkt dar. GMT.
- *_at_unix Die Felder sind Unix-Zeitstempel.
Verhalten des Listenendpunkts
- Der Listenendpunkt gibt immer maximal Folgendes zurück: 200 Zeilen.
- Die Ergebnisse werden nach Sendedatum/-zeit vom neuesten zum ältesten sortiert.
- Datumsfilter verwenden dateAjout intern und werden freigelegt als Datum_von / Datum bis.
Fehler
| HTTP | Beispielfehler | Bedeutung |
|---|---|---|
| 400 | {"success":false,"message":"Fehlender erforderlicher Parameter: API-Schlüssel."} | Fehlend oder leer apikey. |
| 400 | {"success":false,"message":"Fehlende erforderliche Parameter: apikey und sid sind obligatorisch."} | Fehlen Seite An Benachrichtigung/Senden. |
| 400 | {"success":false,"message":"Fehlender erforderlicher Parameter: message."} | Fehlen Nachricht An Benachrichtigung/Senden. |
| 400 | {"success":false,"message":"Ungültiges Datumsformat. Erwartet wird YYYY-MM-DD."} | Ungültig Datum_von Format auf Benachrichtigung/Liste. |
| 400 | {"success":false,"message":"Ungültiger verteilter Wert. Zulässige Werte: 0 oder 1."} | Ungültig verteilt Filterwert. |
| 500 | {"success":false,"message":"DB-Verbindung fehlgeschlagen."} | Datenbankverbindungsproblem. |
| 500 | {"success":false,"message":"Abfrage fehlgeschlagen: ..."} | SQL-/Ausführungsfehler. |
Benachrichtigung – Senden
Eine neue Benachrichtigung für ein Zielmobilgerät erstellen.
Endpunkt
Abfrage-/Body-Parameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| apikey | Zeichenkette | Erforderlich Ihr API-Schlüssel. |
| Seite | Zeichenkette | Erforderlich Zielmobilgerät-Kennung. |
| Titel | Zeichenkette | Optional Benachrichtigungstitel. Standard: Benachrichtigung. |
| Nachricht | Zeichenkette | Erforderlich Inhalt der Benachrichtigung. |
| Typ | Zeichenkette | Optional Benachrichtigungstyp. Standard: Benachrichtigung. |
Beispiel einer erfolgreichen Antwort
{ "success": true, "message": "Benachrichtigung erstellt.", "id": 22087, "apikey": "IHR_API-SCHLÜSSEL", "sid": "508b004b4aadacc4" }
Benachrichtigungsliste
Ruft die neuesten Benachrichtigungen für einen API-Schlüssel ab, optional mit Filterfunktion.
Endpunkt
Abfrageparameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| apikey | Zeichenkette | Erforderlich Ihr API-Schlüssel. |
| Identifikator | Zeichenkette | Optional Benachrichtigungen nach Zielmobilgerät filtern. |
| Seite | Zeichenkette | Optional Alias von Identifikator. |
| verteilt | 0 | 1 | Optional 1 = nur verteilt, 0 = nur im Vertrieb erhältlich. |
| Datum_von | JJJJ-MM-TT | Optional Filter gesendete Daten ab diesem Tag. |
| Datum bis | JJJJ-MM-TT | Optional Filter gesendete Daten bis zum heutigen Tag. |
Beispiel einer erfolgreichen Antwort
{ "success": true, "message": "Benachrichtigungen erfolgreich abgerufen.", "filters": { "sidentifiant": "508b004b4aadacc4", "distribued": "1", "date_from": "", "date_to": "", "limit": 200 }, "count": 1, "data": [ { "sidentifiant": "508b004b4aadacc4", "title": "Benachrichtigung", "message": "vers miano", "distribued": "1", "distribued_status": "distributed", "distributed_date_gmt": "2026-03-18", "distributed_time_gmt": "10:18:30", "distributed_at_gmt": "2026-03-18 10:18:30", "distributed_at_unix": 1773829110, "distributed_timezone": "GMT", "sent_date_gmt": "2026-03-18", "sent_time_gmt": "10:15:03", "sent_at_gmt": "2026-03-18 10:15:03", "sent_at_unix": 1773828903, "sent_timezone": "GMT" } ] }
Antwortfelder senden
| Feld | Typ | Beschreibung |
|---|---|---|
| Erfolg | bool | Anfragestatus. |
| Nachricht | Zeichenkette | Für Menschen lesbare Ergebnismeldung. |
| Ausweis | int | Benachrichtigungs-ID in der Datenbank erstellt. |
| apikey | Zeichenkette | Ausgegebener API-Schlüssel. |
| Seite | Zeichenkette | Zielmobilgerät-Kennung, die bei der Erstellung verwendet wurde. |
Antwortfelder auflisten
| Feld | Typ | Beschreibung |
|---|---|---|
| Erfolg | bool | Anfragestatus. |
| Nachricht | Zeichenkette | Für Menschen lesbare Ergebnismeldung. |
| Filter | Objekt | Die von der Anfrage verwendeten Filter wurden zurückgegeben. |
| zählen | int | Anzahl der zurückgesendeten Benachrichtigungen. |
| Daten | Array | Liste der Benachrichtigungen. |
| Daten[].Identifikator | Zeichenkette | Ziel-Mobilfunkidentifikator. |
| data[].title | Zeichenkette | Benachrichtigungstitel. |
| Daten[].Nachricht | Zeichenkette | Benachrichtigungsnachricht. |
| data[].distribued | Zeichenkette | Rohes verteiltes Flag. |
| data[].distribued_status | Zeichenkette | verteilt oder nicht_verteilt. |
| data[].distributed_date_gmt | Zeichenkette | Veröffentlichungsdatum in GMT. |
| data[].distributed_time_gmt | Zeichenkette | Verteilungszeit in GMT. |
| data[].distributed_at_gmt | Zeichenkette | Vollständiges Veröffentlichungsdatum und -zeit in GMT. |
| data[].distributed_at_unix | int|null | Verteilungsdatum und -zeit als Unix-Zeitstempel. |
| data[].distributed_timezone | Zeichenkette | Stets GMT. |
| data[].sent_date_gmt | Zeichenkette | Datum in GMT senden. |
| data[].sent_time_gmt | Zeichenkette | Zeitangabe in GMT senden. |
| data[].sent_at_gmt | Zeichenkette | Vollständiges Sendedatum/-zeit in GMT. |
| data[].sent_at_unix | int|null | Sende Datum und Uhrzeit als Unix-Zeitstempel. |
| data[].sent_timezone | Zeichenkette | Stets GMT. |
