Specyfikacja modułu API systemu LimApi platformy limtel.pl

Transkrypt

1 Specyfikacja modułu API systemu LimApi platformy limtel.pl Wersja Data opublikowania: Moduł API przeznaczony jest do integracji systemów informatycznych z platformą limtel.pl. Jego zadaniem jest usystematyzowanie procedur wymiany informacji systemowych na wyższym poziomie warstwy OSI z wykorzystaniem protokołu http w oparciu o model REST. Transporterem informacji są struktury XML oparte o język wywołań XML-RPC API systemu Limtel.pl powstało w celu pełnego sprzężenia systemów informatycznych zaprojektowanych w różnych środowiskach programistycznych. System umożliwia zakładanie i sterowanie konkretnymi usługami jak i autoryzację użytkowników platformy limtel.pl Specyfikacja technologiczna: Protokół HTTP Wywołania RPC (GET,POST,PUT,DELETE) Transporter XML Skrypt nasłuchujący Dostępne Szyfrowanie SSL Autoryzacja platformy limtel.pl Uwierzytelnianie w systemie LimApi stanowiącego integralną część platformy limtel.pl odbywa się za pomocą parametrów zewnętrznych przekazywanych metodą GET w formie dedykowanego klucza a także danych autoryzacyjnych konta na platformie limtel.pl

2 Każde autoryzowane zapytanie do platformy limtel.pl powinno zostać wykonane z wykorzystanie klucza przydzielonego dla odbiorcy usługi. Parametr powinien zostać przekazany poprzez GET np. Format przesyłanych informacji Nazwa Format Metoda key CHAR(20) GET Podstawowa struktura zapytania Proces komunikacji między systemami informatycznymi odbywa się za pomocą przesyłanych w obu kierunkach plików XML. Pliki XML mają stałą nie zamienialną konstrukcję Wszelkie dokumenty XML powinny zostać przekazane do systemu metodą POST Główna struktura zapytania powinna zostać przekazana w następującej strukturze generycznej. Struktura generyczna ( struktura podstawowa dla każdego zapytania ) <akcja>nazwa_akcji</akcja> <authkey>klucz_dostepowy</authkey> < > _konta_platformy_limtel</ > <pass>haslo_dostepu_w_md5</pass> Struktura dopasowana do komendy sterującej

3 Zakres podstawowych parametrów zapytań generycznych struktury XML Nazwa Wartość Opis akcja login register userdetails userinfo authme numbers history invoices recordings delrecording paybycoupon set_service_przekierowanie edit_service_przekierowanie delete_service_przekierowanie initpayment edituserinfo edituserdetails serviceinfo set_service_ankiety edit_service_ankiety delete_service_ankiety dial_service_ankiety get_service_ankiety set_service_alarmowa edit_service_alarmowa del_service_alarmowa set_service_komunikaty edit_service_komunikaty delete_service_komunikaty dial_service_komunikaty get_service_komunikaty Przekazywana do systemu komenda sterująca związana z konkretną akcją np. uwierzytelnianiem użytkownika jego rejestracja a także zakładaniem konkretnych usług I ich aktywności authkey CHAR(20) Indywidualny klucz autoryzacyjny CHAR(100) Adres stanowiący identyfikator użytkownika Na platformie limtel.pl Pass CHAR(100) Hasło dostępowe przypisane do a autoryzującego na platformie limtel.pl

4 przekazywane w formie MD5 Struktury generyczne odpowiedzi systemu API Struktury obecne przy każdej odpowiedzi systemu LimAPI <system> <status>kod_statusu</status> <error>opis_błędu_jeśli_istnieje</error> </system> Struktura dodatkowa uzależniona od przekazanej akcji Szczegółowy opis struktury generycznej odpowiedzi Nazwa Zakres WARTOŚĆ Opis System->Status INT(1) 0,1 0 Akcja nie została wykonana poprawnie 1 Akcja została wykonana poprawnie System->Error VARCHAR(255) - Opis błędu podczas wykonywania określonej akcji

