HTTPS XML API / Zarządzanie kontaktami i grupami
System umożliwia zdalne zarządzanie kontaktami z wykorzystaniem HTTPS XML API. Możliwe operacje na kontaktach to: listowanie grup, listowanie kontaktów w grupach, dodawanie kontaktów oraz grup oraz usuwanie kontaktów lub grup.
Listowanie grup
Wywołanie adresu
Aby przy pomocy zdalnej obsługi wylistować grupy należy wywołać określony adres URL metodą POST lub GET. Przykładowo adres w przeglądarce wyglądać może następująco:
https://api1.serwersms.pl/zdalnie/index.php?login=demo&haslo=demo&akcja=kontakty&operacja=lista_grup
Dostępne parametry
| Parametr | Typ | Przykładowa wartość lub format | Opis |
|---|---|---|---|
| akcja | String | kontakty | Wartość odpowiadająca zarządzaniu kontaktami i grupami |
| login | String | Login | Login konta |
| haslo | String | Haslo | Hasło konta |
| operacja | String | lista_grup | Wartość taka pozwoli wylistować grupy |
Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.
Zwrot odpowiedzi
Wywołanie powyższego adresu może wygenerować np. taką odpowiedź:
<?xml version="1.0" encoding="UTF-8"?>
<SerwerSMS login="demo">
<GRUPA id="17256254" ilosc="1">
<NAZWA>test API</NAZWA>
</GRUPA>
<GRUPA id="17244370" ilosc="118">
<NAZWA>2012-02-20 11:54:20 iOS</NAZWA>
</GRUPA>
<GRUPA id="17230284" ilosc="4">
<NAZWA>Grupa spersonalizowana</NAZWA>
</GRUPA>
</SerwerSMS>
Objaśnienie poszczególnych sekcji XML
| Znacznik XML | Opis |
|---|---|
| <GRUPA id="ID" ilosc="ILE"> <NAZWA>NAZWA_GRUPY</NAZWA> </GRUPA> |
Parametr „ID” określa identyfikator grupy, „ILE” określa ile kontaktów jest przypisanych do grupy natomiast w tagu <NAZWA> znajduje się nazwa grupy w formie stringa. |
Listowanie kontaktów w grupach
Wywołanie adresu
Aby przy pomocy zdalnej obsługi wylistować kontakty przypisane do wybranej grupy, należy wywołać określony adres URL metodą POST lub GET. Przykładowo adres w przeglądarce wyglądać może następująco:
https://api1.serwersms.pl/zdalnie/index.php?login=demo&haslo=demo&akcja=kontakty&operacja=lista_kontaktow&grupa=17230284
Dostępne parametry
| Parametr | Typ | Przykładowa wartość lub format | Opis |
|---|---|---|---|
| akcja | String | kontakty | Wartość odpowiadająca zarządzaniu kontaktami i grupami |
| login | String | Login | Login konta |
| haslo | String | Haslo | Hasło do konta |
| operacja | Integer | lista_kontaktow | Wartość taka pozwoli wylistować grupy |
| grupa | Integer | np. 459678754 lub „nieprzypisane” | Identyfikator cyfrowy w formie numerycznej lub wartość „nieprzypisane” aby pokazać nieprzypisane do grup kontakty. |
Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.
Zwrot odpowiedzi
Wywołanie powyższego adresu może wygenerować np. taką odpowiedź:
<?xml version="1.0" encoding="UTF-8"?>
<SerwerSMS login="demo">
<GRUPA id="17230284" ilosc="2">
<NAZWA>Personalizacja</NAZWA>
<KONTAKT id="75356907">
<TELEFON>+48500600700</TELEFON>
<EMAIL>email@adres.pl</EMAIL>
<FIRMA>Firma sp. z o.o.</FIRMA>
<IMIE>Jan</IMIE>
<NAZWISKO>Kowalski</NAZWISKO>
</KONTAKT>
<KONTAKT id="75356908">
<TELEFON>+48600500400</TELEFON>
<EMAIL></EMAIL>
<FIRMA></FIRMA>
<IMIE></IMIE>
<NAZWISKO></NAZWISKO>
</KONTAKT>
</GRUPA>
</SerwerSMS>
Objaśnienie poszczególnych sekcji XML
| Znacznik XML | Opis |
|---|---|
| <GRUPA id="IDG" ilosc="ILE"> <NAZWA>NAZWA_GRUPY</NAZWA> <KONTAKT id="IDK"> <TELEFON>NUM</TELEFON> <EMAIL>MAIL</EMAIL> <FIRMA>FIRMA</FIRMA> <IMIE>IMIE</IMIE> <NAZWISKO>NAZWISKO</NAZWISKO> </KONTAKT> </NADAWCA> |
Tag GRUPA zawiera atrybuty IDG określające identyfikator grupy oraz ILE mówiący ile kontaktów jest w grupie. Dodatkowo parametr NAZWA_GRUPY określa alfanumeryczną nazwę grupy a poniższe wartości określają kolejne pola jak imię, nazwisko, adres email itp. |
Tworzenie grup
Wywołanie adresu
Aby przy pomocy zdalnej obsługi utworzyć nową grupę, należy wywołać określony adres URL metodą POST lub GET. Przykładowo adres w przeglądarce wyglądać może następująco:
https://api1.serwersms.pl/zdalnie/index.php?login=demo&haslo=demo&akcja=kontakty&operacja=dodaj_grupe&grupa=testowa
Dostępne parametry
| Parametr | Typ | Przykładowa wartość lub format | Opis |
|---|---|---|---|
| akcja | String | kontakty | Wartość odpowiadająca zarządzaniu kontaktami i grupami |
| login | String | Login | Login konta |
| haslo | String | Haslo | Hasło do konta |
| operacja | String | dodaj_grupe | Wartość taka pozwoli utworzyć nową grupę kontaktów |
| grupa | String | np. „nowa grupa” | Nazwa alfanumeryczna opisująca grupę. Maksymalnie 100 znaków. |
Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.
Zwrot odpowiedzi
Wywołanie powyższego adresu może wygenerować np. taką odpowiedź:
<?xml version="1.0" encoding="UTF-8"?>
<SerwerSMS login="demo">
<GRUPA id="17256255">OK</GRUPA>
</SerwerSMS>
Objaśnienie poszczególnych sekcji XML
| Znacznik XML | Opis |
|---|---|
| <GRUPA id="ID">STAN</GRUPA> | Tag GRUPA zawiera w atrybucie identyfikator grupy. Wartość w tagu GRUPA określa stan akcji który może przyjąć wartości OK (jeśli grupa została utworzona) lub ERR (w przypadku wystąpienia błędu) |
Tworzenie kontaktów
Wywołanie adresu
Aby przy pomocy zdalnej obsługi dodać kontakt do wybranej grupy, należy wywołać określony adres URL metodą POST lub GET. Przykładowo adres w przeglądarce wyglądać może następująco:
https://api1.serwersms.pl/zdalnie/index.php?login=demo&haslo=demo&akcja=kontakty&operacja=dodaj_kontakt&dane=17256254:500600700:jasio%40sms.pl:jasio:kowalski
Dostępne parametry
| Parametr | Typ | Przykładowa wartość lub format | Opis |
|---|---|---|---|
| akcja | String | kontakty | Wartość odpowiadająca zarządzaniu kontaktami i grupami |
| login | String | Login | Login konta |
| haslo | String | Haslo | Hasło do konta |
| operacja | String | dodaj_kontakt | Wartość taka pozwoli utworzyć nowy kontakt |
| dane | String | Format danych: id_grupy:telefon:email:imie:nazwisko:firma | Zmienna dane, powinna zawierać odpowiednio poukładane dane takie jak id grupy, numer itp. Jeśli np. pole email nie zawiera informacji, należy zostawić je puste jednak trzeba zachować kolejność znaków „:”. Jeśli kontakt ma być przypisany do kilku grup, grupy należy podać po przecinku. Maksymalnie 20 znaków dla pola telefon oraz 255 znaków dla każdego pozostałych pól. |
Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.
Zwrot odpowiedzi
Wywołanie powyższego adresu może wygenerować np. taką odpowiedź:
<?xml version="1.0" encoding="UTF-8"?>
<SerwerSMS login="demo">
<KONTAKT id="92890613">OK</KONTAKT>
</SerwerSMS>
Objaśnienie poszczególnych sekcji XML
| Znacznik XML | Opis |
|---|---|
| <KONTAKT id="ID">STAN</KONTAKT> | Tag KONTAKT zawiera w atrybucie identyfikator wpisu. Wartość w tagu KONTAKT określa stan akcji który może przyjąć wartości OK (jeśli kontakt został utworzony) lub ERR (w przypadku wystąpienia błędu) |
Usuwanie grup
Wywołanie adresu
Aby przy pomocy zdalnej obsługi usunąć grupę, należy wywołać określony adres URL metodą POST lub GET. Przykładowo adres w przeglądarce wyglądać może następująco:
https://api1.serwersms.pl/zdalnie/index.php?login=demo&haslo=demo&akcja=kontakty&operacja=usun_grupe&grupa=17256255
Dostępne parametry
| Parametr | Typ | Przykładowa wartość lub format | Opis |
|---|---|---|---|
| akcja | String | kontakty | Wartość odpowiadająca zarządzaniu kontaktami i grupami |
| login | String | Login | Login konta |
| haslo | String | Haslo | Hasło do konta |
| operacja | String | usun_grupe | Wartość taka pozwoli usunąć grupe |
| grupa | Integer | Identyfikator grupy np. 12345689 | Identyfikator grupy do usunięcia. Uwaga, podczas usuwania grupy kontakty do niej przypisane nie są usuwane. |
Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.
Zwrot odpowiedzi
Wywołanie powyższego adresu może wygenerować np. taką odpowiedź:
<?xml version="1.0" encoding="UTF-8"?>
<SerwerSMS login="demo">
<GRUPA id="17256255">OK</GRUPA>
</SerwerSMS>
Objaśnienie poszczególnych sekcji XML
| Znacznik XML | Opis |
|---|---|
| <GRUPA id="ID">STAN</GRUPA> | Tag GRUPA zawiera w atrybucie identyfikator wpisu. Wartość w tagu GRUPA określa stan akcji który może przyjąć wartości OK (jeśli grupa została usunięta) lub ERR (w przypadku wystąpienia błędu) |
Usuwanie kontaktów
Wywołanie adresu
Aby przy pomocy zdalnej obsługi usunąć kontakt, należy wywołać określony adres URL metodą POST lub GET. Przykładowo adres w przeglądarce wyglądać może następująco:
https://api1.serwersms.pl/zdalnie/index.php?login=demo&haslo=demo&akcja=kontakty&operacja=usun_kontakt&kontakt=66673590
Dostępne parametry
| Parametr | Typ | Przykładowa wartość lub format | Opis |
|---|---|---|---|
| akcja | String | kontakty | Wartość odpowiadająca zarządzaniu kontaktami i grupami |
| login | String | Login | Login konta |
| haslo | String | Haslo | Hasło do konta |
| operacja | String | usun_kontakt | Wartość taka pozwoli usunąć kontakt |
| kontakt | Integer | Identyfikator kontaktu np. 12345689 | Identyfikator kontaktu do usunięcia. |
Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.
Zwrot odpowiedzi
Wywołanie powyższego adresu może wygenerować np. taką odpowiedź:
<?xml version="1.0" encoding="UTF-8"?>
<SerwerSMS login="demo">
<KONTAKT id="66673590">OK</KONTAKT>
</SerwerSMS>
Objaśnienie poszczególnych sekcji XML
| Znacznik XML | Opis |
|---|---|
| <KONTAKT id="ID">STAN</KONTAKT> | Tag KONTAKT zawiera w atrybucie identyfikator wpisu. Wartość w tagu KONTAKT określa stan akcji który może przyjąć wartości OK (jeśli kontakt został usunięty) lub ERR (w przypadku wystąpienia błędu) |