Dokumentation for notifikations-API'en
Disse slutpunkter giver dig mulighed for send interne mobilnotifikationer og hent notifikationshistorik fra SMSMobileAPI. Notifikationer kan sendes til en bestemt mobilenhed og derefter spores via listeslutpunktet.
De notifikation/liste endpoint returnerer afsendelsestidspunkt og distributionstidspunkt for notifikationer i GMT, inklusive fulde dato- og klokkeslætsstrenge og Unix-tidsstempler.
Hurtigstart
Basis-URL
Eksempler
Autentificering
Notifikationsslutpunkter godkendes ved hjælp af apikey parameter.
Almindelige begreber
Mål mobil
Notifikationer sendes til en bestemt mobilenhed ved hjælp af sideListens slutpunkt kan filtrere det samme mål ved hjælp af identifikation eller side.
Distribueret status
- distribueret=1 betyder, at meddelelsen blev distribueret.
- distribueret=0 betyder ikke distribueret.
- distribueret_status returneringer distribueret eller ikke_distribueret.
Datoer og tidszoner
- sendt_* felterne repræsenterer dato/tidspunkt for afsendelse af beskeden i GMT.
- distribueret_* felterne repræsenterer distributionsdato/-tidspunkt i GMT.
- *_at_unix Felterne er Unix-tidsstempler.
Funktionsmåde for listeslutpunkter
- Listens slutpunkt returnerer altid maksimalt 200 rækker.
- Resultaterne sorteres fra nyeste til ældste efter afsendelsesdato/-tidspunkt.
- Brug af datofiltre datoAjout internt og er udsat som dato_fra / dato_til.
Fejl
| HTTP | Eksempelfejl | Mening |
|---|---|---|
| 400 | {"success":false,"message":"Mangler obligatorisk parameter: apikey."} | Mangler eller er tom apikey. |
| 400 | {"success":false,"message":"Mangler obligatoriske parametre: apikey og sid er obligatoriske."} | Manglende side på notifikation/send. |
| 400 | {"success":false,"message":"Mangler obligatorisk parameter: message."} | Manglende besked på notifikation/send. |
| 400 | {"success":false,"message":"Ugyldigt date_from-format. Forventet ÅÅÅÅ-MM-DD."} | Ugyldig dato_fra formatér på notifikation/liste. |
| 400 | {"success":false,"message":"Ugyldig distribueret værdi. Tilladte værdier: 0 eller 1."} | Ugyldig distribueret filterværdi. |
| 500 | {"success":false,"message":"Databasforbindelse mislykkedes."} | Problem med databaseforbindelse. |
| 500 | {"success":false,"message":"Forespørgsel mislykkedes: ..."} | SQL-/udførelsesfejl. |
Meddelelse – Send
Opret en ny notifikation til en målmobilenhed.
Slutpunkt
Forespørgsels-/brødtekstparametre
| Parameter | Type | Beskrivelse |
|---|---|---|
| apikey | snor | Påkrævet Din API-nøgle. |
| side | snor | Påkrævet Target mobil identifikationsværktøj. |
| titel | snor | Valgfri Meddelelsestitel. Standard: Notifikation. |
| besked | snor | Påkrævet Indhold af notifikationsbesked. |
| type | snor | Valgfri Meddelelsestype. Standard: notifikation. |
Eksempel på succesfuld respons
{ "success": true, "message": "Notifikation oprettet.", "id": 22087, "apikey": "DIN_API_NØGLE", "sid": "508b004b4aadacc4" }
Meddelelse – Liste
Hent de seneste notifikationer for en API-nøgle med valgfri filtrering.
Slutpunkt
Forespørgselsparametre
| Parameter | Type | Beskrivelse |
|---|---|---|
| apikey | snor | Påkrævet Din API-nøgle. |
| identifikation | snor | Valgfri Filtrer notifikationer efter målmobil. |
| side | snor | Valgfri Alias af identifikation. |
| distribueret | 0 | 1 | Valgfri 1 = kun distribueret, 0 = ikke kun distribueret. |
| dato_fra | ÅÅÅÅ-MM-DD | Valgfri Filtrer afsendelsesdato fra denne dag. |
| dato_til | ÅÅÅÅ-MM-DD | Valgfri Filtrer afsendelsesdatoen frem til denne dag. |
Eksempel på succesfuld respons
{ "success": true, "message": "Notifikationer hentet med succes.", "filters": { "identifiant": "508b004b4aadacc4", "distribued": "1", "date_from": "", "date_to": "", "limit": 200 }, "count": 1, "data": [ { "identifiant": "508b004b4aadacc4", "title": "Notifikation", "message": "vers miono", "distribued": "1", "distribued_status": "distribueret", "distributed_date_gmt": "2026-03-18", "distributed_time_gmt": "10:18:30", "distributed_at_gmt": "2026-03-18 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" } ] }
Send svarfelter
| Felt | Type | Beskrivelse |
|---|---|---|
| succes | bool | Anmodningsstatus. |
| besked | snor | Menneskelæsbar resultatmeddelelse. |
| id | int | Oprettede notifikations-ID i databasen. |
| apikey | snor | Gentaget API-nøgle. |
| side | snor | Målmobilidentifikator brugt under oprettelsen. |
Liste over svarfelter
| Felt | Type | Beskrivelse |
|---|---|---|
| succes | bool | Anmodningsstatus. |
| besked | snor | Menneskelæsbar resultatmeddelelse. |
| filtre | objekt | Gentagne filtre brugt af anmodningen. |
| tælle | int | Antal returnerede meddelelser. |
| data | array | Liste over notifikationer. |
| data[].identifikator | snor | Målrettet mobilidentifikator. |
| data[].titel | snor | Meddelelsestitel. |
| data[].besked | snor | Meddelelse. |
| data[].distribueret | snor | Rå distribueret flag. |
| data[].distribueret_status | snor | distribueret eller ikke_distribueret. |
| data[].distribueret_dato_gmt | snor | Distribueringsdato i GMT. |
| data[].distribueret_tid_gmt | snor | Distributionstidspunkt i GMT. |
| data[].distribueret_ved_gmt | snor | Fuld distributionsdato og -tidspunkt i GMT. |
| data[].distribueret_på_unix | int|null | Distributionsdato og -tidspunkt som Unix-tidsstempel. |
| data[].distribueret_tidszone | snor | Altid GMT. |
| data[].sendt_dato_gmt | snor | Send dato i GMT. |
| data[].sendt_tidspunkt_gmt | snor | Send tid i GMT. |
| data[].sendt_at_gmt | snor | Fuld afsendelsesdato og -tidspunkt i GMT. |
| data[].sendt_på_unix | int|null | Send dato og klokkeslæt som Unix-tidsstempel. |
| data[].sendt_tidszone | snor | Altid GMT. |
