VCC-API fejlesztői leírás Virtual Call Center API fejlesztői leírás

Átírás

1 Virtual Call Center API fejlesztői leírás Oldal: 1 / 79

2 Dkumentumtörténet Verzió Kiadás dátuma Készítette Leírás Fehér Gábr, Gólya Ádám Fejlesztői dkumentáció Fehér Gábr, Gólya Ádám Kiegészítés: Kimenő API rész hzzáadása, Tartalm átrendezés Fehér Gábr, Gólya Ádám Prjects kiegészítése a "status" elemmel, új erőfrrás: felhasználók listájának lekérdezése Fehér Gábr Kimenő API Létező események módsítása Fehér Gábr, Farkas Dániel Hívás statisztika, Bejövő statisztika hzzáadása Fehér Gábr Prjekt paraméterekeinek lekérdezése rész kiegészítés Fehér Gábr Hívás statisztika, Bejövő statisztika hzzáadása kiegészítés: kimenet frmátum Fehér Gábr Kvóták lekérdezése, és kvótalimitek módsítása Fehér Gábr, Vincze Zltán Tömeges rekrd és termináció módsítás Fehér Gábr, Gólya Ádám Mezők és értékek létrehzása. Értékek beszúrása adtt mezőhöz. Értékek törlése. Kvóták lekérdezés kiegészítés. Rekrd beszúrás kiegészítés Fehér Gábr Kimenő API kiegészítés Fehér Gábr, Gólya Ádám Várakzási srban szereplő nline és elérhető perátrk számának lekérdezése Fehér Gábr, Imre Zslt Autentikáció kiegészítés Fehér Gábr Struktúra átalakítás, magyarázatk beépítése Fehér Gábr, Gólya Ádám API V2 váltzásk felvezetése. Frmázási váltztatásk Visszatérési értékek táblázat bevezetése. Összefüggés ábra beszúrása Fehér Gábr Rekrd beszúrás (2.8.2) pnt értelmezési rész kiegészítése a támgattt telefnszám frmátummal Fehér Gábr Módsítás: 2.1-es pnt API -> Adatbázis API; 3.2-es pnt API fül -> Callback API Fehér Gábr Kiegészítés es pnt: új kulcsn megadható, hgy a rendszer mely telefnszámn hívja az ügyfelet. Oldal: 2 / 79

3 Módsítás: 3-as pnt Kimenő API nevének cseréje Callback API-ra Fehér Gábr Új Database API funkció: Felhasználói tevékenység statisztika Vincze Zltán, Fehér Gábr Tömeges termináció állítás (2.11) kiegészítés, Tömeges rekrd beszúrás (2.8) Farkas Jáns, Fehér Gábr Új Database API funkciók: Csapatk lekérdezése (2.23), Jgsultság csprtk lekérdezése (2.24), Prjekt máslás (2.25), Felhasználó létrehzás (2.26) Farkas Jáns, Fehér Gábr Strukturális átalakítás: lgikai csprtk létrehzása Új Database API funkció: Adtt mező értékeinek módsítása Fehér Gábr Callback API példa beszúrása, új Database API funkció: CDR lekérdezése uuid alapján, Callback API kiegészítése példával Oldal: 3 / 79

4 1. Virtual Call Center API leírás A REST interface megvalósítása Az API elérhetősége Authentikáció Az API beállítása Az authentikáció flyamata Prjektek Prjektek listájának lekérdezése A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Prjektek paramétereinek lekérdezése A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Prjekt máslás A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Rekrdk Rekrdk listázása A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Rekrd adatainak lekérdezése A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Rekrd adatainak módsítása A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Rekrd beszúrása Oldal: 4 / 79

5 A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Termináció beszúrása egy adtt rekrdhz A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Tömeges rekrd módsítás A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Tömeges termináció módsítás A funkció leírása Példa a funkció használatára A Visszatérő adatk értelmezése Kvótázás Kvóták lekérdezése A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Kvóták módsítása A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Mezők és értékek Mezők és értékek létrehzása A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Létező mezőhöz új érték hzzáadása A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Oldal: 5 / 79

6 5.3. Adtt mező értékeinek módsítása A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Adtt mező értékeinek törlése A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Statisztikák, riprtk CDR-ek lekérdezése adtt hónapra A funkció leírása Példa a funkció használatára Visszatérő adatk értelmezése CDR-ek lekérdezése uuid alapján A funkció leírása Példa a funkció használatára Visszatérő adatk értelmezése Bejövő statisztika A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Hívás statisztika A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Várakzási srban szereplő nline és elérhető perátrk számának lekérdezése A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Felhasználói tevékenység statisztika A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Oldal: 6 / 79

7 7. Felhasználók, csapatk, jgsultságk Felhasználók listájának lekérdezése A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Felhasználó létrehzása A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Csapatk lekérdezése A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Jgsultság csprtk lekérdezése A funkció leírása Példa a funkció használatára A visszatérő adatk értelmezése Callback API A Callback API célja és működése A Callback API beállítása Példa a Callback API üzenetre...77 Oldal: 7 / 79

8 1. Virtual Call Center API leírás A Virtual Call Center API (tvábbiakban API) célja, hgy a Virtual Call Center (tvábbiakban VCC) rendszerét összekösse az ügyfelek külső rendszereivel A REST interface megvalósítása Az API tervezése srán a REST elveit valamint a JSON-t választttuk a VCC és a külső rendszerek integrálásáhz. Ezen technlógiák segítségével a rendszerek HTTP GET, PUT, POST, DELETE üzenetek segítségével kmmunikálnak egymással. Az elérhető erőfrrásk részletes leírása a következő fejezetekben fg megtörténni. A REST interfaceről bővebben: A JSON-ről bővebben: Az API elérhetősége <custmer>.asp.virtual-call-center.eu Az API-t csak előre meghatárztt IP-ről vagy IP tartmányba tartzó IP-ről lehet elérni Authentikáció Az API beállítása A bejelentkezéshez szükséges adatkat a Virtual Call Center kliens használatával, supervisr / admin jgsultságú felhasználóként a VCC Beállításk ldal Adatbázis API füle alatt adható meg a következő lépések végrehajtásával: 1. Állítsa be az IP címet, vagy IP tartmányt, ahnnan szeretné az API-t elérhetővé tenni. 2. Generálja le a jelszót a Jelszó generálás gmb megnymásával. 3. A módsításk mentéséhez nymja meg a Mentés gmbt. Az URL példa a használathz mező által adtt mintát használhatja az API eléréséhez Az authentikáció flyamata Amennyiben a bejelentkezés még nem történt meg, bármely API funkció meghívásakr a kiszlgáló felszólítja a klienst, hgy authentikálja magát. Az API HTTP basic authentikációt használ, melynek srán a kliens a felhasználónevet és jelszót egy kettőspnttal összefűzi, az így kaptt szöveget Base64 kódlja, majd a HTTP kérés fejlécében, az Authrizatin paraméter értékeként küldi el a kiszlgáló felé. Oldal: 8 / 79

