1. Home
  2. Docs
  3. SMS API popis
  4. 1. JSON
  5. 1.9 SMS Skupiny

1.9 SMS Skupiny

Funkcia slúži na získanie zoznamu všetkých SMS kadenčných skupín. Príkaz s použitím tokenu:

https://api.smsgate.sk/json/sms-groups?token=XXXXXXX&number=xxxxx

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

https://api.smsgate.sk/json/sms-groups?session_id=XXXXXXXX&number=xxxxx
ParameterTypPopis
token || session_idstringAPI token alebo session_id vrátené pomocou metódy auth. (Povinné)
limitintegerPočet záznamov, ktoré budú vrátené. Parameter sa aplikuje len v prípade, ak parameter „number“ obsahuje hodnotu „all“.
startFromintegerVrá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,
        "groups": [{
            "id": 1000, // ID skupiny
            "name": "Group name", // Názov skupiny
            "isPaused": false, // Odosielanie pozastavené
            "note": "Text", // Poznámka
        }]
    }

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"
        }
    }