Email2SMS

Lertify Email2SMS omogoča pošiljanje SMS sporočil tako, da uporabnik pošlje strukturirano e-poštno sporočilo na svoj konfigurirani Email2SMS naslov. Sistem iz telesa e-pošte prebere ključ API, pošiljatelja, prejemnike, vsebino sporočila in izbirne nastavitve ter nato zahtevo posreduje v Lertify SMS sistem.

Pomembno: e-poštni naslov pošiljatelja mora biti dovoljen za uporabljeni ključ API. Ključ API sam po sebi ni dovolj,
če e-poštni naslov pošiljatelja ni avtoriziran za ta račun.

Kako uporabljati Email2SMS

  1. Pošljite e-pošto – Sporočilo pošljite na naslov email2sms@lertify.app.
  2. Uporabite dovoljen e-poštni naslov – Privzeto lahko zahtevo pošljete iz kateregakoli e-poštnega naslova. Če je pri
    API ključu nastavljen en ali več dovoljenih e-poštnih naslovov, bodo sprejete samo zahteve, poslane iz teh naslovov.
  3. V telo e-pošte dodajte oznake – Obvezne oznake so #apikey#, #sender#,
    #startdestination# … #enddestination# ter #startcontent# … #endcontent#.
  4. Dodajte prejemnike – Telefonske številke lahko v razdelku s prejemniki ločite z novo vrstico, podpičjem ali
    vejico.
  5. Po želji dodajte dodatne nastavitve – Uporabite lahko #defaultcc#, #isunicode#,
    #scheduledtime#, #pricereport# in #callbackurl#.
  6. Pošljite e-pošto – Če je zahteva veljavna, se SMS sporočilo odda v pošiljanje. Če so v vsebini napake, sistem
    pošlje povratno e-pošto z opisom napake.

Obvezna polja

Oznaka Vrsta Obvezno Opis
#apikey# UUID Da Ključ API. Uporablja se za identifikacijo računa in skupaj z naslovom From za avtorizacijo.
#sender# string Da Ime pošiljatelja ali telefonska številka, ki jo sme uporabljati račun.
#startdestination# …
#enddestination#
section Da Seznam ene ali več ciljnih telefonskih številk.
#startcontent# …
#endcontent#
section Da Vsebina SMS sporočila.

Izbirna polja

Oznaka Vrsta Obvezno Opis
#defaultcc# string Ne Privzeta klicna številka države za lokalne številke. Privzeto 386.
#isunicode# boolean Ne true ali false. Privzeto false.
#scheduledtime# long Ne Čas načrtovanega pošiljanja v obliki Unix časovnega žiga v sekundah, npr. 1789290000.
#pricereport# boolean Ne true ali false. Privzeto false. Zahteva vključitev cene v poročilo o dostavi, kadar je na voljo.
#callbackurl# string Ne URL za poročila o dostavi SMS.

Minimalni primer e-pošte

#apikey#
12345678-1234-1234-1234-123456789abc

#sender#
Lertify

#startdestination#
040123456
#enddestination#

#startcontent#
Testno SMS sporočilo
#endcontent#

V tem primeru se številka 040123456 pretvori z uporabo privzete države 386 v +38640123456.

Celoten primer e-pošte

#apikey#
12345678-1234-1234-1234-123456789abc

#sender#
Lertify

#defaultcc#
386

#isunicode#
false

#scheduledtime#
1789290000

#pricereport#
False

#callbackurl#
https://example.com/delivery-report

#startdestination#
+38640123456
0038640987654
031555111; 041222333
#enddestination#

#startcontent#
Testno SMS sporočilo poslano prek Email2SMS.
#endcontent#

Pravila za telefonske številke

Email2SMS pred oddajo zahteve normalizira prejemnike glede na #defaultcc#. Pravila so:

  • Če se številka začne z +, ostane nespremenjena.
  • Če se začne z 00, se 00 zamenja z +.
  • Če se začne z 0, se začetna 0 odstrani in doda privzeta klicna številka države.
  • Če nima nobene od navedenih predpon, se pred številko doda privzeta klicna številka države.
  • Podvojene številke se odstranijo.