9 Sikeres authentikációt követően a kiszlgáló által küldött válasz fejlécében a Set-Ckie paraméterben megkapjuk a PHPSESSID váltzó értékét, amit minden kérésnél el kell küldeni, vagy ckie-n keresztül vagy a scping infrmációban. Az API használatáhz, beleértve az ahhz történő authentikációt is, a HTTPS prtkll használata ajánltt, habár minden művelet elérhető HTTP prtklln keresztül is, de ez utóbbi nem nyújt védelmet a hálózati frgalm lehallgatásával szemben. Tvábbi infrmáció a Basic Authenticatin-nel kapcslatban elérhető a ldaln. Oldal: 9 / 79

10 2. Prjektek 2.1. Prjektek listájának lekérdezése A funkció leírása Az erőfrrás célja: az összes prjekt lekérdezése Az erőfrrás URI-je: /v2/prjects Metódus: GET Példa a funkció használatára Kérés: Válasz: "respnse": [ "prjectid": 2, "name": "Kimenő hideghívásk", "status": "active", "cntainer": false, "prjectid": 3, "name": "Emlékeztető hívásk Budapest", "status": "inactive", "cntainer": false, "prjectid": 1, "name": "2011 któber", "status": "active", "cntainer": false ], "errrs": [] A visszatérő adatk értelmezése Típus Magyarázat prjectid int a prjekt a VCC adatbázisában szereplő aznsítója name string a prjekt ügyfél által megadtt neve status string a prjekt státusza active a prjekt státusza aktív inactive a prjekt státusza inaktív cntainer blean az adtt elem tartalmaz-e tvábbi elemeket true tartalmaz false nem tartalmaz Oldal: 10 / 79

11 2.2. Prjektek paramétereinek lekérdezése A funkció leírása Az erőfrrás célja: Visszaadja az adtt prjekt adatait (mezők és értékei, terminációk). Az erőfrrás URI-je: /v2/prjects/<prjectid> Metódus: GET Példa a funkció használatára Kérés: prjectid = [0-9]+ a paraméterrel megadható, hgy melyik prjekt adatait szeretné lekérni például: esetén a 251-es prjektre vnatkzó infrmációk kerülnek visszaadásra Válasz: "respnse": "fields": [ "fieldid": 1, "name": "name", "type": "text", "indexed": "yes", "custmised": "yes", "label": "name", "fieldid": 2, "name": "phne1", "type": "text", "indexed": "yes", "custmised": "yes", "label": "phne1", "fieldid": 3, "name": "cim", "type": "text", "indexed": "n", "custmised": "", "label": "cim", "fieldid": 22, "name": "szerzdes", "type": "simple", "indexed": "n", "custmised": "n", "label": "Van-e az ügyfélnek szerződése", "values": [ [ Oldal: 11 / 79

12 , ] ], "label": "Igen", "name": "Igen", "valueid": 6, "fieldid": 22, "exprt_value": "Létező szerződés", "descriptin": "", "cmmissin": 10, "price": 100 "label": "Nem", "name": "Nem", "valueid": 7, "fieldid": 22, "exprt_value": "Még nincs szerződés", "descriptin": "Ptenciális jelölt", "cmmissin": 20, "price": 200 "fieldid": 23, "name": "szerztype", "type": "multiple", "indexed": "n", "custmised": "n", "label": "A szerződés típusa", "values": [ [ "label": "Telefn", "name": "Telefn", "valueid": 8, "fieldid": 23, "exprt_value": "T1", "descriptin": "", "cmmissin": 1, "price": 1, "label": "TV", "name": "TV", "valueid": 9, "fieldid": 23, "exprt_value": "T2", "descriptin": "", "cmmissin": 2, "price": 2, "label": "Internet", "name": "Internet", "valueid": 10, "fieldid": 23, "exprt_value": null, "descriptin": "", "cmmissin": 0, "price": 0 ] ] Oldal: 12 / 79

13 ], "dispsitins": [ "name": "Visszahívás", "assesment": "failed", "descriptin": "", "recall": 0, "status": "recall", "price": 0, "cmmissin": 0, "id": 1, "label": "Visszahívás", "mde": "active", "name": "Közös listás visszahívás", "assesment": "failed", "descriptin": "", "recall": 0, "status": "shared_recall", "price": 0, "cmmissin": 0, "id": 2, "label": "Közös listás visszahívás", "mde": "active", "name": "Fglalt", "assesment": "failed", "descriptin": "", "recall": 0, "status": "busy", "price": 0, "cmmissin": 0, "id": 3, "label": "Fglalt", "mde": "active", "name": "Csatrna túllépés miatt megszakítva", "assesment": "failed", "descriptin": "", "recall": 0, "status": "limit_exceeded", "price": 0, "cmmissin": 0, "id": 4, "label": "Csatrna túllépés miatt megszakítva", "mde": "active", "name": "Nem elérhető", "assesment": "failed", "descriptin": "", "recall": 0, "status": "unavailable", "price": 0, "cmmissin": 0, "id": 5, "label": "Nem elérhető", "mde": "active", "name": "Eldbtt", "assesment": "failed", Oldal: 13 / 79

14 ,,,,, "descriptin": "", "recall": 0, "status": "discard", "price": 0, "cmmissin": 0, "id": 6, "label": "Eldbtt", "mde": "active" "name": "Ideiglenesen nem elérhető", "assesment": "failed", "descriptin": "", "recall": 0, "status": "temprary_nt_available", "price": 0, "cmmissin": 0, "id": 7, "label": "Ideiglenesen nem elérhető", "mde": "active" "name": "Hibás szám miatt eldbtt", "assesment": "failed", "descriptin": "", "recall": 0, "status": "discard_failed", "price": 0, "cmmissin": 0, "id": 8, "label": "Hibás szám miatt eldbtt", "mde": "active" "name": "Vesztett", "assesment": "failed", "descriptin": "", "recall": 86400, "status": "drpped", "price": 0, "cmmissin": 0, "id": 9, "label": "Vesztett", "mde": "active" "name": "Kvóta", "assesment": "failed", "descriptin": "", "recall": 0, "status": "quta", "price": 0, "cmmissin": 0, "id": 10, "label": "Kvóta", "mde": "active" "name": "ELŐFIZETÉS", "assesment": "success", "descriptin": "Az ügyfél előfizetés kötött.", "recall": 0, "status": "finished", "price": 10000, "cmmissin": 1000, Oldal: 14 / 79

15 ,,,, ], "errrs": [] "id": 11, "label": "EL01", "mde": "active" "name": "VISSZAHÍVÁS - új adatk", "assesment": "success", "descriptin": "Adategyeztetés miatt visszahívni.", "recall": 0, "status": "recall", "price": 0, "cmmissin": 0, "id": 13, "label": "VISSZAHÍVÁS - új adatk", "mde": "active" "name": "ELUTASÍT", "assesment": "success", "descriptin": "", "recall": 0, "status": "finished", "price": 0, "cmmissin": 0, "id": 14, "label": "ELUTASÍT", "mde": "active" "name": "VISSZAHÍVÁS 1 nap", "assesment": "success", "descriptin": "Egy nap múlva hívjuk vissza", "recall": 86400, "status": "recall", "price": 0, "cmmissin": 0, "id": 15, "label": "CB1", "mde": "active" "name": "nem létező ügyfél", "assesment": "rdered", "descriptin": "", "recall": 0, "status": "finished", "price": 0, "cmmissin": 0, "id": 12, "label": "NAC", "mde": "active" Oldal: 15 / 79