5 Akcje Opis poszczególnych akcji systemowych wraz z ich parametrami zapytania i odpowiedzi Akcja: login Akcja logująca użytkownika na platformie limtel.pl, wykorzystywana do pierwszej autoryzacji lub pobrania informacji o zalogowanym użytkowniku Struktura zapytania: <akcja>login</akcja> < >test@example.net</ > <pass>a7f1bbc90496ca91cfd4c4fd6a33d161</pass> <authkey>efe996881bd7978a81dbf bd8</authkey> Parametry zapytań dla akcji login są takie same jak przy każdym zapytaniu generycznym. Jedyną różnicą tej akcji są zwracane informacje potrzebne do dalszego działania z systemem limtel.pl Struktura odpowiedz <system> <status>0</status> </system> <data> <userid>id_usera_w_limtel_pl</userid> <userimie>imie_usera</userimie> <usernazwisko>user_nazwisko</usernazwisko> <user >user_ </userermail>

6 </data> Wyszczególnione dane odpowiedzi w systemie limtel.pl data->userid INT(10) Unikalny numer ID przydzielony wewnętrznie na platformie limtel do logującego użytkownika. Numer bardzo istotny przy zakładaniu konkretnych usług Data->userimie CHAR(255) Imie logowanego użytkownika Data->usernazwisko CHAR(255) Nazwisko logowanego użytkownika Data->user CHAR(100) systemowy logowanego użytkownika Akcja: register Akcja służąco do rejestracji nowego użytkownika w systemie limtel. Struktura zapytania: <akcja>register</akcja> < >test@example.net</ > <pass>a7f1bbc90496ca91cfd4c4fd6a33d161</pass> <authkey>efe996881bd7978a81dbf bd8</authkey> <telefon> </telefon>

7 <imie>jan</imie> <nazwisko>kowalski</nazwisko> Wyszczególnione dane zapytania poza elementami generycznymi dla akcji register Imie WYMAGANE CHAR(100) Imię nowego użytkownika Nazwisko WYMAGANE CHAR(100) Nazwisko nowego użytkownika WYMAGANE CHAR(100) nowego użytkownika stanowiący również jego przyszły login Telefon OPCJONALNE INT(20) Numer telefonu Użytkownika Struktura odpowiedz <system> <status>1</status> </system>

8 <data> <userid>id_usera_w_limtel_pl</userid> <userimie>imie_usera</userimie> <usernazwisko>user_nazwisko</usernazwisko> <user >user_ </userermail> </data> Wyszczególnione dane odpowiedzi w systemie limtel.pl data->userid INT(10) Unikalny numer ID przydzielony wewnętrznie na platformie limtel do logującego użytkownika. Numer bardzo istotny przy zakładaniu konkretnych usług Data->userimie CHAR(255) Imie logowanego użytkownika Data->usernazwisko CHAR(255) Nazwisko logowanego użytkownika Data->user CHAR(100) systemowy logowanego użytkownika Akcja numbers

9 Akcja pobierająca informacje o wolnych numerach telefonów w systemie limtel.pl. Polecenie te należy wykonać przed utworzeniem jakiejkolwiek usługi na platformie limtel. Zapytania dotyczące kreowania usług będą wymagały podania numer ID numeru telefonu, który można uzyskać za pomocą tego zapytania. Struktura zapytania: <akcja>numbers</akcja> < >test@example.net</ > <pass>a7f1bbc90496ca91cfd4c4fd6a33d161</pass> <authkey>efe996881bd7978a81dbf bd8</authkey> Struktura odpowiedz <system> <status>1</status> </system> <telephones> <telephone> <nid>23</nid> <number> </number> </telephone> <telephone> <nid>23</nid> <number> </number> </telephone> </telephones>

