SOAP API dokumentáció

SMS küldő 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