16 A visszatérő adatk értelmezése Típus Magyarázat fields array fieldid int a mező VCC adatbázisban szereplő aznsítója name string a mező ügyfél által megadtt neve type string text szöveges mező simple egy érték kezelésére alkalmas mező multiple több érték kezelésére alkalmas mező indexed string a mező ügyfél által indexelve van-e, vagyis külön kereshető a tartalma a VCC prgram egyes felületein pl. rekrdk yes a mező indexelve van n a mező nincs indexelve custmised string a mező custm típusú-e, amely beállítás a mező értékének perátri híváslistában való megjelenést szabályzza kézi tárcsázás esetén yes ebben az esetben a mező értéke megjelenik az perátri híváslistában n ebben az esetben a mező értéke nem jelenik meg az perátri híváslistában label string a mező ügyfél által beállíttt címkéje values a mezők értékei label string az érték ügyfél által megadtt értéke name string az érték ügyfél által megadtt neve valueid int az érték VCC adatbázisban szereplő aznsítója fieldid int annak a mezőnek a VCC adatbázisban szereplő aznsítója, amelyhez az érték tartzik exprt_value string az érték ügyfél által megadtt exprt értéke descriptin string az ügyfél által az értékhez adtt megjegyzés cmissin int az ügyfél által megadtt perátri jutalék értéke price int az ügyfél által megadtt call center jutalék értéke dispsitins array terminációk name string a termináció ügyfél által megadtt neve assesment String a termináció ügyfél által megadtt értékelése, kivéve rendszer ldali terminációk (id: 1-10) success elért rdered sikeres failed nem elért descriptin string a terminációhz ügyfél által adtt megjegyzés recall int adtt terminációkhz (rendszer és visszahívás / közös listás visszahívás típusú terminációk) ügyfél által megadtt alapértelmezett visszahívási időpnt értéke (mp) status string a termináció ügyfél által megadtt típusa,kivéve rendszer terminációk (id: 1-10) Oldal: 16 / 79

17 recall shared_recall busy limit_exceede d unavailable discard temprary_nt _available discard_faile d drpped quta answering_mac hine machine visszahívás közös listás visszahívás fglalt csatrna túllépés miatt megszakítva nem elérhető eldbtt átmenetileg nem elérhető hibás szám miatt eldbtt vesztett kvóta hangpstára fut egy hívás a tárcsázó felismert egy üzenetrögzítőt vagy IVR-t rbinsn az perátr rbinsn listára terminált egy hívást finished befejezett price int az ügyfél által megadtt perátri jutalék értéke cmissin int az ügyfél által megadtt call center jutalék értéke id int a termináció VCC adatbázisban szereplő aznsítója label string a termináció ügyfél által megadtt exprtértéke mde string a termináció státusza active inactive deleted aktív inaktív törölt Oldal: 17 / 79

18 2.3. Prjekt máslás A funkció leírása Az erőfrrás célja: prjektid alapján az adtt prjekt máslása Az erőfrrás URI-je: /v2/prjects/clne/<prjectid> Metódus: PUT Példa a funkció használatára Kérés: BODY tartalma: "name": "<value>" Típus Köt. Magyarázat name string igen Az új (máslt) prjekt neve A visszatérő adatk értelmezése sikeres váltztatás esetén bdy tartalma: a respnse kulcsn található <prjectid> vagyis a létrehztt prjekt adatbázisban szereplő egyedi aznsítója "respnse": 33, "errrs": [] sikertelen váltztatás esetén a bdy tartalma: errr.required: hiányzó érték a name kulcsn errr.prjectname_already_exists: a megadtt névvel már létezik prjekt az adatbázisban errr.wrng_prjectname_frmat: a megadtt név hibás, vagy nem támgattt karaktereket tartalmaz pl. / \ errr.bad_arguments: a BODY tartalma nem értelmezhető (pl. nem valid JSON) errr.clne_prject_errr: a máslás sikertelen vlt szerver ldali prbléma miatt, és a prjekt nem jött létre Oldal: 18 / 79

19 3. Rekrdk 3.1. Rekrdk listázása A funkció leírása Az erőfrrás célja: Visszaadja az adtt prjektben szereplő rekrdkat. Az erőfrrás URI-je: /v2/prjects/<prjectid>/recrds Metódus: GET Példa a funkció használatára Kérés: 1) start=[0-9]+ az egyenlőségjel után megadtt számmal beflyáslható, hgy hányadik rekrdtól adja vissza a rekrdkat a rendszer például: esetén az adatbázisban szereplő rekrdk közül a harmadikkal kezdődően szereplő rekrdkat fgja visszaadni a rendszer 2) num=[0-9]+ az egyenlőségjel után megadtt számnak megfelelő rekrdt ad vissza a rendszer például: esetén a rendszer az adatbázisban szereplő rekrdk közül az első kettőt fgja visszaadni 3) fieldname=[a-z_]+&value=.+ például: esetén a rendszer azkat a rekrdkat fgja visszaadni az adatbázisból, ahl phne1 mező értéke Fnts, hgy a rendszer csak az indexelt mezők adatait adja vissza! Válasz: "respnse": "rws": [ "id": 1, "name": "Kvács György", "id": 2, "name": "Kiss Álms", "id": 3, "name": "Tóth Aladár" ], "ttalcunt": 3, Oldal: 19 / 79

20 "errrs": [] A visszatérő adatk értelmezése Típus Magyarázat id int a rekrd VCC adatbázisban szereplő aznsítója name string a rekrd ügyfél által megadtt neve ttalcunt int Az összes rekrd darabszáma az adtt prjektben Oldal: 20 / 79