10 Wyszczególnione dane odpowiedzi zapytania numbers telephones->telephone->nid INT(10) Unikalny numer ID wolnego numeru telefonu telephones->telephone->number INT(20) Numer telefonu Uwaga!! Przed założeniem gotowej usługi należy pobrać numery telefonów i wybrać jeden którego numer ID jak i wartość będzie trzeba dodać do zapytania o wykreowanie usługi Akcja: history Akcja pobierająca historię realizowanych połączeń w ramach konkretnej usług Struktura zapytania: <akcja>history</akcja> < >test@example.net</ > <pass>a7f1bbc90496ca91cfd4c4fd6a33d161</pass> <authkey>efe996881bd7978a81dbf bd8</authkey> <channel>12</channel> <idu>32</idu> <typ>0</typ> <ile>100</ile> <strona>2</strona>

11 Wyszczególnione dane zapytania polecenia history Channel INT(10) Unikalny numer kanału. Numer ten otrzymujemy zwrotnie przy założeniu usługi. Idu INT(20) Unikalny numer użytkownika Dla którego pobieramy historię. Numer ten otrzymujemy przy logowaniu do platformy poprzez akcję login Typ INT(1) 0 Połączenia przychodzące 1 Połączenia wychodzące Ile INT(5) Ile wyników w zapytaniu Strona INT(5) Która strona dla formowanych odpowiedzi Struktura odpowiedz

12 <system> <status>1</status> <ile>120</ile> </system> <log> <action> <data> :23:12</data> <fromnumber> </fromnumber> <tonumber> </tonumber> <kwota>0.43</kwota> <opis>regularne połączenie przychodzące</opis> <allow>0</allow> </action> <action> <data> :43:12</data> <fromnumber> </fromnumber> <tonumber> </tonumber> <kwota>0.23</kwota> <opis>regularne połączenie przychodzące</opis> <allow>0</allow> </action> </log> Wyszczególnione dane odpowiedzi zapytania numbers Log->action->data DATETIME Data Wykonanego Połączenia w formacie YYY-MM-DD HH:MM:SS Log->action->fromnumber INT(20) Numer telefonu z którego nastąpiło połączenie Log->action->tonumber INT(20) Numer na który nastąpiło

13 połączenie Log->action->kwota DOUBLE(10) Kwota Brutto połączenia Log->action->opis CHAR(25) Opis połączenia Log->action->allow INT(1) Rodzaj połączenia 0 Połączenie abonamentowe 1 Połączenie regularne Akcja recordings Akcja pobierająca informacje o nagraniach dla konkretnego założonego kanału. Struktura zapytania: <akcja>recordings</akcja> < >test@example.net</ > <pass>a7f1bbc90496ca91cfd4c4fd6a33d161</pass> <authkey>efe996881bd7978a81dbf bd8</authkey> <channel>12</channel> <idu>2</idu> Wyszczególnione dane zapytania polecenia recordings Channel INT(10) Unikalny numer kanału. Numer ten otrzymujemy zwrotnie przy założeniu usługi.

14 Idu INT(20) Unikalny numer użytkownika Dla którego pobieramy historię. Numer ten otrzymujemy przy logowaniu do platformy poprzez akcję login Struktura odpowiedz <system> <status>1</status> </system> <recordings> <record> <numer> </numer> <data> :12:32</data> <id>42</id> <url> </record> <record> <numer> </numer> <data> :12:32</data> <id>43</id> <url> </record> </recordings> Akcja delrecording Akcja kasująca nagranie telefoniczne z serwerów limtel.pl Struktura zapytania:

15 <akcja>delrecordings</akcja> <pass>a7f1bbc90496ca91cfd4c4fd6a33d161</pass> <authkey>efe996881bd7978a81dbf bd8</authkey> <channel>12</channel> <idu>2</idu> <recordingid>23</recordingid> Wyszczególnione dane zapytania polecenia delrecording Channel INT(10) Unikalny numer kanału. Numer ten otrzymujemy zwrotnie przy założeniu usługi. Idu INT(20) Unikalny numer użytkownika Dla którego pobieramy historię. Numer ten otrzymujemy przy logowaniu do platformy poprzez akcję login Recordingid INT(10) Unikalny numer ID nagrania Struktura odpowiedz <system> <status>1</status>

