2.8 Blacklist

Funkcia slúži na overenie existencie telefónneho čísla na blackliste. Príkaz s použitím tokenu:

https://api.smsgate.sk/json/blacklist?token=XXXXXXX&number=xxxxx

Príkaz s použitím session ID:

https://api.smsgate.sk/json/blacklist?session_id=XXXXXXXX&number=xxxxx

Parameter	Typ	Popis
token || session_id	string	API token alebo session_id vrátené pomocou metódy auth. (Povinné)
number	string	Telefónne číslo(Povinné) Parameter povoľuje zadať aj viacero tel. čísiel, ktoré musia byť oddelené čiarkou. V prípade zadania hodnoty „all“ budú vrátené všetky čísla nachádzajúce sa v blackliste
limit	integer	Počet záznamov, ktoré budú vrátené
startFrom	integer	Vráti záznamy od zadanej hodnoty

Odpoveď

V prípade, že overenie prebehlo úspešne:

<?xml version="1.0" encoding="UTF-8" ?>
<response>
    <result>
        <status>success</status>
        <description></description>
        <code>OK</code>
    </result>
    <numbers count="1">
        <number>
            <number>+XXXXXXXXXXXX</number> // tel. číslo
            <firstName>success</firstName> // Meno
            <lastName>OK</lastName> // Priezvisko
            <isBlocked>true</isBlocked> // Blokované - Áno - Nie
            <createdDateTime>2018-04-27 10:17:53</createdDateTime> // Dátum vytvorenia záznamu
        </number>
    </numbers>
</response>
                                

V prípade chyby (príklad s konkrétnou chybou):

<?xml version="1.0" encoding="UTF-8" ?>
<response>
    <result>
	<status>error</status>
	<description>Relácia nebola nájdená alebo expirovala</description>
	<code>SESSION_NOT_FOUND</code>
    </result>
</response>