21 3.2. Rekrd adatainak lekérdezése A funkció leírása Az erőfrrás célja: Visszaadja egy rekrd adatait, a hzzá tartzó eseményeket és CDR-ket. Az erőfrrás URI-je: /v2/prjects/<prjectid>/recrds/<numberid> Metódus: GET Példa a funkció használatára Kérés: numberid = [0-9]+ a lekérdezésben a numberid csak szám lehet például esetén a 122-es prjektid-val rendelkező prjektből a 13-as numberid-val (egyedi aznsító) rendelkező rekrd részletes adatait adja vissza a rendszer Válasz: "respnse": "data": "name": "Virtual Call Center", "phne1": " ", "cim": "HU, 1023 Budapest, Csalgány utca 23-33", "szerzdes": [ 6 ], "szerztype": [ 8, 9, 10 ], "events": [ "attempted_cnnectin": 1, "create_date": " :36:40", "descriptin": "predictivedialer", "dispsitinid": 9, "next_calldate": " :36:40", "phne": " ", "shared_call": false, "userid": -1, "attempted_cnnectin": 2, "create_date": " :50:08", "descriptin": "predictivedialer", "dispsitinid": 3, "next_calldate": " :00:00", "phne": " ", "shared_call": false, "userid": -1, "attempted_cnnectin": 3, Oldal: 21 / 79

22 ,,,, ], "cdrs": "rws": [ "create_date": " :07:04", "descriptin": "predictivedialer", "dispsitinid": 3, "next_calldate": " :00:00", "phne": " ", "shared_call": false, "userid": -1 "attempted_cnnectin": 4, "create_date": " :17:34", "descriptin": "predictivedialer", "dispsitinid": 7, "next_calldate": " :00:00", "phne": " ", "shared_call": false, "userid": -1 "client_search": "n", "cmmissin": 0, "cmp": "frm": "00:00", "perid": "0", "t": "00:00", "create_date": " :46:33", "descriptin": "", "dispsitinid": 1, "next_calldate": " :45:52", "phne": " ", "price": 0, "state": "AFTERWORK", "userid": 11, "uuid": "ea2ab432-77e0-11e1-865d-65b56d88788b" "client_search": "n", "cmmissin": 0, "cmp": "frm": "00:00", "perid": "0", "t": "00:00", "create_date": " :32:28", "descriptin": "", "dispsitinid": 1, "next_calldate": " :26:09", "phne": " ", "price": 0, "state": "AFTERWORK", "userid": 11, "uuid": "4624e e1-a703-2ff36baa95dd" "create_date": " :49:49", "dispsitinid": 11, "descriptin": "megköti a szerződést", "userid": 11, "price": 0, "cmmissin": 0 Oldal: 22 / 79

23 ,,, "uuid": "4624e e1-a703-2ff36baa95dd", "surce": " ", "destinatin": " ", "userid": 11, "numberid": 2, "start_ts": " :26:18", "billing_ts": " :26:19", "ringtime": 10, "billingtime": 5, "talktime": 4, "queuetime": 1, "befrequeuetime": 0, "dispsitinid": 1, "dispsitinreach": 1, "dispsitinstatus": 1, "prjectid": 251 "uuid": "ea2ab432-77e0-11e1-865d-65b56d88788b", "surce": " ", "destinatin": " ", "userid": 11, "numberid": 2, "start_ts": " :46:15", "billing_ts": " :46:15", "ringtime": 7, "billingtime": 3, "talktime": 3, "queuetime": 0, "befrequeuetime": 0, "dispsitinid": 1, "dispsitinreach": 1, "dispsitinstatus": 1, "prjectid": 251 "uuid": "d6b11e e1-acaf-8f c15", "surce": " ", "destinatin": " ", "userid": -1, "numberid": 2, "start_ts": " :17:34", "billing_ts": " :17:34", "ringtime": 0, "billingtime": 0, "talktime": 0, "queuetime": 0, "befrequeuetime": 0, "dispsitinid": 7, "dispsitinreach": 1, "dispsitinstatus": 13, "prjectid": 251 "uuid": "b9b e1-a332-f9ecdf8a5141", "surce": " ", "destinatin": " ", "userid": -1, "numberid": 2, "start_ts": " :06:58", "billing_ts": " :07:04", "ringtime": 6, "billingtime": 0, "talktime": 0, Oldal: 23 / 79

24 , "errrs": [],, ], "ttalcunt": 1 "queuetime": 0, "befrequeuetime": 0, "dispsitinid": 3, "dispsitinreach": 1, "dispsitinstatus": 3, "prjectid": 251 "uuid": "f6ea748a-150e-11e f557157f9f0", "surce": " ", "destinatin": " ", "userid": -1, "numberid": 2, "start_ts": " :36:21", "billing_ts": " :36:39", "ringtime": 18, "billingtime": 1, "talktime": 0, "queuetime": 1, "befrequeuetime": 0, "dispsitinid": 9, "dispsitinreach": 1, "dispsitinstatus": 10, "prjectid": 251 "uuid": "dbe2c692-1b94-11e1-9b62-f9ecdf8a5141", "surce": " ", "destinatin": " ", "userid": -1, "numberid": 2, "start_ts": " :49:55", "billing_ts": " :50:07", "ringtime": 12, "billingtime": 0, "talktime": 0, "queuetime": 0, "befrequeuetime": 0, "dispsitinid": 3, "dispsitinreach": 1, "dispsitinstatus": 3, "prjectid": 251 Oldal: 24 / 79