16 </system> Wyszczególnione dane odpowiedzi zapytania numbers recordings->record->numer INT(10) Numer telefonu dla nagrania Recordings->record->data DATEIME Data nagrania w formacie YYYY-MM-DD HH:MM:SS Recordings->records->id INT(10) Numer ID nagrania Recordings->records->url CHAR(50) Ścieżka do nagrania w formacie FLV lub OGG Akcja: set_service_komunikaty Akcja polegająca na założeniu kampanii związanej z wydzwanianiem. Założona kampania będzie aktywna przez okres 30 dni. Jej wykonanie nie jest równoznaczne z rozpoczęciem wydzwaniania. Do założonej kampanii można dodać numery telefonów i żadaniem wydzwonienia za pomocą akcji dial_service_komunikaty. W dowolnym momencie można wprowadzić zmiany w strukturze komunikatu dzięki czemu nowe akcje dial zostaną wykonane z poprawioną wartością Struktura zapytania:

17 <akcja>set_service_komunikaty</akcja> <pass>a7f1bbc90496ca91cfd4c4fd6a33d161</pass> <authkey>efe996881bd7978a81dbf bd8</authkey> <numberid>12</numberid> <numberchar> </numberchar> <idu>32</idu> <nazwa>nazwa nowej kampanii</nazwa> <komunikat>to jest testowy komunikat głosowy</komunikat> <kampania>2</kampania> <nagraj>1</nagraj> <nagrajkomunikat>po usłyszeniu sygnału proszę nagrać opinię</nagrajkomunikat> <podziekowanie>dziękujemy za udział w ankiecie</podziękowanie> Wyszczególnione dane zapytania polecenia set_service_komunikaty Numberid INT(10) Unikalny numer identyfikacyjny telefonu. Uzyskujemy go poprzez zapytanie numbers Numberchar INT(20) Numer telefonu powiązany z numberid uzyskany poprzez zapytanie numbers Nazwa CHAR(100) Nazwa dla przeprowadzanej kampanii IDU INT(5) Unikalny numer użytkownika, który zakłada

18 kampanię uzyskany poprzez komendę login Komunikat CHAR(500) Komunikat głosowy, automatycznie przetwarzany przez lektora Kampania Opcjonalny INT(10) Numer kampanii w zewnętrznym systemie informatycznym, przekazywany później w danych zwrotnych. Stanowi unikalny numer identyfikacyjny po stronie systemu łączącego się z limtel.pl nagraj Opcjonalny nagrajkomunikat Opcjonalny INT(1) CHAR(100) 0 Nie nagrywaj 1 Nagrywaj Komunikat odczytywany przed nagraniem wiadomości podziekowanie CHAR(100) Komunikat odczytywany po wykonaniu ankiety Struktura odpowiedz <system> <status>1</status> </system> <data> <numerkanalu>12</numerkanalu> <numerplanu>22</numerplanu> </data>

19 Wyszczególnione dane odpowiedzi zapytania numbers Data->numerkanalu INT(10) Unikalny numer kanału/kampanii, wymagany przy niektórych akcjach operujących na jej działaniu Data->numer plany INT(10) Unikalny numer planu, wymagany przy niektórych akcjach operujących na jej działaniu Akcja: edit_service_komunikaty Akcja polegająca na edytowaniu już założonej kampanii do edycji wymagane są informacje zwrotne przekazane po założeniu kampanii takie jak numer kanału i numer planu. Edytowana treść będzie miała skutek na nowo wykonanych poleceniach dial_service_komunikaty. Struktura zapytania: <akcja>set_service_komunikaty</akcja> < >test@example.net</ > <pass>a7f1bbc90496ca91cfd4c4fd6a33d161</pass> <authkey>efe996881bd7978a81dbf bd8</authkey> <idu>32</idu> <nazwa>nazwa nowej kampanii</nazwa> <komunikat>to jest testowy komunikat głosowy</komunikat>

