SMS-dokumentaatio

Lähetä SMS

Päätepiste: 

Parametrit:

Esimerkkipyyntö:

Esimerkki JSON-vastauksesta:

{ "tulos": { "virhe": 0, "sent": "1", "id": "c319d3b35e8f8712cde20dae39ac3c19f86eda25", "note": "lähetetty matkapuhelimella", "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 } } }

Vastauksen selitys:

Lähetä uudelleen lähettämätön tekstiviesti

Tämän päätepisteen avulla voit lähettää uudelleen aiemmin lähettämättömän tekstiviestin vain, jos viesti on parhaillaan virhetilassa.

Päätepiste:

Parametrit: 

Esimerkkipyyntö: 

Esimerkki JSON-vastauksesta:

{ "tulos": { "virhe": "0", "sms": "uudelleenlähetetty onnistuneesti", "yritys": 1 } }

Vastauksen selitys:

API:lta lähetetty tekstiviestiloki

Tämän päätepisteen avulla voit hakea API:n kautta lähetettyjen tekstiviestien lokin.

Päätepiste: 

Parametrit:

Esimerkkipyyntö:

Esimerkki JSON-vastauksesta:

{ "tulos": { "virhe": "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, "vastaanottajat": "32495898697", "sms": "testi", "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" } ] } }

Vastauksen selitys:

Listaa matkapuhelimesta lähetetyt tekstiviestit

Tämän päätepisteen avulla voit listata mobiililaitteestasi lähetetyt ja SMSMobileAPI-tilillesi synkronoidut tekstiviestit.

Tärkeää: Tämä ominaisuus on käytettävissä Android-versiosta alkaen 4.1.20.

Tärkeää: Tämä ominaisuus on ei oletuksena käytössä Android-sovelluksessa.

Tietosuoja: Kaikki synkronoidut tiedot anonymisoidaan, luottamuksellisina ja käsitellään turvallisesti.

Historiaraja: Tämä API palauttaa tietoja vain viimeisimmästä 7 päivää.

Huomautus: Jos lähetät tekstiviestin käyttämällä vakio-API-päätepistettä https://api.smsmobileapi.com/sendsms/, nämä tekstiviestit saattavat näkyä tässä listauksessa myös siksi, että ne lähetetään fyysisesti mobiililaitteestasi.

Päätepiste:

Parametrit: 

Palautetut kentät: 

Esimerkkipyyntö: 

Esimerkki suodattimien kanssa:

Esimerkki ennalta määritellyllä ajanjaksolla:

Esimerkki JSON-vastauksesta:

{ "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": "Hei, aikasi on vahvistettu.", "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": "Vahvistuskoodisi on 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": "Kiitos tilauksestasi. Sitä käsitellään parhaillaan.", "mobile_date_ms": 1774026491230, "mobile_date_formatted": "2026-03-20 18:08:11", "synchro_time": "2026-03-20 17:19:19" } ] } }

Vastauksen selitys:

SMS vastaanotettu

Tämän päätepisteen avulla voit hakea älypuhelimeen vastaanotettuja tekstiviestejä. 

Päätepiste:

Parametrit: 

Esimerkkipyyntö:

Esimerkki JSON-vastauksesta:

{ "result": { "error": "", "sms": [ { "id": 466340, "sIdentifiantPhone": "e5b70a8a28b2ec3d", "date": "2026-03-20", "hour": "21:23:34", "timestamp_unix": 1774041814, "time_received": "20260320222332804", "indice": "27593", "message": "Hei, pakettisi on toimitettu.", "number": "+15551234567", "guid": "6BFD7DC7-3492-422D-8D02-4AF4E614F122", "alias": null, "apikey": "API-AVAIMESI_HASH" }, { "id": 466341, "sIdentifiantPhone": "e5b70a8a28b2ec3d", "date": "2026-03-20", "hour": "21:23:34", "timestamp_unix": 1774041814, "time_received": "20260320221005892", "index": "27591", "message": "Huomenna varattu aikasi on vahvistettu.", "number": "+447700900123", "guid": "BF3B38D7-8401-4A8C-8BA6-D8D58ACBB23E", "alias": null, "apikey": "API-AVAIMESI HASH" }, { "id": 466324, "sIdentifiantPhone": "e5b70a8a28b2ec3d", "date": "2026-03-20", "hour": "21:08:24", "timestamp_unix": 1774040904, "time_received": "20260320220822763", "index": "27590", "message": "Soita meille takaisin, kun olet käytettävissä.", "number": "+33198765432", "guid": "08C88E20-9B98-453F-B361-9BB06D3275D6", "alias": null, "apikey": "API-AVAIMESI_HASH" }, { "id": 466156, "sIdentifiantPhone": "e5b70a8a28b2ec3d", "date": "2026-03-20", "hour": "19:05:22", "timestamp_unix": 1774033522, "time_received": "20260320200026246", "indice": "27588", "message": "Muistutus: tilisi tarkistus odottaa.", "number": "10001", "guid": "551B2CF4-9330-4DD2-B2BA-5A4026EEEB15", "alias": null, "apikey": "YOUR_API_KEY_HASH" } ] } }

Vastauksen selitys:

Merkitse vastaanotetut tekstiviestit luetuiksi

Tätä API-päätepistettä käytetään merkitsemään yksi vastaanotettu tekstiviesti luetuksi Vain API-tila.
Tämä ei muuta älypuhelimen lukutilaa.  

Päätepiste:

Parametri: 

Esimerkki:

Päivitä tekstiviestialias

Tätä API-päätepistettä käytetään vastaanotetun tekstiviestin aliaksen päivittämiseen sen GUID:n avulla.

Huomautus: The alias parametri voi olla tyhjä. Siinä tapauksessa alias tyhjennetään.

Päätepiste:

Parametrit: 

Esimerkki: 

Esimerkki aliaksen tyhjentämisestä:

Poista tekstiviesti

Tämän päätepisteen avulla voit poistaa tekstiviestejä SMSMobileAPI-palvelimen lokista.

Päätepiste: 

Parametrit:

Esimerkkipyyntö:

Esimerkki JSON-vastauksesta:

{ "tulos": { "virhe": null, "poistojen_määrä": 1 } }

Vastauksen selitys:

Huomautus: vain SMSMobileAPI-palvelimen lokeihin tallennetut tekstiviestit poistetaan. Mobiililaitteeseen jo tallennettuja tekstiviestejä ei poisteta.

Listaa tekstiviestikeskustelut

Tätä API-päätepistettä käytetään tiliisi linkitettyjen tekstiviestikeskustelujen listaamiseen.

Jokainen keskustelu on ryhmitelty puhelinnumeron mukaan ja sisältää siihen liittyvät saapuvat ja lähtevät tekstiviestit.

Huomautus: Keskustelun lähtökohta määritellään seuraavasti: origineConversation parametri:

• received: keskustelut havaitaan ensin vastaanotetuista tekstiviesteistä logsmsreceive
• sent: keskustelut havaitaan ensin lähetetyistä tekstiviesteistä logsmssent

Huomautus: Jos numero ei anneta, API palauttaa vain uusimmat keskustelut. Oletusarvoisesti viimeisin 20 keskustelut palautetaan.

Huomautus: Lähtevien tekstiviestien osalta, jos timearea_of_message on saatavilla (esim. UTC+02), näytetty päivämäärä muunnetaan automaattisesti tämän arvon avulla. Tätä muunnettua päivämäärää käytetään myös lajitteluun.

Huomautus: Jos resume=1, vain kunkin keskustelun uusimmat viestit palautetaan. Käytä resume_line_how määrittääksesi, kuinka monta uusinta viestiä sisällytetään.

Päätepiste:

Parametrit: 

Käyttäytymisen tiedot: 

Esimerkki 1 - Listaa viimeisimmät keskustelut vastaanotetuista tekstiviesteistä: 

Esimerkki 2 - Listaa lähetettyjen tekstiviestien viimeisimmät keskustelut:

Esimerkki 3 – Suodata yksi tietty puhelinnumero:

Esimerkki 4 - Suodata päivämäärävälin mukaan:

Esimerkki 5 - Jatka-tila, jossa on kolme viimeisintä viestiä keskustelua kohden:

Esimerkki onnistuneesta vastauksesta: 

{ "success": true, "origineConversation": "received", "resume": 0, "resume_line_how": null, "conversations": [ { "phone_number": "+10470000001", "contact_alias": "Matti Meikäläinen", "messages": [ { "direction": "incoming", "message_id": "msg_1001", "date": "2026-03-13 08:45:12", "timestamp_utc": "2026-03-13T08:45:12Z", "message": "Hei, haluaisin lisätietoja.", "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": "Totta kai, mitä haluaisit tietää?", "status": "lähetetty", "mobile_sid": "device_sid_2" } ] } ] }

Vastauskentät:

Virheesimerkki:

{ "success": false, "error": "Puuttuva pakollinen parametri: apikey" }

Huomautuksia:

Yhdyskäytävä – Listaa yhdistetyt matkapuhelimet

Listaa laitteeseesi yhdistetyt matkapuhelimet SMS-yhdyskäytävä.

Päätepiste:

Parametrit:

Esimerkki:

Yhdyskäytävä – Päivitä mobiilitarra

Päivitä yhdistetyn mobiililaitteen otsikko (nom_reference).

Päätepiste:

Parametrit:

Esimerkki:

Tärkeää: otsikko on pakollinen, mutta voi olla tyhjä (etiketti=).

Yhdyskäytävä – Yhdistetty mobiililaite

Poista yhdistetty matkapuhelin yhdyskäytävästäsi (poistaa kaikki tämän SID:n historiarivit).

Päätepiste:

Parametrit:

Esimerkki:

Webhook – SMS vastaanotettu

Tämä webhook-järjestelmä lähettää POST-pyynnön määritettyyn URL-osoitteeseen aina, kun tekstiviesti vastaanotetaan. Järjestelmä varmistaa reaaliaikaiset päivitykset toimittamalla tekstiviestin tiedot määritettyyn webhook-URL-osoitteeseen.

Webhookin määrittäminen hallintapaneelissa

Määritä webhookin URL-osoite hallintapaneelissa noudattamalla näitä ohjeita:

1. Kirjaudu tilillesi osoitteessa SMS Mobile API Dashboard.
2. Navigoi kohtaan Webhook-asetukset osio.
3. Anna webhookin URL-osoite (esim. https://example.com/webhook-endpoint).
4. Napsauta Tallenna Webhook -painiketta. 
5. Kun järjestelmä on tallennettu, se alkaa lähettää tekstiviestitietoja määritettyyn URL-osoitteeseen.

Webhook-hyötykuorma

Kun tekstiviesti vastaanotetaan, järjestelmä lähettää seuraavan JSON-hyötykuorman webhook-URL-osoitteeseen:

{ "date": "2025-01-20", "hour": "10:15:00", "time_received": "2025-01-20 10:14:50", "message": "Hei, tämä on testi.", "number": "+123456789", "guid": "abcde12345" }

Hyötykuormakentät:

• päivämäärä: Päivämäärä, jolloin tekstiviesti lisättiin (VVVV-KK-PP).
• tunnin: Tunti, jolloin tekstiviesti lisättiin (HH:mm:ss).
• time_received: Aika, jolloin tekstiviesti vastaanotettiin.
• viesti: Tekstiviestin sisältö. 
• määrä: Lähettäjän puhelinnumero.
• opas: SMS-viestin yksilöllinen tunniste.

Esimerkki Webhook-päätepiste

Palvelimesi pitäisi olla valmis käsittelemään saapuvia POST-pyyntöjä. Alla on esimerkki PHP-skriptistä webhook-hyötykuorman käsittelemiseksi:

Webhookin testaus

Voit testata webhookin määrityksiä käyttämällä työkaluja, kuten:

• Webhook.site
• RequestBin

Vianetsintä

• Varmista, että webhookin URL-osoite on oikea ja julkisesti saatavilla.
• Varmista, että palvelimesi palauttaa HTTP 200 -tilakoodin onnistuneille pyynnöille.
• Tarkista palvelimesi lokeista hyötykuorman käsittelyssä tapahtuneet virheet.

Rikastettu tekstiviesti

Todennus

SMSMobile API tukee kahta todennusmenetelmää: käyttämällä yksinkertaista API-avainta tai OAuth2-protokollaa, jossa on asiakastunnus ja asiakassalaisuus.

1. API-avaimen todennus

 Tämä menetelmä vaatii API-avaimen, joka voidaan sisällyttää parametrina joko GET- tai POST-pyyntöön.

2. OAuth2-todennus

OAuth2 tarjoaa turvallisemman todennusmenetelmän.
Käytä asiakastunnusta ja asiakkaan salaisuutta saadaksesi käyttöoikeustunnuksen ja lisää se sitten Valtuutus otsikko.

Asiakastunnus ja client_secret ovat saatavilla hallintapaneelissasi.
Lataa mobiilisovellus nyt tai käytä kojelautaasi.

Käyttöoikeustunnuksen hankkiminen

Käyttöoikeustunnuksen käyttäminen:

Mitä menetelmää sinun tulisi käyttää?

- Käytä API-avaimen todennus nopeaa ja suoraviivaista integrointia varten.

- Käytä OAuth2-todennus parannetun turvallisuuden ja skaalautuvuuden takaamiseksi.