25 A visszatérő adatk értelmezése Típus Magyarázat data bject a data kulcs alatt a rekrd minden adata visszaadásra kerül, amely az adatbázisban szerepel. Amennyiben egy vagy többértékes mezők (simple,multiple) is szerepelnek a válaszban, akkr az értékek nem szövegesen, hanem a valueid-val kerülnek visszaadásra. A példában: a "szerzdes" nevű mezőnél a "6"-s valueid (Igen) van kiválasztva a rekrdnál, míg a "szerztype" mezőnél a "8", "9", "10"-es valueidk (Telefn, TV, Internet events array az events kulcs alatt a rekrdhz beállíttt terminációk kerülnek felsrlásra, amely perátr, supervisr vagy rendszer (predictive, adatbázis frissítés) általi termináció is lehet attempted_cnne int ctin a tárcsázó általi próbálkzás száma (supervisr által a Call Center / Prjekt / <adtt prjekt> / Mezők / <telefnszám mező> alatt beflyáslható a mennyiség, hgy hányszr próbálkzzn a tárcsázó elérni egy rekrdt create_date string a termináció beállításának időpntja éééé-hh-nn óó-pp-mp frmátumban descriptin string Az perátr által adtt megjegyzés updateim Adatbázis frissítés prt predicti Tárcsázó vedialer dispsitinid int a tárcsázó által beállíttt termináció adatbázisban szerepelő IDja next_calldate string a rekrd legközelebbi felhívásának időpntja éééé-hh-nn óó-ppmp frmátumban phne string a rekrdhz tartzó telefnszámk közül az, amelyiken hívta és hívni fgja a rendszer shared_call blean a hívás terminációja közös listás visszahívás típusú vlt-e true közös listás false nem közös listás típus userid int az perátr adatbázisban szereplő ID-ja -1 rendszer állíttta be a terminációt -2 adatbázis frissítés állíttta be a terminációt client_search string az perátr kikereste-e a rekrdt yes perátr által kikeresett rekrd n nem perátr által kikeresett rekrd cmissin int a terminációhz beállíttt perátri jutalék értéke price int a terminációhz beállíttt call center jutalék értéke state string azn perátri státusz neve, amely állaptban az perátr vlt a termináció beállításakr pl. AFTERWORK esetén az perátr utómunka állaptban rögzítette a terminációt uuid string amennyiben történt hívás a termináció beállításakr, akkr a hívás rendszer által adtt egyedi aznsítója cmp bject amennyiben az perátr intervallums közös listás visszahívás típusú terminációt állíttt be, akkr mikr hívja a rendszer frm string mikrtól hívja a rendszer óó-pp-mp frmátumban pl. 11:00:00 órától fgja hívni a rendszer perid string milyen időközönként pl. 25 esetén 25 percenként fgja hívni a rendszer t string meddig hívja a rendszer óó-pp-mp frmátumban pl. 18:00:00 óráig fgja hívni a rendszer recycled_as_new blean újként frgatta-e vissza a supervisr a Rekrdk listája alatt true újként lett visszafrgatva cdrs bject kulcs alatt a rekrdhz tartzó CDR infrmációk adatai kerülnek elküldésre. Amennyiben vlt lyan termináció, amelyhez nem tartztt hívás például supervisri beállítás, akkr ehhez nem Oldal: 25 / 79

26 rws lesznek CDR infrmációk array uuid string a hívás rendszer által adtt egyedi aznsítója surce string a hívó fél telefnszáma destinatin string a hívtt fél telefnszáma userid int a terminációt beállító felhasználó egyedi aznsítója (-1 predictive / pwer tárcsázó esetén az értéke) numberid int a rekrd adatbázisban szereplő egyedi aznsítója start_ts string a hívás indításának időpntja éééé-hh-nn óó-pp-mp frmátumban billing_ts string a hívás számlázása elkezdésének időpntja éééé-hh-nn óó-ppmp frmátumban ringtime int a hívás kicsörgési ideje (mp) billingtime int a hívás számláztt ideje (mp) talktime int a hívás srán a beszélgetés ideje (mp) queuetime int amennyiben a hívás várakzási srba került, akkr a várakzási srban töltött ideje (mp) befrequeuetime int a hívás várakzási sr előtt töltött ideje (pl. IVR-ban töltött idő) (mp) dispsitinid int a híváshz beállíttt termináció adatbázisban szereplő egyedi aznsítója dispsitinreac int a beállíttt termináció értékelése h 1 nem elért 2 elért dispsitinstat us 3 sikeres int a beállíttt termináció típusa 1 visszahívás 2 közös listás visszahívás 3 fglalt 4 nem elérhető 5 befejezett 8 eldbtt 9 hibás szám miatt eldbtt 10 vesztett 11 kvóta 12 csatrna túllépés miatt megszakítva 13 átmenetileg nem elérhető prjectid int annak a prjektnek az adatbázisban szereplő egyedi aznsítója, ahl a hívás történt Oldal: 26 / 79

27 3.3. Rekrd adatainak módsítása A funkció leírása Az erőfrrás célja: Módsítja a megadtt rekrd meghatárztt mezőihez tartzó adatait, és pcinálisan a next_cntact mező értékét is. Az erőfrrás URI-je: /v2/prjects/<prjectid>/recrds/<numberid> Metódus: PUT Példa a funkció használatára Kérés: 1) next_cntact=phne[1-9] a next_cntact a rekrdhz tartzó telefnszámk közül megjelöli azt, amelyiken a rendszernek fel kell hívnia legközelebb. Mivel a VCC rendszerbe összesen 9 telefnszám tölthető fel, így a next_cntact értéke 1-9 között lehet, ahl az 1 a phne1-nek felel meg, a 9 a phne9-nek. BODY tartalma: "<field.ea>":"<value>","<field.ea>":"<value>" Az EA a mező egyedi aznsítója, amelyet a supervisr ad meg a mező létrehzása srán. Ezek közül csak a név és a telefnszámk egyedi aznsítója kötött (name, phne1, phne2...phne9), a többi szabadn adható meg a rendszerbe belefglalt kötöttségeknek megfelelően (csak angl abc kisbetűk és aláhúzás, nem kezdődhet számmal) Például, ha az ügyfél elsődleges telefnszámát szeretné módsítani, akkr a BODY a következőképpen néz ki: "phne1":" " Típus Köt. Magyarázat next_cntact string nem a rekrdhz tartzó telefnszámk közül megjelöli azt, amelyiken a rendszernek fel kell hívnia legközelebb Példa: curl -d \"phne1\":\" \" -X PUT Oldal: 27 / 79

28 A visszatérő adatk értelmezése Sikeres váltztatása esetén a bdy tartalma "errrs": [], "respnse": true sikertelen váltztatás esetén a bdy frmátumára példa: "errrs": [ "errrcde": 400, "errrmessage": "400 Bad request", "index": 0 ], "respnse": false Oldal: 28 / 79

29 3.4. Rekrd beszúrása A funkció leírása Az erőfrrás célja: A meghatárztt prjektbe egy új rekrdt szúr be a meghatárztt adatkkal. Az erőfrrás URI-je: /v2/prjects/<prjectid>/recrds Metódus: POST Példa a funkció használatára Kérés: BODY tartalma egy rekrd beszúrása esetén: "phne_field": "phne4", "frm": "name": "Kvács Áks", "phne1": " ", "phne4": " ", "szerzdes": [ "valueid": 6 ], "szerztype": [ "valueid": 8, "valueid": 9 ], "premium": "price": "100", "cmmissin": "50", "dispsitin": "dispsitinid": "1", "userid": "81", "next_calldate": " :26:55" BODY tartalma több rekrd egyidejű beszúrása esetén: [ [ "phne_field": "phne4", "frm": "name": "Kvács Áks", "phne1": " ", "phne4": " ", "szerzdes": [ "valueid": 6 Oldal: 29 / 79

30 ] ], ], "szerztype": [ "valueid": 8, "valueid": 9 ], "premium": "price": "100", "cmmissin": "50", "dispsitin": "dispsitinid": "1", "userid": "81", "next_calldate": " :26:55" "frm": "name": "Kvács Áks1", "phne1": " ", "phne4": " ", "dispsitin": "dispsitinid": "1", "userid": "81", "next_calldate": " :26:55" Típus Köt. Magyarázat phne_field string nem a telefnszámk közül melyik legyen a visszahívási telefnszám pl: "phne_field": "<phne2>" esetén, amennyiben a prjekt adatbázisában van phne2 mező, akkr a rekrdnál a phne2 mezőben szereplő telefnszám lesz a visszahívási telefnszám premium bject a premium kulcsn két adat kerülhet elküldésre price string nem a rekrdhz kapcslódó call center jutalék értéke cmissin string nem a rekrdhz kapcslódó perátri jutalék értéke frm bject igen kulcsn küldhetőek el a rekrd adatai, mint például a neve, telefnszáma (kötelező) címe stb. Amennyiben egy lyan mezőhöz kíván értéket beállítani, ahl egy vagy több érték közül kell választani, akkr a beállítani kívánt érték ID-ját kell megadnia (ennek lekérdezése:2.4-es pnt) A phne[1-9] kulcsn elküldött érték tartalmazza az ügyfél telefnszámait,amelynek támgattt frmátuma <rszághívó> <körzetszám> <telefnszám>, kizárólag flyamatsan számkkal leírt frmátumban például: Nem támgattt a + előjel vagy a 00-ás prefix a telefnszám előtti használata például vagy , tvábbá bármilyen különleges karakter pl. / jel szóköz, alulvnás stb. használata a telefnszámban. Oldal: 30 / 79

31 dispsitin bject nem kulcsn terminációt is állíthat az adtt rekrdhz dispsitinid string igen a beállítani kívánt termináció adatbázisban szereplő egyedi aznsítója (ennek lekérdezése 2.4-es pnt) userid string igen a beállítani kívánt termináció mely felhasználóhz kapcslódjn, és ennek a felhasználónak az adatbázisban szereplő egyedi aznsítója (ennek lekérdezése:2.18-as pnt) next_calldate string nem amennyiben visszahívás vagy közös listás visszahívás típusú terminációt kíván beállítani, akkr megadható, hgy annak időpntja mikr legyen éééé-hh-nn óó:pp:mp frmátumban Példa: curl -vvv -X POST -d "\"phne_field\": \"phne1\", \"premium\": \"cmmissin\": \"50\", \"price\": \"100\", \"dispsitin\": \"premium\": \"cmmissin\": \"50\", \"price\": \"100\", \"next_calldate\": \" :26:55\", \"dispsitinid\": \"1\", \"userid\": \"3\", \"frm\": \"szerzdes\": [\"valueid\": 6], \"phne1\": \" \", \"szerztype\": [\"valueid\": 8, \"valueid\": 9], \"name\": \"test\", \"phne4\": \"361\"" A visszatérő adatk értelmezése sikeres váltztatás esetén bdy tartalma: a respnse után található szögletes zárójelben a <numberdid> vagyis a beszúrt rekrd adatbázisban szereplő egyedi aznsítója, tömeges beszúrás esetén pedig a beszúrt rekrdk egyedi aznsítói "errrs": [], "respnse": [6] Oldal: 31 / 79

32 "respnse": [ 63, 64, 65 ], "errrs": [] sikertelen váltztatás esetén a bdy tartalma: errr.bad_arguments: nem megfelelő vagy hiányzó adatk "respnse": false, "errrs": [ "errrcde": 417, "errrmessage": "errr.bad_arguments", "index": 0 ] Oldal: 32 / 79

33 3.5. Termináció beszúrása egy adtt rekrdhz A funkció leírása Az erőfrrás célja: A prjekt egy meghatárztt rekrdjáhz beállít egy új terminációt a paramétereknek megfelelően. Az erőfrrás URI-je: /v2/prjects/<prjectid>/recrds/<numberid>/dispsitins Metódus: POST Példa a funkció használatára Kérés: BODY tartalma: "dispsitinid": "<id>", "userid": "<id>", "next_calldate": "yyyy-mm-dd hh:mm:ss" "next_cntactid": <id> Típus Kötele Magyarázat ző dispsitinid string igen a beállítani kívánt termináció adatbázisban szereplő egyedi aznsítója (ennek lekérdezése 2.4-es pnt) userid string igen a beállítani kívánt termináció mely felhasználóhz kapcslódjn, és ennek a felhasználónak az adatbázisban szereplő egyedi aznsítója (ennek lekérdezése 2.18-as pnt) next_calldate string nem amennyiben visszahívás vagy közös listás visszahívás típusú terminációt kíván beállítani, akkr megadható, hgy annak időpntja mikr legyen éééé-hh-nn óó:pp:mp frmátumban next_cntactid int nem megadható, hgy a rendszer melyik telefnszámn hívja fel az ügyfelet. A telefnszámkat a phne1-phne9 mezők tartalmazzák. Amennyiben azt szeretné, hgy a rendszer a phne1 mezőben lévő telefnszámn hívja az ügyfelet, akkr next_cntactid:1 frmulát kell használnia. Ha nem küld ezen a kulcsn adatt, vagy nem létező phne mezőt ír be pl. 99, akkr a rendszer a prjektben található legkisebb id-nak megfelelő értéket állítja be (elsősrban phne1). Példa: curl -vvv -X POST -d "\"next_calldate\": \" :26:55\", \"dispsitinid\": \"2\", \"userid\": \"3\"" A visszatérő adatk értelmezése sikeres váltztatás esetén bdy tartalma: "errrs": [], "respnse": true Oldal: 33 / 79

34 sikertelen váltztatás esetén a bdy tartalma: a termináció beszúrása sikertelen vlt pl. nem létező prjekt esetén "errrcde": 417, "index": 0, "errrmessage": "errr.add_dispsitin_was_unsuccessful" Oldal: 34 / 79

35 3.6. Tömeges rekrd módsítás A funkció leírása Az erőfrráscélja: A prjekt meghatárztt rekrdjainak meghatárztt tulajdnságait módsítja egyidejűleg. Az erőfrrás URI-je: /v2/prjects/<prjectid>/recrds Metódus: PUT Példa a funkció használatára Kérés: BODY tartalma: "elements": [ "frm": "name": "Kvács Aladár", "search": "name": "Aladár", "frm": "name": "Sándr","cim": "Misklc", "numberid": "4" ], "default": "cim": "Budapest","kr": "30" Típus Kötelező Magyarázat elements array igen Ez a tömb tartalmazza a módsítani kívánt rekrdk aznsításáhz szükséges paramétereket és a váltztatni kívánt adatkat. frm bject igen A módsítani kívánt mezők adatait tartalmazza. search bject igen A rekrd adatbázisban való aznsítási paramétereit tartalmazza. Vagy ezt vagy a numberid-t kötelező megadni. numberid string igen A rekrd adatbázisban szereplő egyedi aznsítója. Vagy ezt vagy a search paramétert kötelező megadni. default bject nem Ezen kulcs értékei minden esetben beállításra kerülnek kivéve, ahl külön definiálva lett az érték. A rendszer az elements-en belül végigmegy az egyes srkn és végrehajtja a rekrdk módsítását a feltételeknek megfelelően. Minden egyes element egy új keresési és módsítási feltételnek felel meg, ezáltal akár átfedések is lehetnek. A default kulcsn lévő adatk minden esetben beállításra kerülnek, ahl külön nincs azknak megfelelő érték definiálva. Oldal: 35 / 79

36 A példa alapján a következő történik: 1. minden lyan rekrdk, ahl a name mező értéke "Aladár" tt ez az érték felülíródik "Kvács Aladár"-ra. Emellett ezeknél a rekrdknál a cim és a kr is beállításra kerül (default kulcs). 2. a 4-es numberid-val rendelkező rekrdnál a name érték felülíródik "Sándr"-ra a cim pedig "Misklc"-ra. Mivel a default kulcsn szereplő cim itt külön definiálva vlt, ezért ezt a a default kulcs értéke nem írja felül, de a kr mező értéke visznt beállításra kerül. Példa: curl -vvv -X PUT -d \"elements\":[\"frm\":\"name\":\"test\",\"search\":\"name\":\"tibi\",\"fr m\":\"name\":\"test tibi\",\"frm\":\"name\":\"tibi\",\"cim\":\"bela\",\"numberid\":\"4\"],\"defa ult\":\"cim\":\"value1\",\"kr\":\"value2\" A visszatérő adatk értelmezése sikeres váltztatás esetén a bdy tartalma: "errrs": [], "respnse": "0": true, "1": true részleges sikeresség esetén a bdy tartalma: errr.missing_numberid_r_search: hiányzik a keresés (search) vagy a numberid paraméter (ezek közül az egyiknek szerepelnie kell kérésben) "errrs": [ "errrcde": 417, "errrmessage": "errr.missing_numberid_r_search", "index": 1 ], "respnse": "0": true, "2": true sikertelenség esetén a bdy tartalma: "errrs": [ "errrcde": 417, "errrmessage": "errr.missing_numberid_r_search", "index": 0 Oldal: 36 / 79

37 , "errrcde": 417, "errrmessage": "errr.missing_numberid_r_search", "index": 1 ], "respnse": false Oldal: 37 / 79