20 <kampania>2</kampania> <nagraj>1</nagraj> <nagrajkomunikat>po usłyszeniu sygnału proszę nagrać opinię</nagrajkomunikat> <podziekowanie>dziękujemy za udział w ankiecie</podziękowanie> Wyszczególnione dane zapytania polecenia edit_service_komunikaty Nazwa CHAR(100) Nazwa dla przeprowadzanej kampanii IDU INT(5) Unikalny numer użytkownika, który zakłada kampanię uzyskany poprzez komendę login Komunikat CHAR(500) Komunikat głosowy, automatycznie przetwarzany przez lektora Kampania Opcjonalny INT(10) Numer kampanii w zewnętrznym systemie informatycznym, przekazywany później w danych zwrotnych. Stanowi unikalny numer identyfikacyjny po stronie systemu łączącego się z limtel.pl nagraj Opcjonalny INT(1) 0 Nie nagrywaj 1 Nagrywaj

21 nagrajkomunikat Opcjonalny CHAR(100) Komunikat odczytywany przed nagraniem wiadomości Podziękowanie Opcjonlany CHAR(100) Komunikat odczytywany po wykonaniu ankiety Struktura odpowiedz <system> <status>1</status> </system> Wyszczególnione dane odpowiedzi zapytania numbers System->status INT(10) 0 Wykonano niepoprawnie 1 wykonano poprawnie Akcja: dial_service_komunikaty Akcja polegająca na rozpoczęciu wydzwaniania konkretnej kampanii na podanej grupie numerów telefonów. Należy pamiętać, że wydzwanianie jak i jej ustawienia podlegają kolejkowaniu, które zabezpiecza kampanię przed stalkingiem czy wydzwanianiu w nieodpowiednich godzinach. Dodawane numery telefonów mogą się dublować jednak system traktuje je jako unikalne wartości i nie doda do kolejki jeśli wcześniej był dodany w ramach systemu

22 Akcje dial_service_komunikaty można wywoływać do wyczerpania limitu numerów w kampanii i daty wygaśnięcia numeru, który jest ustawiany na 30 dni od daty utworzenia kampanii poleceniem set_service_komunikaty Struktura zapytania: <akcja>dial_service_komunikaty</akcja> < >test@example.net</ > <pass>a7f1bbc90496ca91cfd4c4fd6a33d161</pass> <authkey>efe996881bd7978a81dbf bd8</authkey> <planid>12</planid> <idu>32</idu> <numer> , , </numer> Wyszczególnione dane zapytania polecenia dial_service_komunikaty Planid INT(10) Unikalny numer planu uzyskiwany przy tworzeniu kampanii IDU INT(5) Unikalny numer użytkownika, który zakłada kampanię uzyskany poprzez komendę login Numery CHAR(1000) Numery telefonów po przecinku w formacie liczbowym, bez spacji bez nawiasów, itd np. Poprawnie:

23 , Niepoprawnie (89)542504, , Struktura odpowiedz <system> <status>1</status> </system> <data> Wyszczególnione dane odpowiedzi zapytania System->status INT(10) 1 Poprawnie wykonana 0 Niepoprawnie wykonana System->error CHAR(255) Błąd udostępniany przez statusie 0 Akcja: delete_service_komunikaty Permanentne kasowanie kampanii komunikatów głosowych Struktura zapytania: <akcja>delete_service_komunikaty</akcja>

24 <pass>a7f1bbc90496ca91cfd4c4fd6a33d161</pass> <authkey>efe996881bd7978a81dbf bd8</authkey> <planid>12</planid> <idu>32</idu> Wyszczególnione dane zapytania polecenia delete_service_komunikaty IDU INT(5) Unikalny numer użytkownika, który zakłada kampanię uzyskany poprzez komendę login Planid INT(1) Unikalny numer ID PLANU uzyskiwany w momencie jego generowania. Struktura odpowiedz <system> <status>1</status> </system> Akcja: get_service_komunikaty Akcja polagająca na pobraniu szczegółów wykonywanej kampanii komunikatów Struktura zapytania:

