API Dokumentáció

Az SMS küldési szolgáltatásunk lehetővé teszi, hogy vállalkozásod gyorsan és hatékonyan kommunikáljon ügyfeleivel SMS-ek segítségével. API megoldásaink SOAP és REST protokollokon keresztül elérhetők, így rugalmasan integrálhatók különböző rendszerekbe. Az alábbiakban bemutatjuk a szolgáltatásainkat és a szükséges kapcsolódási lehetőségeket.

API Kapcsolódási Lehetőségek

1. SOAP API Kapcsolódás

Szolgáltatásunkhoz SOAP protokollon keresztül is csatlakozhat, amely stabil és megbízható integrációs megoldást kínál.
A SOAP API dokumentáció blokkban megtalálhatók a függvények, amelyek segítségével teljes körű SMS szolgáltatást nyújtunk.

2. REST API Kapcsolódás

A RESTful API megoldásunk könnyen használható és modern interfészt biztosít a rendszerek közötti kommunikációhoz.
A REST API segítségével gyorsan és egyszerűen kezelheti az SMS küldési folyamatokat.
A REST API dokumentáció blokkban megtalálhatók a függvények, amelyek segítségével teljes körű SMS szolgáltatást biztosítunk.

3. Harmadik Fél Által Nyújtott API Megoldások

A hazai és nemzetközi piacon elérhető SMS szolgáltatók megoldásainak API kapcsolódásai elérhető nálunk is. Ezzel szeretnénk segíteni téged és vállalkozásod, hogy a szolgáltató váltás egyszerű és zökkenőmentes lehessen.

SOAP API Dokumentáció

A SOAP API (Simple Object Access Protocol) egy megbízható és jól szabványosított protokoll, amely lehetővé teszi a rendszerek közötti biztonságos kommunikációt. Szolgáltatásunk SOAP alapú API-ján keresztül kényelmesen integrálhatja az SMS küldési funkciókat vállalkozása belső rendszereibe. A SOAP XML alapú kommunikációt használ, amely biztosítja az adatok egységes és struktúrált formában történő cseréjét.

Az API-nk segítségével hitelesítési műveletek, SMS küldések, és az SMS státuszok lekérdezése egyaránt elvégezhető. Az integráció során a rendszer először a connect függvény segítségével csatlakozik, ahol hitelesíti a felhasználót. Ezt követően különböző funkciókat érhet el, például az SMS küldési kreditek ellenőrzését (getCreditNumber) vagy az SMS státuszának figyelését (getStatus).

A SOAP API stabilitása és megbízhatósága miatt különösen hasznos azoknak a vállalkozásoknak, akik kifinomult vagy nagy terhelést jelentő rendszerekbe szeretnék beépíteni az SMS szolgáltatást. Mivel a SOAP szabvány biztosítja az adatok megfelelő formátumát, és a hálózati biztonságot is magas szinten kezeli, ideális választás lehet pénzügyi, egészségügyi és egyéb érzékeny adatokat kezelő rendszerek számára.

A simpleSMS SOAP API:

végpontja: a https://api.simplesms.hu/sms.wsdl url-en belül érhető el.
php példakódot innen tudsz letölteni

SOAP APIn elérhető végpontok

1. Kapcsolódás

Minden további SOAP metódus hívásához szükséges a kapcsolódás, ha nincs kapcsolódás vagy sikertelen volt a további kérések hibaüzenettel kerülnek elutasításra.

connect($userName, $userPassword, $domainName)

Paraméterek:

userName: a simplesms portálon az API hozzáféréseknél megadott felhasználónév
userPassword: a simplesms portálon az API hozzáféréseknél megadott jelszó
domainName: a simplesms portálon az API hozzáféréseknél megadott jelszó

Visszatérési érték:

mindig egy tömböt adunk vissza
sikeres üzenet esetén success értéke true, míg az error értéke false
hibás válasz esetén logikusan fordított a két értéke (success false, error true). Valamint az api egy hiba kódot és hiba üzenetet is visszaad

2. SMS küldés

sendSMS($strCountryCode, $strAreaCode, $strNumber, $strMessage)