#defaultcc#
386
040123456 -> +38640123456
0038640123456 -> +38640123456
+38640123456 -> +38640123456

Po normalizaciji veljajo pravila SMS sistema. Telefonske številke morajo biti veljavne in podprte za pošiljanje; če je ciljna številka neveljavna ali nepodprta, je lahko zahteva zavrnjena.

Več prejemnikov

V razdelku za prejemnike so podprti naslednji ločilniki: nova vrstica, vejica in podpičje.

#startdestination#
040123456
040987654,031555111;+385911234567
#enddestination#

Načrtovano pošiljanje

Polje #scheduledtime# določa čas načrtovanega pošiljanja SMS sporočila. Vrednost mora biti podana kot Unix časovni žig v sekundah.

#scheduledtime#
1789290000

Če polje #scheduledtime# ni navedeno, se SMS sporočilo pošlje takoj.

Če vrednost ni veljavno celo število oziroma veljaven Unix časovni žig v sekundah, zahteva za načrtovano pošiljanje ni veljavna.

Unicode in dolžina sporočila

Polje #isunicode# določa obravnavo vsebine sporočila. Če je false, se SMS obravnava po pravilih GSM, kadar je to mogoče. Če je true, se vsebina ohrani in obdela kot Unicode.

Dovoljeno je največ 640 znakov po obdelavi vsebine.

Poročila o dostavi in cena

Z oznako #callbackurl# določite URL, kamor se pošiljajo poročila o dostavi. Z #pricereport# true zahtevate, da poročilo vključuje tudi ceno, kadar je ta na voljo. Poročila se obravnavajo po enakih pravilih kot pri Lertify SMS API.

#pricereport#
true
#callbackurl#
https://example.com/delivery-report

Avtentikacija in varnost

Email2SMS uporablja preverjanje ključa API in e-poštnega naslova pošiljatelja:

  • Ključ v #apikey# mora biti veljaven UUID.
  • Če za ključ API ni določen noben dovoljen e-poštni naslov, se lahko Email2SMS zahteva pošlje iz kateregakoli e-poštnega naslova.
  • Če je za ključ API določen en ali več dovoljenih e-poštnih naslovov, mora biti e-pošta poslana iz enega od teh naslovov.
  • Če e-poštni naslov ni dovoljen za uporabljeni ključ API, SMS sporočilo ni poslano.

Priporočilo: ključ API hranite kot skrivnost in Email2SMS uporabljajte samo iz dovoljenih e-poštnih naslovov. Ključa
API ne posredujte tretjim osebam.

Obdelava napak

Primer Obnašanje
Prazen body E-pošta se šteje kot obdelana; SMS se ne pošlje.
Manjka #apikey# ali ključ ni UUID E-pošta se šteje kot obdelana; SMS se ne pošlje.
From ni avtoriziran za API ključ E-pošta se zavrne in SMS se ne pošlje.
Manjka #sender# Pošiljatelj prejme e-pošto z napako.
Manjka destination razdelek ali nima prejemnikov Pošiljatelj prejme e-pošto z napako.
Manjka content razdelek Pošiljatelj prejme e-pošto z napako.
SMS validacija zavrne zahtevo Pošiljatelj prejme e-pošto z opisom napake.
Začasna sistemska/HTTP napaka ali timeout E-pošta ostane neoznačena kot obdelana, da jo je mogoče ponovno poskusiti.

Naslov povratnega sporočila ob validacijski napaki je: Lertify Email2SMS – Error

Sintaksa oznak

Oznake so občutljive na velike in male črke in morajo biti zapisane natančno tako, kot je določeno v dokumentaciji, torej z malimi črkami.

Pri enovrstičnih vrednostih se vrednost prebere iz naslednje vrstice za oznako.

#sender#
Lertify01

#isunicode#
false

Pri večvrstičnih razdelkih sistem prebere celotno vsebino med začetno in končno oznako.

#startcontent#
Besedilo sporočila je lahko
zapisano v več vrsticah.
#endcontent#

Enako velja za razdelek s prejemniki:

#startdestination#
+38640123456
+38640987654
#enddestination#

Za pravilno obdelavo morata biti pri večvrstičnih razdelkih vedno prisotni tako začetna kot končna oznaka.