38 3.7. Tömeges termináció módsítás A funkció leírása Az erőfrrás célja: A prjekt meghatárztt rekrdjainak aktuális terminációját felhasználóját és visszahívási időpntját módsítja a paramétereknek megfelelően. Az erőfrrás URI-je: /v2/prjects/<prjectid>/recrds/dispsitins Metódus: PUT Példa a funkció használatára Kérés: BODY tartalma: "elements": [ "numberid": "1", "dispsitinid": "1", "userid": "22", "next_calldate": " :00:00", "search": "name": "Kvács" ], "dispsitin": "dispsitinid": 2, "userid": 7, "next_calldate": " :00:00" Típus Köt. Magyarázat elements array igen Ez a tömb tartalmazza a módsítani kívánt rekrdk aznsításáhz szükséges paramétereket és a váltztatni kívánt adatkat. userid string nem A terminációhz beállítható felhasználó egyedi aznsítója. next_cal ldate string nem A visszahívási időpnt beállítására szlgáló paraméter, melynek frmátuma éééé-hh-nn óó:pp:mp search bject igen A rekrd adatbázisban való aznsítási paramétereit tartalmazza. A search-ben szereplő kulcs a következők valamelyike lehet: numberid: a rekrd egyedi aznsítója prjektben található indexelt mező egyedi aznsítója pl. name pref_userid: rekrdhz tartzó perátr aznsítója (userid (2.18)), közös listás visszahívás esetén az értéke: 0) act_status: rekrdhz tartzó aktuális termináció aznsítója (dispsitinid (2.4)) Amennyiben több search bjektum is meg van adva, akkr VAGY kapcslattal történik a keresés. Ha pedig egy search bjektumn belül több kulcs (keresési feltétel) is szerepel, tt ÉS kapcslattal történik a keresés. numberid string igen A rekrd adatbázisban szereplő egyedi aznsítója. Vagy ezt Oldal: 38 / 79