25 <akcja>get_service_komunikaty</akcja> <pass>a7f1bbc90496ca91cfd4c4fd6a33d161</pass> <authkey>efe996881bd7978a81dbf bd8</authkey> <idu>32</idu> <planid>2</planid> Wyszczególnione dane zapytania polecenia get_service_komunikaty planid IDU INT(10) INT(5) Unikalny numer identyfikacyjny planu. Unikalny numer użytkownika, który zakłada kampanię uzyskany poprzez komendę login Struktura odpowiedz <system> <status>1</status> </system> <data> <telefonow>432</telefonow> <dostarczonych>122</dostarzonych> <niedostarczonych>32</niedostarczonych> </data> <dial> <telephone> <numer> </numer>

26 <data> :31:12</data> <status>0</status> </telephone> </dial> Wyszczególnione dane odpowiedzi zapytania numbers Data->telefonow INT(10) Całkowita ilość numerów realizowanych w ramach kampanii Data->dostarczonych INT(10) Ilość dostarczonych poprawnie numerów telefonów Data->niedostarczonych IN(10) Ilość nie dostarczonych wiadomości Dial->telephone->numer INT(10) Numer telefonu na który wykonano kampanię Dial->telephone->data DATETIME Data w której wykonano kampanię YYYY-MM-DD HH:MM:SS Dial->telephone->status INT(1) 0 Obebrano 1 Nie odebrano

27 Akcja: set_service_ankiety Akcja polegająca na założeniu kampania związanej z przeprowadzaną teleankietą. Założona kampania będzie aktywna przez okres 30 dni. Jej wykonanie nie jest równoznaczne z rozpoczęciem wydzwaniania. Do założonej kampanii można dodać numery telefonów i żądaniem wydzwonienia za pomocą akcji dial_service_ankiety. W dowolnym momencie można wprowadzić zmiany w strukturze komunikatu dzięki czemu nowe akcje dial zostaną wykonane z poprawioną wartością Struktura zapytania: <akcja>set_service_ankiety</akcja> < >test@example.net</ > <pass>a7f1bbc90496ca91cfd4c4fd6a33d161</pass> <authkey>efe996881bd7978a81dbf bd8</authkey> <numberid>12</numberid> <numberchar> </numberchar> <idu>32</idu> <nazwa>nazwa nowej kampanii</nazwa> <pytanie>na kogo będziesz glosował w tych wyborach </pytanie> <odp1>na Jana Kowalskiego</odp1> <odp2>na Stefana Kamilczuka</odp2> <odp3>na Mirka Korczaka</odp3> <kampania>2</kampania> <url> <podziekowanie>dziękujemy za udział w ankiecie</podziekowanie> Wyszczególnione dane zapytania polecenia set_service_ankiety Numberid INT(10) Unikalny numer identyfikacyjny telefonu. Uzyskujemy go poprzez zapytanie numbers

28 Numberchar INT(20) Numer telefonu powiązany z numberid uzyskany poprzez zapytanie numbers Nazwa CHAR(100) Nazwa dla przeprowadzanej kampanii IDU INT(5) Unikalny numer użytkownika, który zakłada kampanię uzyskany poprzez komendę login Pytanie CHAR(500) Komunikat głosowy, automatycznie przetwarzany przez lektora w formie pytania ankietowego. Kampania Opcjonalny INT(10) Numer kampanii w zewnętrznym systemie informatycznym, przekazywany później w danych zwrotnych. Stanowi unikalny numer identyfikacyjny po stronie systemu łączącego się z limtel.pl ODP1 CHAR(100) Odpowiedź numer 1 WYMAGANE ODP2 CHAR(100) Odpowiedź numer 2 Opcjonalnie ODP 3 CHAR(100) Odpowiedź numer 3

