Documentatie voor de notificatie-API
Met deze eindpunten kunt u interne mobiele meldingen verzenden En notificatiegeschiedenis ophalen Via SMSMobileAPI kunnen meldingen naar een specifiek mobiel apparaat worden verzonden en vervolgens worden gevolgd via het lijst-eindpunt.
De melding/lijst Het eindpunt retourneert de verzendtijd van de melding en de distributietijd. GMT, inclusief volledige datum- en tijdreeksen en Unix-tijdstempels.
Snelstart
Basis-URL
Voorbeelden
Authenticatie
Notificatie-eindpunten authenticeren zich met behulp van de apikey parameter.
Gemeenschappelijke concepten
Target mobiel
Meldingen worden naar een specifiek mobiel apparaat verzonden met behulp van sidHet lijst-eindpunt kan hetzelfde doel filteren met behulp van identificator of sid.
Gedistribueerde status
- verdeeld=1 Dit betekent dat de melding is verspreid.
- verdeeld=0 betekent niet verdeeld.
- gedistribueerde_status retourneert verspreid of niet_verdeeld.
Datums en tijdzones
- verstuurd_* De velden vertegenwoordigen de verzenddatum/tijd van de melding in GMT.
- gedistribueerd_* velden vertegenwoordigen de distributiedatum/tijd in GMT.
- *_at_unix De velden zijn Unix-tijdstempels.
Toon het eindpuntgedrag
- Het lijst-eindpunt retourneert altijd maximaal 200 rijen.
- De resultaten worden gesorteerd van nieuwste naar oudste op basis van verzenddatum/tijd.
- Datumfilters gebruiken datumAanvoegen intern en worden blootgesteld als datum_van / datum_tot.
Fouten
| HTTP | Voorbeeldfout | Betekenis |
|---|---|---|
| 400 | {"success":false,"message"Vereiste parameter ontbreekt: apikey."} | Ontbreekt of is leeg apikey. |
| 400 | {"success":false,"messageOntbrekende verplichte parameters: apikey en sid zijn verplicht."} | Vermist sid op melding/verzenden. |
| 400 | {"success":false,"messageVereiste parameter ontbreekt: message."} | Vermist bericht op melding/verzenden. |
| 400 | {"success":false,"message:"Ongeldig datumformaat. Verwacht JJJJ-MM-DD."} | Ongeldig datum_van format op melding/lijst. |
| 400 | {"success":false,"messageOngeldige gedistribueerde waarde. Toegestane waarden: 0 of 1."} | Ongeldig gedistribueerd filterwaarde. |
| 500 | {"success":false,"messageDB-verbinding mislukt."} | Probleem met de databaseverbinding. |
| 500 | {"success":false,"messageQuery failed: ..."} | SQL-/uitvoeringsfout. |
Melding – Verzenden
Maak een nieuwe melding aan voor een specifiek mobiel apparaat.
Eindpunt
Query-/bodyparameters
| Parameter | Type | Beschrijving |
|---|---|---|
| apikey | snaar | Vereist Uw API-sleutel. |
| sid | snaar | Vereist Doelwit mobiele identificatie. |
| titel | snaar | Optioneel Titel van de melding. Standaard: Kennisgeving. |
| bericht | snaar | Vereist Inhoud van het notificatiebericht. |
| type | snaar | Optioneel Type melding. Standaard: kennisgeving. |
Voorbeeld van een succesvolle reactie
{ "success": true, "message": "Notification created.", "id": 22087, "apikey": "YOUR_API_KEY", "sid": "508b004b4aadacc4" }
Melding – Lijst
Haal de meest recente meldingen op voor een API-sleutel, met optionele filtering.
Eindpunt
Queryparameters
| Parameter | Type | Beschrijving |
|---|---|---|
| apikey | snaar | Vereist Uw API-sleutel. |
| identificator | snaar | Optioneel Filter meldingen op basis van het beoogde mobiele apparaat. |
| sid | snaar | Optioneel Alias van identificator. |
| gedistribueerd | 0 | 1 | Optioneel 1 = alleen gedistribueerd, 0 = niet alleen gedistribueerd. |
| datum_van | JJJJ-MM-DD | Optioneel Filter verzonden datum vanaf deze dag. |
| datum_tot | JJJJ-MM-DD | Optioneel Filter verzonden datum tot op de huidige dag. |
Voorbeeld van een succesvolle reactie
{ "success": true, "message": "Meldingen succesvol opgehaald.", "filters": { "sidentifiant": "508b004b4aadacc4", "distribued": "1", "date_from": "", "date_to": "", "limit": 200 }, "count": 1, "data": [ { "sidentifiant": "508b004b4aadacc4", "title": "Melding", "message": "vers miano", "distribued": "1", "distribued_status": "gedistribueerd", "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" } ] }
Verzend reactievelden
| Veld | Type | Beschrijving |
|---|---|---|
| succes | bool | Status van het verzoek. |
| bericht | snaar | Een resultaatbericht dat voor mensen leesbaar is. |
| id | int | Er is een notificatie-ID aangemaakt in de database. |
| apikey | snaar | Weergegeven API-sleutel. |
| sid | snaar | Doelwit mobiele identificatiecode gebruikt tijdens de aanmaak. |
Lijst met antwoordvelden
| Veld | Type | Beschrijving |
|---|---|---|
| succes | bool | Status van het verzoek. |
| bericht | snaar | Een resultaatbericht dat voor mensen leesbaar is. |
| filters | voorwerp | De filters die in het verzoek zijn gebruikt, worden weergegeven. |
| graaf | int | Aantal ontvangen meldingen. |
| gegevens | array | Lijst met meldingen. |
| data[].identificator | snaar | Doelwit mobiele identificatiecode. |
| data[].title | snaar | Titel van de melding. |
| data[].message | snaar | Notificatiebericht. |
| data[].distribued | snaar | Onbewerkte gedistribueerde vlag. |
| data[].distributed_status | snaar | verspreid of niet_verdeeld. |
| data[].distributed_date_gmt | snaar | Distributiedatum in GMT. |
| data[].distributed_time_gmt | snaar | Distributietijd in GMT. |
| data[].distributed_at_gmt | snaar | De volledige distributiedatum en -tijd wordt weergegeven in GMT. |
| data[].distributed_at_unix | int|null | Datum en tijd van de distributie als Unix-tijdstempel. |
| data[].distributed_timezone | snaar | Altijd GMT. |
| data[].sent_date_gmt | snaar | Verzend de datum in GMT. |
| data[].sent_time_gmt | snaar | Verzend de tijd in GMT. |
| data[].sent_at_gmt | snaar | De volledige verzenddatum en -tijd worden in GMT weergegeven. |
| data[].sent_at_unix | int|null | Verzend de datum en tijd als Unix-timestamp. |
| data[].sent_timezone | snaar | Altijd GMT. |