39 vagy a search paramétert kötelező megadni. dispsitin bject nem Ezen kulcs értékei minden esetben beállításra kerülnek kivéve, ahl külön definiálva lett az érték. userid string nem A terminációhz beállítható felhasználó egyedi aznsítója. next_cal ldate string nem A visszahívási időpnt beállítására szlgáló paraméter, melynek frmátuma éééé-hh-nn óó:pp:mp search bject igen A rekrd adatbázisban való aznsítási paramétereit tartalmazza. Vagy ezt vagy a numberid-t kötelező megadni. numberid string igen A rekrd adatbázisban szereplő egyedi aznsítója. Vagy ezt vagy a search paramétert kötelező megadni. A rendszer az elements-en belül végigmegy az egyes srkn és végrehajtja a rekrdk terminációival kapcslats módsításkat a feltételeknek megfelelően. Minden egyes element egy új keresési és módsítási feltételnek felel meg, ezáltal akár átfedések is lehetnek. A dispsitin kulcsn lévő adatk minden esetben beállításra kerülnek, ahl külön nincs azknak megfelelő érték definiálva. A példa alapján a következő történik: 1. Az 1-s numberid-val rendelkező rekrdnál beállításra kerül az 1-es aznsítóval rendelkező termináció (visszahívás), :00:00-ás visszahívási időpnttal a 22-es aznsítóval rendelkező perátrhz. 2. A rendszer kikeresi az adtt prjekt adatbázisából az összes lyan rekrdt, ahl a name mező értéke "Kvács" és beállítja hzzájuk a 2-es aznsítóval rendelkező terminációt (közös listás visszahívás) :00:00-ás visszahívási időpnttal és ezeket a 7-es aznsítóval rendelkező perátrhz rendeli. Példa: curl -vvv -X PUT -d \"elements\":[\"numberid\":\"1\",\"dispsitinid\":\"1\",\"userid\":\"22\",\"next_calldate\": \" :00:00\",\"search\":\"name\":\"Kvács\"],\"dispsitin\":\"dispsitinid\":2,\"useri d\":7,\"next_calldate\":\" :00:00\" A Visszatérő adatk értelmezése sikeres váltztatás esetén a bdy tartalma: "errrs": [], "respnse": "0": true, "1": true részleges sikeresség esetén a bdy tartalma: errr.missing_numberid_r_search: hiányzik a keresés (search) vagy a numberid paraméter (ezek közül az egyiknek szerepelnie kell kérésben) "errrs": [ "errrcde": 417, Oldal: 39 / 79

