API
Ez a szakasz az SMS küldési szolgáltatás és az alkalmazás / weboldal integrálásának műszaki dokumentációja. Az API használatához szükséges token megszerzéséhez fiókot kell létrehoznia.
SMS küldés
SMS küldéséhez vagy ütemezéséhez POST módszerrel kell kérnie a következő címet: https://www.smsadvert.ro/api/sms/ type application/json
Példa az SMS küldésére a saját eszközével
Az SMS kézbesítése azonnal megtörténik, kérését követően.
POST https://www.smsadvert.ro/api/sms/ HTTP/1.1
Authorization: {API_AUTH_TOKEN}
Content-Type: application/json
{
"phone": "+40740123456",
"shortTextMessage": "Ez az SMS üzenet tartalma"
}
Példa az SMS küldésre a saját eszközeivel a feladatátvételi funkcióval
Ha nincs saját csatlakoztatott eszköze, vagy ha a GSM-szolgáltató hibaüzenettel válaszol, az SMS smsadvert.ro hálózaton keresztül kerül elküldésre
POST https://www.smsadvert.ro/api/sms/ HTTP/1.1
Authorization: {API_AUTH_TOKEN}
Content-Type: application/json
{
"phone": "+40740123456",
"shortTextMessage": "Ez az SMS üzenet tartalma",
"failover": "short"
}
Példa az SMS küldésére smsadvert.ro hálózaton keresztül
Az SMS kézbesítése azonnal megtörténik, kérését követően.
POST https://www.smsadvert.ro/api/sms/ HTTP/1.1
Authorization: {API_AUTH_TOKEN}
Content-Type: application/json
{
"phone": "+40740123456",
"shortTextMessage": "Ez az SMS üzenet tartalma",
"sendAsShort": true
}
Példa az SMS menetrend küldésére
Az SMS kézbesítése a startDate és a endDate paraméterek szerint történik.
POST https://www.smsadvert.ro/api/sms/ HTTP/1.1
Authorization: {API_AUTH_TOKEN}
Content-Type: application/json
{
"phone": "+40740123456",
"shortTextMessage": "Ez az SMS üzenet tartalma",
"startDate": 1486883578036,
"endDate": 1486889778036
}
Példa SMS küldésre több címzetttel
Az SMS kézbesítése a címzetteknek egyenként, közvetlenül a kérés után.
POST https://www.smsadvert.ro/api/sms/ HTTP/1.1
Authorization: {API_AUTH_TOKEN}
Content-Type: application/json
{
"phone": "+40740123456,+40740123457,+40740123458",
"shortTextMessage": "Ez az SMS üzenet tartalma"
}
Példa az SMS küldésére a kézbesítési jelentés visszahívásával
Az SMS kézbesítése azonnal megtörténik, kérését követően. Ezután a callback paramétertől a kézbesítési jelentéssel kap egy kérést a címre.
POST https://www.smsadvert.ro/api/sms/ HTTP/1.1
Authorization: {API_AUTH_TOKEN}
Content-Type: application/json
{
"phone": "+40740123456",
"shortTextMessage": "Ez az SMS üzenet tartalma",
"callback": "http://yourwebsite.com/callback-url/"
}
A paraméterek leírása
phone
string, kötelező- Ez jelzi a címzett telefonszámát.
A számnak nemzetközi formátumban kell lennie E.164 (Például: +40740123456)
Több címzett esetén vesszővel elválasztva is megadhatja telefonszámát, pl. "+40740123456,+40740123457".
Legfeljebb 1000 telefonszám, és a másolatot tartalmazó számok nem kerülnek rögzítésre benyújtás céljából.
Figyelem! A vesszőt nem fogadjuk el a lista végén.
shortTextMessage
string, kötelező- Ez az SMS üzenet tartalmát képviseli, és legalább 3 és legfeljebb 480 karakterből áll.
sendAsShort
boolean, választható- Az SMS smsadvert.ro hálózaton keresztüli küldéséhez ennek a paraméternek true értéket kell tartalmaznia. Abban az esetben, ha ennek a paraméternek false értéke van, vagy nem létezik, akkor az üzenetet a készülékén keresztül küldi el.
startDate
integer, választható- Ez a dátum / óra / perc / másodperc, amely után megkezdődik az üzenet küldése. A formátum UNIX idő (ezredmásodperc).
endDate
integer, választható- Ez a dátum / óra / perc / másodperc, amely után az üzenet küldése leáll. A formátum UNIX idő (ezredmásodperc).
failover
string, választható- Ez a másodlagos küldő csatornát képviseli.
Ha az üzenetet nem lehet az eszközödön keresztül továbbítani (legalább egy csatlakoztatott eszköz nincs, vagy a GSM-szolgáltató hibaüzenettel válaszol), akkor a küldést a másodlagos csatornán próbálják meg tenni.
Ha a a failover paraméter értéke "short", akkor az SMS smsadvert.ro hálózaton keresztül kerül elküldésre.
callback
string, választható- A webcímet (URL) képviseli, ahol kérést kap az üzenet kézbesítésének állapotáról.
A kérelem POST (application/json) típusú és két paramétert tartalmaz: status, "delivered" vagy értékkel "failed" és msgId annak az üzenetnek az azonosítóját jelöli, amelyben a küldési kérés válaszként kapta meg azt.Példa a visszahívási URL-címre kapott kérésre
POST http://yourwebsite.com/callback-url/ HTTP/1.1 Content-Type: application/json { "status": "delivered", "msgId": "xxxxxx" }
Válasz
A kérelemhez kapott válasz application/json típusú.
Példa a sikeres válaszra
{
"successMessage": "Your message has been successfully submitted!",
"msgId": "xxxxxx"
}
Példák a hibaelhárításra
{
"errors": {
"phone": "Érvénytelen telefonszám!",
"shortTextMessage": "Írjon be legalább 3 karaktert!"
}
}
{
"errorMessage": "There was a database error!"
}