1.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é. Parameter sa aplikuje len v prípade, ak parameter „number“ obsahuje hodnotu „all“.
startFrom	integer	Vráti záznamy od zadanej hodnoty. Parameter sa aplikuje len v prípade, ak parameter „number“ obsahuje hodnotu „all“.

Odpoveď

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

{
        "result": {
            "status": "success",
            "description": "",
            "code": "OK"
        },
        "count" : 1,
        "numbers": [{
            "number": "+XXXXXXXXXXXX", // tel. číslo
            "firstName": "", // Meno
            "lastName": "", // Priezvisko
            "isBlocked": true, // Blokované - Áno - Nie
            "createdDateTime" : "2018-04-27 10:17:53" // dátum vytvorenia záznamu
        }]
    }

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

{
        "result": {
            "status": "error",
            "description": "Relácia nebola nájdená alebo expirovala",
            "code": "SESSION_NOT_FOUND"
        }
    }