40 "errrmessage": "errr.missing_numberid_r_search", "index": 1 ], "respnse": "0": true, "2": true sikertelenség esetén a bdy tartalma: "errrs": [ "errrcde": 417, "errrmessage": "errr.missing_numberid_r_search", "index": 0, "errrcde": 417, "errrmessage": "errr.missing_numberid_r_search", "index": 1 ], "respnse": false Oldal: 40 / 79

41 4. Kvótázás 4.1. Kvóták lekérdezése A funkció leírása Az erőfrrás célja: Visszaadja a prjekten belül beállíttt kvótalimiteket, a jelenlegi értékeket és hátramaradt értékeket. Az erőfrrás URI-je: /v2/prjects/<prjectid>/qutas Metódus: GET Példa a funkció használatára Kérés: Válasz: "respnse": "cell": [ "valueid": 1, "label": "value_name": "Budapest", "exprt_value": null, "cntainer": true, "children": [ "valueid": 4, "label": "value_name": "férfi", "exprt_value": null, "value": 500, "act_value": 324, "diff_value": 176, "all": null, "cntainer": false, "children": null, "qutaid": 4, "valueid": 5, "label": "value_name": "nő", "exprt_value": null, "value": 500, "act_value": 198, "diff_value": 302, "all": null, "cntainer": false, "children": null, "qutaid": 5 ], "valueid": 2, Oldal: 41 / 79

42 "label": "value_name": "Eger", "exprt_value": null, "cntainer": true, "children": [ "valueid": 4, "label": "value_name": "férfi", "exprt_value": null, "value": 250, "act_value": 84, "diff_value": 166, "all": null, "cntainer": false, "children": null, "qutaid": 6, "valueid": 5, "label": "value_name": "nő", "exprt_value": null, "value": 250, "act_value": 96, "diff_value": 154, "all": null, "cntainer": false, "children": null, "qutaid": 7 ] ], "edge": [ "prjectid": "441", "fieldid": 7, "cntainer": true, "label": "name": "iskla", "children": [ "qutaid": 1, "valueid": 6, "label": "name": "általáns", "value": 100, "act_value": 75, "diff_value": 25, "cntainer": false, "children": null, "qutaid": 2, "valueid": 7, "label": "name": "közép", "value": 100, "act_value": 24, Oldal: 42 / 79

43 ] ], "errrs": [], "diff_value": 76, "cntainer": false, "children": null "qutaid": 3, "valueid": 8, "label": "name": "felső", "value": 50, "act_value": 39, "diff_value": 11, "cntainer": false, "children": null A visszatérő adatk értelmezése Típus Magyarázat cell array a kulcsn a supervisr által cella kvótatípusként megjelölt mezők értékei kerülnek visszaadásra a kvótának megfelelő mátrixs bntásban valueid int az adtt mező értékének VCC adatbázisban szereplő ID-ja (ennek lekérdezése 2.4-es pnt) label bject az adtt érték értékre vnatkzó infrmációk value_n string az érték supervisr által megadtt neve ame exprt_ value string az érték supervisr által megadtt exprt értéke. Az érték null, ha nincs megadva exprtérték. cntainer blean az adtt elem tartalmaz-e tvábbi elemeket true tvábbi elemeket tartalmaz false nem tartalmaz tvábbi elemeket children array amennyiben az adtt elem tartalmaz tvábbi elemeket (cntainer = true), akkr ezen kulcs alatt lesznek felsrlva valueid int az adtt mező értékének VCC adatbázisban szereplő ID-ja (ennek lekérdezése 2.4-es pnt) label az adtt érték értékre vnatkzó infrmációk value_name string az érték supervisr által megadtt neve exprt_value string az érték supervisr által megadtt exprt értéke value int az értékhez supervisr által beállíttt kvótalimit act_value int az értékhez tartzó jelenleg elért kvóták száma diff_value int a hiányzó kvóták száma, amit még el kell érni a value teljesítéséig Oldal: 43 / 79

44 qutaid int az adtt érték VCC adatbázisban szereplő kvóta ID-ja edge array a kulcsn a supervisr által perem kvótatípusként megjelölt mezők értékei kerülnek visszaadásra prjectid string az adtt prjekt VCC adatbázisban szereplő aznsítója fieldid int a peremkvótás mező VCC adatbázisban szereplő aznsítója (ennek lekérdezése 2.4- es pnt) cntainer blean az adtt elem tartalmaz-e tvábbi elemeket true tvábbi elemeket tartalmaz false nem tartalmaz tvábbi elemeket label bject a peremkvótás mezőre vnatkzó adatk name string a mező supervisr által megadtt neve children array amennyiben az adtt elem tartalmaz tvábbi elemeket (cntainer = true), akkr ezen kulcs alatt lesznek felsrlva qutaid int az adtt érték VCC adatbázisban szereplő kvóta ID-ja valueid int : az adtt mező értékének VCC adatbázisban szereplő ID-ja (ennek lekérdezése 2.4-es pnt) label bject az adtt érték értékre vnatkzó infrmációk name string az adtt érték supervisr által megadtt neve value int az értékhez supervisr által beállíttt kvótalimit act_value int az értékhez tartzó jelenleg elért kvóták száma diff_value int a hiányzó kvóták száma, amit még el kell érni a value teljesítéséig Oldal: 44 / 79

45 4.2. Kvóták módsítása A funkció leírása Az erőfrrás célja: Módsítja az adtt prjektben beállíttt kvótalimiteket a paramétereknek megfelelően. Az erőfrrás URI-je: /v2/prjects/<prjectid>/qutas Metódus: POST Példa a funkció használatára Kérés: BODY tartalma: [ ], "qutaid": 2, "value": 15 "qutaid": 4, "value": 20 Típus Köt. Magyarázat qutaid int igen a módsítani kívánt kvótaérték ID-ja (ennek lekérdezése 2.12-es pnt) value int igen az a kvótalimit (szám), amire módsítani szeretné a jelenlegi kvótalimitet A visszatérő adatk értelmezése sikeres váltztatás esetén bdy tartalma: "errrs": [], "respnse": "0": true, "1": true részleges sikeresség és sikertelenség esetén a bdy tartalma: "errrs": [ "errrcde": 417, "index": 1, "errrmessage": "errr.missing_arguments", "errrcde": 417, "index": 3, "errrmessage": "errr.missing_arguments" Oldal: 45 / 79