HTTPS API v2 / Zarządzanie kontaktami i grupami

System umożliwia zdalne zarządzanie kontaktami z wykorzystaniem  HTTPS API. Możliwe operacje na kontaktach to: listowanie grup, listowanie kontaktów w grupach, dodawanie, edycja,usuwanie kontaktów oraz grup.

Listowanie grup

Wywołanie adresu

Aby przy pomocy zdalnej obsługi wylistować grupy należy wywołać określony adres URL metodą POST.

groups/index

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
username	String	Login	Login użytkownika API.
password	String	Haslo	Hasło użytkownika API.
search	String	szukana fraza	Wyszukiwanie po nazwie grupy.
sort	String	name	Parametr opcjonalny umożliwiający sortowanie danych według nazwy grupy.
order	String	asc|desc	Parametr opcjonalny umożliwiający zmianę kolejności sortowania.

Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.

Zwrot odpowiedzi

{
   "items":[{
      "id":17293087,
      "name":"Test API",
      "count":322
   },
   {
      "id":17293086,
      "name":"2014-10-20 11:54:20",
      "count":2
   }]
}

Listowanie kontaktów

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.

contacts/index

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
username	String	Login	Login użytkownika API.
password	String	Haslo	Hasło użytkownika API.
search	String	szukana fraza	Wyszukiwanie wśród kontaktów posiadających daną frazę.
group_id	Integer|String	np. 459678754 lub „none”	Identyfikator cyfrowy w formie numerycznej lub wartość „none” aby pokazać nieprzypisane do grup kontakty.
sort	String	first_name|last_name|phone|company|tax_id|email|address|city|description	Parametr opcjonalny umożliwiający sortowanie danych według wybranej kolumny.
order	String	asc|desc	Parametr opcjonalny umożliwiający zmianę kolejności sortowania.

Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.

Zwrot odpowiedzi

{
   "items":[{
      "id":228173579,
      "phone":"+48600700800",
      "email":"",
      "company":"",
      "first_name":"Błażej",
      "last_name":"Łopuszański",
      "tax_id":"",
      "address":"",
      "city":"",
      "description":"Dodatkowy opis",
      "blacklist":false,
      "group_id":17293086,
      "group_name":"Grupa testowa"
   },
   {
      "id":228173578,
      "phone":"+48500600700",
      "email":"biuro@serwersms.pl",
      "company":"SerwerSMS.pl",
      "first_name":"Mikołaj",
      "last_name":"Różecki",
      "tax_id":"",
      "address":"",
      "city":"",
      "description":"Szczegółowy opis kontaktu",
      "blacklist":false,
      "group_id":17293086,
      "group_name":"Grupa testowa"
   }]
}

Tworzenie grup

Wywołanie adresu

Aby przy pomocy zdalnej obsługi utworzyć nową grupę, należy wywołać określony adres URL metodą POST.

groups/add

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
username	String	Login	Login użytkownika API.
password	String	Haslo	Hasło użytkownika API.
name	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

{
   "success":true,
   "id":17256255
}

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.

contacts/add

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
username	String	Login	Login użytkownika API .
password	String	Haslo	Hasło użytkownika API.
group_id	Integer|Array	np. 15687446	Identyfikator grupy, do której ma być przypisany kontakt. Możliwe jest przesłanie kilku identyfikatorów za pomocą tablicy.
phone	String	np. +48500600700	Wartość pola Numer telefonu.
email	String	np. adres@mail.com	Wartość pola Adres e-mail. Pole przyjmuje maksymalnie 255 znaków.
first_name	String	tekst	Wartość pola Imię. Pole przyjmuje maksymalnie 255 znaków.
last_name	String	tekst	Wartość pola Nazwisko. Pole przyjmuje maksymalnie 255 znaków.
company	String	tekst	Wartość pola Firma. Pole przyjmuje maksymalnie 255 znaków.
tax_id	String	tekst	Wartość pola NIP. Pole przyjmuje maksymalnie 255 znaków.
address	String	tekst	Wartość pola Adres. Pole przyjmuje maksymalnie 255 znaków.
city	String	tekst	Wartość pola Miasto. Pole przyjmuje maksymalnie 255 znaków.
description	String	tekst	Wartość pola Opis. Pole przyjmuje maksymalnie 255 znaków.

Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.