29 Opcjonalnie ODP 4 CHAR(100) Odpowiedź numer 4 Opcjonalnie ODP 5 CHAR(100) Odpowiedź numer 5 Opcjonalnie ODP 6 Opcjonalne ODP 7 Opcjonalne CHAR(100) CHAR(100) Odpowiedź numer 6 Odpowiedź numer 7 ODP 8 CHAR(100) Odpowiedź numer 8 Opcjonalne ODP 9 CHAR(100) Odpowiedź numer 9 Opcjonalne ODP 10 CHAR(100) Odpowiedź numer 10 Opcjonalne URL CHAR(100) Adres URL na który zostaną przekazane informacje dotyczące wyniku ankiety. Poprzez GET na ten adres zostaną przekazane następujące parametry

30 Number = Numer telefonu Wynik = wynik ankiety w formie numerycznej Kampania = Wewnętrzny ID Kampanii podawanych przy jej zakładaniu podziekowanie Opcjonlany CHAR(100) Komunikat odczytywany po wykonaniu ankiety Struktura odpowiedz <system> <status>1</status> </system> <data> <numerkanalu>12</numerkanalu> <numerplanu>22</numerplanu> </data> Wyszczególnione dane odpowiedzi zapytania numbers Data->numerkanalu INT(10) Unikalny numer kanału/kampanii, wymagany przy niektórych akcjach operujących na jej działaniu

31 Data->numer plany INT(10) Unikalny numer planu, wymagany przy niektórych akcjach operujących na jej działaniu Akcja: edit_service_ankiety Edycja ustawień teleankiet Struktura zapytania: <akcja>edit_service_ankiety</akcja> <pass>a7f1bbc90496ca91cfd4c4fd6a33d161</pass> <authkey>efe996881bd7978a81dbf bd8</authkey> <numberid>12</numberid> <numberchar> </numberchar> <idu>32</idu> <nazwa>nazwa nowej kampanii</nazwa> <pytanie>na kogo będziesz glosował w tych wyborach </pytanie> <odp1>na Jana Kowalskiego</odp1> <odp2>na Stefana Kamilczuka</odp2> <odp3>na Mirka Korczaka</odp3> <kampania>2</kampania> <podziekowanie>dziękujemy za udział w ankiecie</podziekowanie> Wyszczególnione dane zapytania polecenia edit_service_ankiety IDU INT(5) Unikalny numer użytkownika, który zakłada kampanię uzyskany poprzez komendę login

32 Pytanie CHAR(500) Komunikat głosowy, automatycznie przetwarzany przez lektora w formie pytania ankietowego. Kampania INT(10) Numer kampanii w zewnętrznym systemie informatycznym, przekazywany później w danych zwrotnych. Stanowi unikalny numer identyfikacyjny po stronie systemu łączącego się z limtel.pl ODP1 CHAR(100) Odpowiedź numer 1 WYMAGANE ODP2 CHAR(100) Odpowiedź numer 2 Opcjonalnie ODP 3 CHAR(100) Odpowiedź numer 3 Opcjonalnie ODP 4 CHAR(100) Odpowiedź numer 4 Opcjonalnie ODP 5 CHAR(100) Odpowiedź numer 5 Opcjonalnie ODP 6 CHAR(100) Odpowiedź numer 6

33 Opcjonalne ODP 7 CHAR(100) Odpowiedź numer 7 Opcjonalne ODP 8 CHAR(100) Odpowiedź numer 8 Opcjonalne ODP 9 CHAR(100) Odpowiedź numer 9 Opcjonalne ODP 10 CHAR(100) Odpowiedź numer 10 Opcjonalne podziekowanie Opcjonlany CHAR(100) Komunikat odczytywany po wykonaniu ankiety Struktura odpowiedz <system> <status>1</status> </system> Akcja: delete_service_ankiety

