2.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/xml/sms-groups?token=XXXXXXX

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

https://api.smsgate.sk/xml/sms-groups?session_id=XXXXXXXX

Parameter	Typ	Popis
token || session_id	string	API token alebo session_id vrátené pomocou metódy auth. (Povinné)
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:

<?xml version="1.0" encoding="UTF-8" ?>
<response>
    <result>
        <status>success</status>
        <description></description>
        <code>OK</code>
    </result>
    <groups count="1">
        <number>
            <id>1000</id> // ID skupiny
            <name>success</name> // Názov skupiny
            <isPaused>false</isPaused> // Odosielanie pozastavené
            <note>Text</note> // Poznámka
        </number>
    </groups>
</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>