Paraméterek:

strCountryCode: az ország hívószáma (pl Magyarország 36)
strAreaCode: a szolgáltató kódja (pl Telekom 30, Yettel 20, Vodafone 70, Digi 50...)
strNumber: a telefonszám további része (pl 1234567)
strMessage: a kiküldésre szánt SMS tartalma

Visszatérési érték:

sikeres üzenet esetén a response értékben adjuk vissza az sms belső azonosítóját amivel később a státuszok vagy hisztorikus információk lekérhetők
hibás válasz esetén a hibaüzenetet és a hiba kódját adja vissza a végpont

3. Egyenleg lekérdezése

getCreditNumber()

Paraméterek nincsennek

Visszatérési érték:

sikeres érték esetén a visszakapott tömbben reponse mező értéke tartalmazza az elérhető egyenleget
hiba esetén hibakódot és hibaüzenetet ad vissza az API végpont

4. Havi statisztika lekérdezése

getMonthlyStat()

Paraméterek nincsennek

Visszatérési érték:

sikeres érték esetén a visszakpott tömbben a havi statisztika egy tömbben kerül visszaadásra ÉÉÉÉ-HH bontásban külön a belföldi és külföldi sms számokkal.
hiba esetén hibakódot és a hibaüzenetet ad vissza az API végpont

5. SMS státusz

A rendszer lehetőséget nyújt az aktuális státusz lekérdezésére

getStatus($numSMSID)

Paraméterek:

numSMSID a sendSMS által visszaadott SMS belső azonosítója

Visszatérési érték:

sikeres kérés esetén a választ a visszaadott tömb reponse mezője tartalmazza, itt minden információ megtalálható az SMSsel kapcsolatban
- küldéskor megadott adatok
- létrehozás ideje
- küldési státusz
- utolsó státusz változás ideje
hiba esetén a megszokott hibakód és hibaüzenet párost adja vissz az api

6. SMS státusz történet

A rendszer lehetőséget nyújt az SMS státusz változásainak lekérdezésére

getHistory($numSMSID)

Paraméterek:

numSMSID a sendSMS által visszaadott SMS belső azonosítója

Visszatérési érték:

sikeres kérés esetén a választ a visszaadott tömb reponse mezője tartalmazza, itt minden információ megtalálható az SMSsel kapcsolatban
- utolsó státusz adatok (kód, üzenet, dátum, egyes típusok esetén megjegyzés)
hiba esetén a megszokott hibakód és hibaüzenet párost adja vissz az api

REST API Dokumentáció

A REST API (Representational State Transfer) egy modern, könnyen használható webes szolgáltatás, amely lehetővé teszi az egyszerű és gyors kommunikációt rendszerek között. A REST API JSON vagy XML alapú adatcserét használ, amely sok fejlesztő számára ismerős és könnyen feldolgozható, így egyszerűen integrálható bármilyen fejlesztői környezetbe. A REST API-nk rugalmas és jól skálázható megoldást kínál az SMS küldési és menedzsment funkciókhoz.

A REST API-t HTTP metódusokon keresztül érheti el, mint például a POST, GET és DELETE. A hitelesítési folyamat a connect függvény segítségével történik, ahol az API-t használó felhasználó token alapú hitelesítést kap. Ezt követően az API-n keresztül le lehet kérdezni az SMS küldési krediteket (getCreditNumber), lekérhetők a havi statisztikák (getMonthlyStat), vagy éppen elindítható egy SMS küldés a sendSMS függvénnyel.

A REST API egyszerűsége és gyorsasága miatt kiváló választás a fejlesztők számára, különösen azoknak, akik rugalmas, webes megoldásokban gondolkodnak. Ideális választás lehet különféle platformokhoz, mobilalkalmazásokhoz vagy más webes rendszerekhez történő integrációhoz. A REST API-nk segítségével a vállalkozások hatékonyan kezelhetik SMS kampányaikat, értesítéseiket, és valós időben követhetik a küldött üzenetek státuszát, mindezt gyors és egyszerű módon.

A simpleSMS REST API