34 Permanentne kasowanie kampanii ankiet. Struktura zapytania: <akcja>delete_service_ankiety</akcja> <pass>a7f1bbc90496ca91cfd4c4fd6a33d161</pass> <authkey>efe996881bd7978a81dbf bd8</authkey> <planid>12</planid> <idu>32</idu> Wyszczególnione dane zapytania polecenia delete_service_ankiety IDU INT(5) Unikalny numer użytkownika, który zakłada kampanię uzyskany poprzez komendę login Planid INT(1) Unikalny numer ID PLANU uzyskiwany w momencie jego generowania. Struktura odpowiedz <system> <status>1</status> </system>

35 Akcja: dial_service_ankiety Akcja polegająca na rozpoczęciu wydzwaniania konkretnej kampanii na podanej grupie numerów telefonów. Należy pamiętać, że wydzwanianie jak i jej ustawienia podlegają kolejkowaniu, które zabezpiecza kampanię przed stalkingiem czy wydzwanianiu w nieodpowiednich godzinach. Dodawane numery telefonów mogą się dublować jednak system traktuje je jako unikalne wartości i nie doda do kolejki jeśli wcześniej był dodany w ramach systemu Akcje dial_service_komunikaty można wywoływać do wyczerpania limitu numerów w kampanii i daty wygaśnięcia numeru, który jest ustawiany na 30 dni od daty utworzenia kampanii poleceniem set_service_ankiety Struktura zapytania: <akcja>dial_service_ankiety</akcja> < >test@example.net</ > <pass>a7f1bbc90496ca91cfd4c4fd6a33d161</pass> <authkey>efe996881bd7978a81dbf bd8</authkey> <planid>12</planid> <idu>32</idu> <numer> , , </numer> Wyszczególnione dane zapytania polecenia dial_service_ankiety Planid INT(10) Unikalny numer planu uzyskiwany przy tworzeniu kampanii

36 IDU INT(5) Unikalny numer użytkownika, który zakłada kampanię uzyskany poprzez komendę login Numery CHAR(1000) Numery telefonów po przecinku w formacie liczbowym, bez spacji bez nawiasów, itd np. Poprawnie: , Niepoprawnie (89)542504, , Struktura odpowiedz <system> <status>1</status> </system> <data> Wyszczególnione dane odpowiedzi zapytania System->status INT(10) 1 Poprawnie wykonana 0 Niepoprawnie wykonana

37 System->terror CHAR(255) Błąd udostępniany przez statusie 0 Akcja: get_service_ankiety Akcja polagająca na pobraniu szczegółów wykonywanej kampanii teleankiet Struktura zapytania: <akcja>get_service_ankiety</akcja> < >test@example.net</ > <pass>a7f1bbc90496ca91cfd4c4fd6a33d161</pass> <authkey>efe996881bd7978a81dbf bd8</authkey> <idu>32</idu> <planid>2</planid> Wyszczególnione dane zapytania polecenia get_service_ankiety planid IDU INT(10) INT(5) Unikalny numer identyfikacyjny planu. Unikalny numer użytkownika, który zakłada kampanię uzyskany poprzez komendę login Struktura odpowiedz

38 <system> <status>1</status> </system> <data> <telefonow>432</telefonow> <dostarczonych>122</dostarzonych> <niedostarczonych>32</niedostarczonych> </data> <dial> <telephone> <numer> </numer> <data> :31:12</data> <status>0</status> </telephone> </dial> Wyszczególnione dane odpowiedzi zapytania numbers Data->telefonow INT(10) Całkowita ilość numerów realizowanych w ramach kampanii Data->dostarczonych INT(10) Ilość dostarczonych poprawnie numerów telefonów Data->niedostarczonych IN(10) Ilość nie dostarczonych wiadomości Dial->telephone->numer INT(10) Numer telefonu na który wykonano kampanię DATETIME Data w której wykonano

39 Dial->telephone->data kampanię YYYY-MM-DD HH:MM:SS Dial->telephone->status INT(1) 0 Obebrano 1 Nie odebrano