Zwrot odpowiedzi

{
   "success":true,
   "id":92890613
}

Edycja grupy

Wywołanie adresu

Aby przy pomocy zdalnej obsługi edytować istniejącą grupę, należy wywołać określony adres URL metodą POST.

groups/edit

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
username	String	Login	Login użytkownika API.
password	String	Haslo	Hasło użytkownika API.
id	Integer	np. „12345678”	Identyfikator edytowanej grupy.
name	String	np. „nowa nazwa”	Nazwa alfanumeryczna opisująca grupę. Maksymalnie 100 znaków.

Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.

Zwrot odpowiedzi

{
   "success":true,
   "id":17256255
}

Edycja kontaktu

Wywołanie adresu

Aby przy pomocy zdalnej obsługi edytować istniejący kontakt, należy wywołać określony adres URL metodą POST.

contacts/edit

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
username	String	Login	Login użytkownika API.
password	String	Haslo	Hasło użytkownika API.
id	Integer	np. 12345678	Identyfikator edytowanego kontaktu.
group_id	Integer|Array	np. 15687446	Identyfikator grupy, do której ma być przypisany kontakt. Możliwe jest przesłanie kilku identyfikatorów za pomocą tablicy.
phone	String	np. +48500600700	Wartość pola Numer telefonu.
email	String	np. adres@mail.com	Wartość pola Adres e-mail. Pole przyjmuje maksymalnie 255 znaków.
first_name	String	tekst	Wartość pola Imię. Pole przyjmuje maksymalnie 255 znaków.
last_name	String	tekst	Wartość pola Nazwisko. Pole przyjmuje maksymalnie 255 znaków.
company	String	tekst	Wartość pola Firma. Pole przyjmuje maksymalnie 255 znaków.
tax_id	String	tekst	Wartość pola NIP. Pole przyjmuje maksymalnie 255 znaków.
address	String	tekst	Wartość pola Adres. Pole przyjmuje maksymalnie 255 znaków.
city	String	tekst	Wartość pola Miasto. Pole przyjmuje maksymalnie 255 znaków.
description	String	tekst	Wartość pola Opis. Pole przyjmuje maksymalnie 255 znaków.

Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.

Zwrot odpowiedzi

{
   "success":true,
   "id":92890613
}

Usuwanie grup

Wywołanie adresu

Aby przy pomocy zdalnej obsługi usunąć grupę, należy wywołać określony adres URL metodą POST.

groups/delete

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
username	String	Login	Login użytkownika API.
password	String	Haslo	Hasło użytkownika API.
id	Integer	Identyfikator grupy np. 12345689	Identyfikator grupy do usunięcia. Uwaga, podczas usuwania grupy kontakty do niej przypisane nie są usuwane.
delete_contacts	Boolean	true, false lub brak	Powoduje usunięcie wszystkich kontaktów należących do usuwanej grupy.

Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.

Zwrot odpowiedzi

{
   "success":true
}

Usuwanie kontaktów

Wywołanie adresu

Aby przy pomocy zdalnej obsługi usunąć kontakt, należy wywołać określony adres URL metodą POST.

contacts/delete

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
username	String	Login	Login użytkownika API.
password	String	Haslo	Hasło użytkownika API.
id	Integer	Identyfikator kontaktu np. 12345689	Identyfikator kontaktu do usunięcia.

Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.

Zwrot odpowiedzi

{
   "success":true
}

Sprawdzanie grup wybranego kontaktu

Wywołanie adresu

Aby przy pomocy zdalnej obsługi wyświetlić wszystkie grupy przypisane do danego kontaktu, należy wywołać określony adres URL metodą POST.

groups/check

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
username	String	Login	Login użytkownika API.
password	String	Haslo	Hasło użytkownika API.
phone	String	np. +48500600700	Numer telefonu.

Parametry oznaczone pogrubieniem są obowiązkowe. Pozostałe są opcjonalne.

Zwrot odpowiedzi

{
   "items":[{
      "id":"228274991",
      "group_id":17293172,
      "group_name":"Testowa grupa"
   },
   {
      "id":"228274486",
      "group_id":17885158,
      "group_name":"Grupa numer dwa"
   }]
}