HTTPS API v2 / Pobranie listy agentów RCS

Wywołanie adresu

Aby przy pomocy Zdalnej obsługi pobrać listę agentów RCS należy przesłać określone zgłoszenie protokołem HTTP lub HTTPS metodą POST. Jeśli nie posiadasz utworzonych agentów RCS otrzymasz pustą odpowiedź. Agenta RCS można dodać z poziomu Panelu Klienta -> Usługi dodatkowe -> RCS. Dopiero tak dodany agent będzie widoczny w API.

templates/rcs

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.

Parametry oznaczone pogrubieniem są obowiązkowe.

Zwrot odpowiedzi

W zależności od przesłanych danych SerwerSMS.pl wygeneruje w odpowiedzi dokument w formacie JSON/XML z informacją na temat wykonanych akcji. I tak w przypadku prawidłowego requestu zwrócona zostanie następująca struktura:

{
   "items":[{
      "name":"SerwerSMS",
      "description":"Opis SerwerSMS",
      "rcs_id":"1dgd2bss-bee6-134f-8d56-2655f4047649",
      "networks":[26001,26002],
      "webhook":"http://adres.pl",
      "online":1,
      "active":2
   }]
}

Element networks określa listę dostępnych sieci dla wybranego agenta. Flaga active o wartości 2 wskazuje, że agent RCS jest gotowy do użycia. Wartość 1 oznacza, że trwa etap weryfikacji zgłoszenia.