Ilmoitus-API:n dokumentaatio
Näiden päätepisteiden avulla voit lähetä sisäisiä mobiili-ilmoituksia ja nouda ilmoitushistoria SMSMobileAPI:sta. Ilmoituksia voidaan lähettää tiettyyn mobiililaitteeseen ja seurata niitä sitten listan päätepisteen kautta.
The ilmoitus/lista päätepiste palauttaa ilmoituksen lähetys- ja jakeluajan GMT-aika, mukaan lukien täydelliset päivämäärä- ja aikamerkkijonot ja Unix-aikaleimat.
Tarvitsetko apua? api@smsmobileapi.com
Pika-aloitus
Perus-URL
SAADA https://api.smsmobileapi.com
Kaikki alla olevat esimerkit on esitetty seuraavasti SAADA pyynnöt yksinkertaisuudesta. ilmoitus/lähetä päätepiste hyväksyy myös LÄHETTÄÄ ja JSON-runkoKorvaa YOUR_API_AVAIN oikealla avaimellasi.
Esimerkkejä
HANKI https://api.smsmobileapi.com/notification/send?apikey=YOUR_API_KEY&sid=TARGET_SIDENTIFIANT&title=Notification&message=Helloworld&type=notification
HANKI https://api.smsmobileapi.com/notification/list/?apikey=YOUR_API_KEY
HANKI https://api.smsmobileapi.com/notification/list/?apikey=YOUR_API_KEY&sidentifiant=TARGET_SIDENTIFIANT&distribued=1&date_from=2026-03-01&date_to=2026-03-18
Todennus
Ilmoituspäätepisteet todennetaan käyttämällä apikey parametri.
Vaaditaan molemmissa päätepisteissä: API-avain on pakollinen
ilmoitus/lähetä ja ilmoitus/lista.
Yleisiä käsitteitä
Kohdista mobiili
Ilmoitukset lähetetään tiettyyn mobiililaitteeseen käyttämällä sidListan päätepiste voi suodattaa saman kohteen käyttämällä sivuidentifiantti tai sid.
Hajautettu tila
- jaettu=1 tarkoittaa, että ilmoitus on jaettu.
- jaettu=0 tarkoittaa, ettei sitä jaeta.
- jaettu_tila tuotot hajautettu tai ei_jaettu.
Päivämäärät ja aikavyöhykkeet
- lähetetty_* kentät edustavat ilmoituksen lähetyspäivämäärää/-aikaa GMT-aika.
- hajautettu_* kentät edustavat jakelun päivämäärää/kellonaikaa GMT-aika.
- *_at_unix kentät ovat Unix-aikaleimoja.
Listan päätepisteen toiminta
- Listan päätepiste palauttaa aina enintään 200 rivit.
- Tulokset on järjestetty lähetyspäivämäärän ja -kellonajan mukaan uusimmasta vanhimpaan.
- Päivämääräsuodattimien käyttö päivämääräAjout sisäisesti ja altistuvat päivämäärä_alkaen / päivämäärä_päättymispäivä.
Virheet
| HTTP | Esimerkkivirhe | Merkitys |
|---|---|---|
| 400 | {"success":false,"message":"Puuttuva pakollinen parametri: apikey."} | Puuttuu tai on tyhjä apikey. |
| 400 | {"success":false,"message":"Puuttuvia pakollisia parametreja: apikey ja sid ovat pakollisia."} | Puuttuva sid päällä ilmoitus/lähetä. |
| 400 | {"success":false,"message":"Puuttuva pakollinen parametri: viesti."} | Puuttuva viesti päällä ilmoitus/lähetä. |
| 400 | {"success":false,"message":"Virheellinen date_from-muoto. Odotettu muoto on VVVV-KK-PP."} | Virheellinen päivämäärä_alkaen muoto päällä ilmoitus/lista. |
| 400 | {"success":false,"message":"Virheellinen jaettu arvo. Sallitut arvot: 0 tai 1."} | Virheellinen hajautettu suodattimen arvo. |
| 500 | {"success":false,"message":"Tietokantayhteys epäonnistui."} | Tietokantayhteysongelma. |
| 500 | {"success":false,"message":"Kysely epäonnistui: ..."} | SQL-/suoritusvirhe. |
Ilmoitus – Lähetä
Luo uusi ilmoitus kohdemobiililaitteelle.
Päätepiste
SAADA
LÄHETTÄÄ
https://api.smsmobileapi.com/notification/send
Kysely-/runkoparametrit
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
| apikey | jono | Pakollinen API-avaimesi. |
| sid | jono | Pakollinen Kohdista mobiilitunniste. |
| otsikko | jono | Valinnainen Ilmoituksen otsikko. Oletus: Ilmoitus. |
| viesti | jono | Pakollinen Ilmoitusviestin sisältö. |
| tyyppi | jono | Valinnainen Ilmoitustyyppi. Oletus: ilmoitus. |
Esimerkki onnistumisvastauksesta
{ "success": true, "message": "Ilmoitus luotu.", "id": 22087, "apikey": "API-AVAIMESI", "sid": "508b004b4aadacc4" }
Ilmoitus – Luettelo
Hae API-avaimen uusimmat ilmoitukset, valinnaisella suodatuksella.
Päätepiste
SAADA
https://api.smsmobileapi.com/notification/list/
Kyselyparametrit
| Parametri | Tyyppi | Kuvaus |
|---|---|---|
| apikey | jono | Pakollinen API-avaimesi. |
| sivuidentifiantti | jono | Valinnainen Suodata ilmoitukset kohdemobiilin mukaan. |
| sid | jono | Valinnainen Alias sivuidentifiantti. |
| hajautettu | 0 | 1 | Valinnainen 1 = vain hajautettu 0 = ei ainoastaan jaettu. |
| päivämäärä_alkaen | VVVV-KK-PP | Valinnainen Suodattimen lähetyspäivämäärä tältä päivältä. |
| päivämäärä_päättymispäivä | VVVV-KK-PP | Valinnainen Suodattimen lähetyspäivä tähän päivään mennessä. |
Listan päätepiste palauttaa korkeintaan 200 rivit ja järjestää ne uusimman lähetetyn ilmoituksen mukaan ensin.
Esimerkki onnistumisvastauksesta
{ "success": true, "message": "Ilmoitukset noudettu onnistuneesti.", "filters": { "sidentifiant": "508b004b4aadacc4", "distribued": "1", "date_from": "", "date_to": "", "limit": 200 }, "count": 1, "data": [ { "sidentifiant": "508b004b4aadacc4", "title": "Ilmoitus", "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_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" } ] }
Lähetä vastaus -kentät
| Ala | Tyyppi | Kuvaus |
|---|---|---|
| menestys | totuusarvo | Pyynnön tila. |
| viesti | jono | Ihmisen luettavissa oleva tulosviesti. |
| tunnus | int | Ilmoitustunnus luotiin tietokantaan. |
| apikey | jono | Kaiutettu API-avain. |
| sid | jono | Kohdemobiililaitteen tunniste, jota käytettiin luonnin aikana. |
Listaa vastauskentät
| Ala | Tyyppi | Kuvaus |
|---|---|---|
| menestys | totuusarvo | Pyynnön tila. |
| viesti | jono | Ihmisen luettavissa oleva tulosviesti. |
| suodattimet | esine | Pyynnön käyttämät kaikusuodattimet. |
| laskea | int | Palautettujen ilmoitusten määrä. |
| data | taulukko | Ilmoitusten luettelo. |
| data[].sidentifiant | jono | Kohdemobiililaitteen tunniste. |
| data[].otsikko | jono | Ilmoituksen otsikko. |
| data[].viesti | jono | Ilmoitusviesti. |
| data[].distribued | jono | Raaka jaettu lippu. |
| data[].distribued_status | jono | hajautettu tai ei_jaettu. |
| data[].distributed_date_gmt | jono | Jakelupäivämäärä GMT:ssä. |
| data[].distributed_time_gmt | jono | Jakeluaika GMT:ssä. |
| data[].distributed_at_gmt | jono | Täydellinen jakelun päivämäärä ja kellonaika GMT:ssä. |
| data[].distributed_at_unix | kokonaisluku|null | Jakelun päivämäärä ja kellonaika Unix-aikaleimana. |
| data[].distributed_timezone | jono | Aina GMT-aika. |
| data[].lähetyspäivämäärä_gmt | jono | Lähetä päivämäärä GMT-aikavyöhykkeellä. |
| data[].lähetysaika_gmt | jono | Lähetä aika GMT:ssä. |
| data[].lähetetty_gmt-kohdassa | jono | Koko lähetyspäivämäärä ja -aika GMT-aikana. |
| data[].lähetetty_unixissa | kokonaisluku|null | Lähetä päivämäärä ja kellonaika Unix-aikaleimana. |
| data[].lähetetty_aikavyöhyke | jono | Aina GMT-aika. |
English 
French 
German 
Spanish 
Portuguese 
Russian 
Finnish 
Japanese 
Chinese 
Vietnamese 
Dutch 
Greek 
Arabic 
Danish 
Italian 
Ukrainian