végpontja a https://api.simplesms.hu/rest/SMSapi/ url-en belül érhető el.
Rest api hívások postmanben itt tölthetők le

1. Kapcsolódás: connect (https://api.simplesms.hu/rest/SMSapi/connect)

Minden további REST API metódus hívásához szükséges a kapcsolódás, ha nincs kapcsolódás vagy sikertelen volt a további kérések hibaüzenettel kerülnek elutasításra.

Az itt kapott access_tokent bearer tokenként használva lehet a további metódusokat elérni.

Paraméterek: a paramétereket a hívás POSTként várja

username: a simplesms portálon az API hozzáféréseknél megadott felhasználónév
password: a simplesms portálon az API hozzáféréseknél megadott jelszó
domain: a simplesms portálon az API hozzáféréseknél megadott jelszó

Visszatérési érték:

mindig egy tömböt adunk vissza
sikeres üzenet esetén visszaadott értékek:
- access_token: ezt szükséges használni a további metódusok hívásánál
- expires_in: a token lejáratának ideje
hibás válasz esetén hibaüzenetet ad vissza a végpont

2. SMS küldés: sendSMS

Végpont: https://api.simplesms.hu/rest/SMSapi/sendSMS

Paraméterek: a paramétereket ez a hívás is POSTként várja

country_code: az ország hívószáma (pl Magyarország 36)
area_code: a szolgáltató kódja (pl Telekom 30, Yettel 20, Vodafone 70, Digi 50...)
number: a telefonszám további része (pl 1234567)
message: a kiküldésre szánt SMS tartalma

Visszatérési érték:

sikeres üzenet esetén a response értékben adjuk vissza az sms belső azonosítóját amivel később a státuszok vagy hisztorikus információk lekérhetők
hibás válasz esetén a hibaüzenetet ad vissza a végpont

3. Egyenleg lekérdezése: getCreditNumber

Végpont: https://api.simplesms.hu/rest/SMSapi/getCreditNumber

Paraméterek nincsennek

Visszatérési érték:

sikeres érték esetén a visszakapott tömbben reponse mező értéke tartalmazza az elérhető egyenleget
hiba esetén hibaüzenetet ad vissza az API végpont

4. Havi statisztika lekérdezése: getMonthlyStat

Végpont: https://api.simplesms.hu/rest/SMSapi/getMonthlyStat

Paraméterek nincsennek

Visszatérési érték:

sikeres érték esetén a visszakpott tömbben a havi statisztika egy tömbben kerül visszaadásra ÉÉÉÉ-HH bontásban külön a belföldi és külföldi sms számokkal.
hiba esetén hibaüzenetet ad vissza az API végpont

5. SMS státusz: getStatus

Végppont: https://api.simplesms.hu/rest/SMSapi/getStatus

A rendszer lehetőséget nyújt az aktuális státusz lekérdezésére

Paraméterek: a paraméteret POST-ként várja az api hívás

sms_id: a sendSMS által visszaadott SMS belső azonosítója

Visszatérési érték:

sikeres kérés esetén a választ a visszaadott tömb reponse mezője tartalmazza, itt minden információ megtalálható az SMSsel kapcsolatban
- küldéskor megadott adatok
- létrehozás ideje
- küldési státusz
- utolsó státusz változás ideje
hiba esetén a hibaüzenetet adja vissz az api

6. SMS státusz történet: getHístory()

Végpont: https://api.simplesms.hu/rest/SMSapi/getHistory

A rendszer lehetőséget nyújt az SMS státusz változásainak lekérdezésére

Paraméterek: a paramétert POST-ként várja az api hívás

sms_id: a sendSMS által visszaadott SMS belső azonosítója

Visszatérési érték:

sikeres kérés esetén a választ a visszaadott tömb reponse mezője tartalmazza, itt minden információ megtalálható az SMSsel kapcsolatban
- utolsó státusz adatok (kód, üzenet, dátum, egyes típusok esetén megjegyzés)
hiba esetén a hibaüzenet adja vissz az api

További részletekért és az integrációk beállításához kérjük, tekintse át az API dokumentáció teljes tartalmát, vagy lépjen kapcsolatba velünk, ha kérdése van!