Hsdn - sms feldolgozó központ

API dokumentáció

üzenetek fogadása

Annak érdekében, hogy a projekt, amely kapcsolódik a szolgáltatáshoz, képes volt üzeneteket fogadni, arra van szükség, hogy szervezzen egy speciális felhasználói felület (API), és helyezzük egy webszervert.

sessionid - egyedi változó érték, amely azonosítja a kérelmet. A paraméter értéke megváltozik minden kérését.

prefix - Az előtag (kulcsszó), amelyek elismerését készült az üzenetet. Az előtag érvénytelen abban az esetben, hogy az üzenetet megkapta projekt segítségével egy külön szolgáltatás számát.

szöveg - a szöveg UTF-8. tartalmazza a kapott üzenetet, kivéve az előtag. Ha az üzenet érkezett projekt segítségével egy külön szolgáltatás számát, az ezen paraméter értéke azonos a paraméter szöveges.

Kulcsszavas - szöveg UTF-8. tartalmazza a fogadott üzenet tartalmazza az előtag.

Kézhezvételét és feldolgozása lekérdezések, egyedi API szolgáltatást köteles tájékoztatni a művelet sikerét, visszatérve a szöveget tartalmazó speciális címkét:

Ezen kívül lehetőség van, hogy küldjön egy válaszüzenetet a feladónak felszólítás nélkül a szolgáltatást. Ehhez egy egyedi API vissza kell térnie az üzenetet mellékelt speciális címkék:

A szöveg a válaszüzenetet

válasz üzenet szövegét hossza legfeljebb 765 karakter, ha az üzenet tartalmaz csak betűket és szimbólumokat 335, ha az üzenet tartalmaz cirill.

Abban az esetben, ha egy kielégítő választ nem kapott a API felhasználó, a szolgáltatás megkísérli küldeni a kérelmet ismét újabb 150 alkalommal 10 perces időközönként, ami után az üzenet törlődik a sorból.

Vegye figyelembe, hogy ha a projekt ellenőrzése a prefix, írja be azt az üzenet szövegét szükséges. Az előtag hozzáadjuk a szöveges üzeneteket automatikusan.

Az alábbiakban egy példa végrehajtása a felhasználó API a PHP programozási nyelv.

Egy példa a felhasználói API a PHP

/ *
projectmd5 - MD5 hash kérés
sessionid - Session ID
projectid - Projekt azonosító
vevő - Szolgáltatás száma
feladó - a küldő száma
prefix - Az előtag a projekt
szöveg - A szöveges üzenetek (nincs prefix)
Kulcsszavas - teljes üzenet szövege
* /

// Hash titkos API-kulcs
$ Apikeymd5 = '53f28c002c7e258540a2038300045804'; // MD5 ( 'MyApiKey')

// Az adatok érvényesítése
if (! isset ($ _POST [ 'projectmd5'])
VAGY! Isset ($ _POST [ 'sessionid'])
VAGY! Isset ($ _POST [ 'projectid'])
VAGY! Isset ($ _POST [ 'vevő'])
VAGY! Isset ($ _POST [ 'küldő'])
VAGY! Isset ($ _POST [ 'előtag'])
VAGY! Isset ($ _POST [ 'szöveges'])
VAGY! Isset ($ _POST [ 'text']))
// Küldés érvényesítési hiba
exit ( 'ellenőrzési hiba');
>

// hash-ellenőrzése
if (md5 ($ apikeymd5
. $ _POST [ 'sessionId']
. $ _POST [ 'projectid']
. $ _POST [ 'vevő']
. $ _POST [ 'küldő']
. $ _POST [ 'szöveges'])! = $ _POST [ 'projectmd5'])
// Küldjön egy hash hiba
exit ( 'Hash hiba');
>

// Üzenetfeldolgozás
$ Response = folyamat ($ _POST [ 'küldő'], $ _POST [ 'előtag'], $ _POST [ 'szöveg']);

// küldése a válaszüzenetet
exit ($ response);

// üzenet feldolgozása funkció
függvény eljárást ($ feladó. $ prefix. $ text)
// A válaszüzenet
visszatérés "A szöveg a válaszüzenetet„
>

küld egy üzenetet

Bejelentkezés - User ID regisztrálva a szolgáltatást.

passwordhash - md5 hash-t a jelszava regisztrált felhasználó.

szöveg - a szöveges üzenetet kell küldeni. A szöveg hossza korlátozódik 765 karakter, ha az üzenet tartalmaz csak betűket és szimbólumokat 335, ha az üzenet tartalmaz cirill.

A szöveges üzenetek kell átadni az UTF-8. egyébként interfész hibakód 21 vissza.

Elküldése után a kérelem annak ellenőrzésére, ami után a program visszatér szolgáltatási felület állapotát kód működését. Ha a kód került vissza a művelet 20 üzenetet küldeni tekinthető sikeresnek. Más esetekben a felület visszaadja a megfelelő kódot a hibák alább ismertetett

Száma kimenő kérések nem haladhatja meg a 10 1 percig. Túllépése esetén a megengedhető küldött üzenetek száma, a felület vissza hibakódot 22.

Az alábbiakban egy példát végrehajtása iránti kérelmet küld a szoftver szolgáltatás interfész segítségével a PHP programozási nyelv.

Példa küld üzeneteket a szolgáltató API a PHP

$ POSTDATA = array
(
// Bejelentkezés
„Bejelentkezés” => „felhasználónév név”

// Hash jelszó
'Passwordhash' => '48503dfd58720bd5ff35c102065a52d7'. // MD5 ( 'SajátJelszó')

// Service száma
'Vevő' => '+70000000000',

// száma a címzett
'Címzett' => '+79012345678',

// Üzenet
'Text' => urlencode ( 'SMS-üzenet')
);

// inicializálása a curl
$ Ch = curl_init ();

// Set CURL lehetőségek
curl_setopt ($ ch CURLOPT_URL $ apiaddress ..);
curl_setopt ($ ch CURLOPT_POST igaz ..);
curl_setopt ($ ch CURLOPT_POSTFIELDS $ POSTDATA ..);
curl_setopt ($ ch CURLOPT_RETURNTRANSFER igaz ..);

// egy ajánlatot
$ Status = curl_exec ($ ch);

// bezárása CURL
curl_close ($ ch);

// Ellenőrizze az eredményt elküldi
if ($ status! = 20)
// Hiba a küldés közben
exit ( 'Send error:' $ állapotát.);
>

// küldése sikeres
exit ( 'Send OK');